📄 Yarn project boilerplate

Features

• Yarn (berry) with PnP
• TypeScript
• ESLint
• Prettier
• Commitlint with Husky
• Visual Studio Code / Vim ready
• CI configurations
  • Dependabot
  • GitHub Actions
  • ReviewPad

System Requirements

• Node.js Hydrogen LTS (^18.19.0)

Install the dependencies

corepack enable
yarn install

Linting

yarn run lint
yarn run lint:fix # Lint and auto-fix

Testing

yarn run test

Currently, the command works as an alias for the yarn run lint command.

Cleaning

yarn run clean

Migrate to NPM

1. Remove the following files

• .gitattributes
• .yarn/
• .yarnrc.yml
• yarn.lock

2. Apply the following patches

--- a/.github/workflows/push.yml
+++ b/.github/workflows/push.yml
@@ -21,19 +21,17 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Enable the corepack because of the Yarn berry
-        run: corepack enable
       - name: Post-prepare the Node.js version ${{ matrix.node-version }} environment
         uses: actions/setup-node@v4
         with:
-          cache: ${{ !env.ACT && 'yarn' || '' }}
+          cache: ${{ !env.ACT && 'npm' || '' }}
           node-version: ${{ matrix.node-version }}
       - env:
           HUSKY: 0
         name: Install the dependencies
-        run: yarn install --inline-builds
+        run: npm ci
       - name: Run the tests
-        run: yarn run test
+        run: npm test
     strategy:
       matrix:
         node-version:

--- a/.husky/commit-msg
+++ b/.husky/commit-msg
@@ -4,4 +4,4 @@

 . "$(dirname "$0")/_/husky.sh"

-yarn exec commitlint --edit "${1}"
+npm x --no -- commitlint --edit "${1}"

--- a/.husky/pre-commit
+++ b/.husky/pre-commit
@@ -4,4 +4,4 @@

 . "$(dirname "$0")/_/husky.sh"

-yarn exec lint-staged
+npm x --no -- lint-staged

--- a/.vim/coc-settings.json
+++ b/.vim/coc-settings.json
@@ -1,6 +1,4 @@
 {
-  "eslint.nodePath": ".yarn/sdks",
-  "eslint.packageManager": "yarn",
-  "tsserver.tsdk": ".yarn/sdks/typescript/lib",
+  "tsserver.tsdk": "node_modules/typescript/lib",
   "workspace.workspaceFolderCheckCwd": false
 }

--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,5 +1,4 @@
 {
-  "eslint.nodePath": ".yarn/sdks",
   "files.readonlyInclude": {
     "**/.pnp.*": true,
     "**/.yarn/**/*": true,
@@ -13,13 +12,11 @@
    "**/node_modules/**/*": true
  },
  "git.branchProtection": ["main"],
-  "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
   "search.exclude": {
     "**/.pnp.*": true,
     "**/.yarn": true,
     "**/node_modules/**/*": true
   },
   "typescript.enablePromptUseWorkspaceTsdk": true,
-  "typescript.tsdk": ".yarn/sdks/typescript/lib",
   "yaml.schemas": {
     "https://raw.githubusercontent.com/reviewpad/schemas/main/latest/schema.json": [
       "reviewpad.yml"

--- a/package.json
+++ b/package.json
@@ -18,15 +18,15 @@
     "clean": "rimraf -g .eslintcache \"*.tgz\" \"*.tsbuildinfo\" \"node_modules/.cache/**/*\"",
     "commit": "aicommits -t conventional",
-    "postinstall": "husky install",
-    "lint": "conc -m 1 \"yarn:lint:*:check\"",
+    "lint": "conc -m 1 \"npm:lint:*:check\"",
     "lint:cspell:check": "cspell lint --no-progress --show-suggestions -u \"./**/*\"",
     "lint:eslint:check": "eslint --cache --cache-strategy=content -f codeframe \"./**/*\"",
-    "lint:eslint:fix": "yarn run lint:eslint:check --fix",
-    "lint:fix": "conc -m 1 \"yarn:lint:*:fix\"",
-    "lint:prettier:check": "yarn run prettier -cu",
-    "lint:prettier:fix": "yarn run prettier -uw",
-    "prettier": "prettier --cache --log-level=warn \"$@\" \"./**/*\"",
-    "test": "yarn run lint"
+    "lint:eslint:fix": "npm run lint:eslint:check -- --fix",
+    "lint:fix": "conc -m 1 \"npm:lint:*:fix\"",
+    "lint:prettier:check": "npm run prettier -- -cu",
+    "lint:prettier:fix": "npm run prettier -- -uw",
+    "prepare": "husky install",
+    "prettier": "prettier --cache --log-level=warn \"./**/*\"",
+    "test": "npm run lint"
   },
   "prettier": "@kurone-kito/prettier-config",
   "devDependencies": {
@@ -42,7 +42,6 @@
     "@kurone-kito/typescript-config": "^0.8.4",
     "@typescript-eslint/eslint-plugin": "^6.13.2",
     "@typescript-eslint/parser": "^6.13.2",
-    "@yarnpkg/sdks": "^3.1.0",
     "aicommits": "^1.11.0",
     "concurrently": "^8.2.2",
     "cspell": "^8.1.2",
@@ -67,7 +66,6 @@
     "typescript": "~5.3.2",
     "typescript-eslint-language-service": "^5.0.5"
   },
-  "packageManager": "yarn@4.0.2",
   "engines": {
     "node": ">=18.19"
   },

3. Run the following command

npm install
git add -A
git commit -m "feat: migrate to NPM from Yarn"

Rules for Development

Introduce commit message validation at commit time. The “Conventional Commits” rule is applied to discourage committing messages that violate conventions.

LICENSE

MIT