Use yarn

Author: cknitt

.github/workflows/pull-request.yml

@@ -8,8 +8,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: ".node-version"
-          cache: npm
-      - run: npm ci
-      - run: npm run res:build -- --warn-error +3+8+11+12+26+27+31+32+33+34+35+39+44+45+110
-      - run: npm test
-      - run: npm run ci:format
+          cache: yarn
+      - run: yarn
+      - run: yarn res:build --warn-error +3+8+11+12+26+27+31+32+33+34+35+39+44+45+110
+      - run: yarn test
+      - run: yarn ci:format

.gitignore

@@ -42,4 +42,12 @@ build
 mdx-manifest.json
 
 app/**/*.mjs
-!_shims.mjs
+!_shims.mjs
+
+# Yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

patches/react-router-mdx+1.0.8.patch renamed to .yarn/patches/react-router-mdx-npm-1.0.8-d4402c3003.patch

@@ -1,7 +1,7 @@
-diff --git a/node_modules/react-router-mdx/dist/server/index.js b/node_modules/react-router-mdx/dist/server/index.js
+diff --git a/dist/server/index.js b/dist/server/index.js
 index 1e56a6c..b323b05 100644
---- a/node_modules/react-router-mdx/dist/server/index.js
-+++ b/node_modules/react-router-mdx/dist/server/index.js
+--- a/dist/server/index.js
++++ b/dist/server/index.js
 @@ -59,15 +59,15 @@ import matter from "gray-matter";
  import { compile as compileMdx } from "@mdx-js/mdx";
  import remarkFrontmatter from "remark-frontmatter";

.yarn/releases/yarn-4.12.0.cjs

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.12.0.cjs

.yarnrc.yml

@@ -84,6 +84,6 @@ Most of the stuff we want to build can be built as components with Tailwind clas
 
 - Clone the project and follow the [README](README.md) instructions
 - Always run the page locally and verify your changes (especially when working on code examples)
-- When writing markdown with code examples, always run `npm test` to prevent broken code
+- When writing markdown with code examples, always run `yarn test` to prevent broken code
 - Feel free to open `Draft PRs` when you are working on bigger features (good for visibility and asking for feedback)
 - Improve code based on last feedback until the code is ready to be merged

CONTRIBUTING.md

@@ -1,18 +1,18 @@
 SHELL = /bin/bash
 
 node_modules/.bin/rescript:
-	npm install
-	npm run update-index
+	yarn install
+	yarn update-index
 
 build: node_modules/.bin/rescript	
 	node_modules/.bin/rescript
-	npm run update-index
+	yarn update-index
 
 dev: build
-	npm run dev
+	yarn dev
 
 test: build
-	npm run test
+	yarn test
 
 clean:
 	rm -r node_modules lib

Makefile

@@ -14,31 +14,30 @@ This is the official documentation platform for the [ReScript](https://rescript-
 
 ## System Requirements
 
-- `node@20` or higher
-- `npm@10` or higher
+- `node@22` or higher
 
 ## Setup
 
 ```sh
 # For first time clone / build (install dependencies)
-npm i
+yarn
 
 # Initial build
-npx rescript
+yarn rescript
 
 # Build the index data. Only needed for initial clone (or content H2 changes)
-npm run update-index
+yarn run update-index
 
 # In a new tab
-npm run dev
+yarn run dev
 
 open localhost:3000
 ```
 
 In case you want to run ReScript in watchmode:
 
 ```sh
-npx rescript -w
+yarn rescript -w
 ```
 
 ## Build Index Data
@@ -48,7 +47,7 @@ search terms we need for searching inside the `Belt` docs). You can create your
 index by running following command:
 
 ```sh
-npm run update-index
+yarn run update-index
 ```
 
 All the index data is stored in `index_data`, but will not be tracked by git.
@@ -120,7 +119,7 @@ node scripts/test-hrefs.mjs "pages/docs/manual/**/*.mdx"
 
 ### Continous Integration
 
-Always make sure to run `npm test` before pushing any content, otherwise our CI
+Always make sure to run `yarn test` before pushing any content, otherwise our CI
 might trigger a failure warning. Failing branches are very unlikely to be merged.
 
 ## Design / UX