build: migrate to pnpm; update deps

.eslintrc.yml

@@ -20,9 +20,9 @@ rules:
     - 1
     - allowWithDecorator: true
       allowStaticOnly: true
-  '@typescript-eslint/no-parameter-properties':
+  '@typescript-eslint/parameter-properties':
     - 1
-    - allows: [protected readonly, private readonly, public readonly, readonly]
+    - allow: [protected readonly, private readonly, public readonly, readonly]
   '@typescript-eslint/no-throw-literal': [2]
   'no-unused-vars': [0]
   '@typescript-eslint/no-unused-vars':
@@ -33,9 +33,5 @@ rules:
   '@typescript-eslint/prefer-function-type': [1]
   '@typescript-eslint/prefer-nullish-coalescing': [1]
   '@typescript-eslint/prefer-optional-chain': [1]
-  '@typescript-eslint/ban-types':
-    - 1
-    - types:
-        object: false
   no-void: [1, { allowAsStatement: true }]
   eqeqeq: [1, smart]

.github/workflows/checkin.yml

@@ -8,25 +8,19 @@ jobs:
   checkin:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [16.x]
-
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
       - name: install
-        run: yarn install --frozen-lockfile
+        uses: NullVoxPopuli/action-setup-pnpm@v2
+        with:
+          node-version: 20
+          pnpm-version: 8
       - name: build
-        run: yarn build
+        run: pnpm build
       - name: test
-        run: yarn test
+        run: pnpm test
       - name: release
-        run: yarn release
+        run: pnpm release
       - name: 'check for uncommitted changes'
         # Ensure no changes
         run: |

.gitignore

@@ -1 +1,23 @@
-node_modules
+# dependencies
+/node_modules/
+
+# IDEs and editors
+/.idea
+.project
+*.log
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# System Files
+.DS_Store
+Thumbs.db

.vscode/settings.json

@@ -7,7 +7,7 @@
   "editor.tabSize": 4,
   "editor.formatOnSave": false,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "[typescript]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"

README.md

@@ -67,15 +67,15 @@ with:
 ### Prepare development environment
 
 ```bash
-yarn install
+pnpm install
 ```
 
 ### Draft a new release
 
 ```bash
-yarn release
+pnpm release
 git add .
-yarn version
+pnpm version [new-version]
 
 # for a minor version or patch of v1
 git tag --delete v1

package.json

@@ -10,37 +10,37 @@
   "scripts": {
     "watch": "tsc --watch",
     "build": "ncc build src/index.ts",
-    "rebuild": "yarn clean && yarn build",
+    "rebuild": "pnpm clean && pnpm build",
     "clean": "rimraf dist",
     "lint": "eslint --fix src/**/*.ts",
     "format": "prettier --write .",
     "test": "jest",
-    "release": "yarn clean && yarn format && yarn lint && yarn build"
+    "release": "pnpm clean && pnpm format && pnpm lint && pnpm build"
   },
   "dependencies": {
-    "@actions/cache": "^3.0.6",
+    "@actions/cache": "^3.2.3",
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1",
-    "@actions/io": "^1.1.2",
+    "@actions/io": "^1.1.3",
     "@actions/tool-cache": "^2.0.1",
-    "semver": "^7.3.5"
+    "semver": "^7.5.4"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
+    "@types/jest": "^29.5.11",
-    "@types/node": "^16.3.2",
+    "@types/node": "^20.11.10",
-    "@types/semver": "^7.3.7",
+    "@types/semver": "^7.5.6",
-    "@typescript-eslint/eslint-plugin": "^4.28.3",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^4.28.3",
+    "@typescript-eslint/parser": "^6.19.1",
-    "@vercel/ncc": "^0.34.0",
+    "@vercel/ncc": "^0.38.1",
-    "eslint": "^7.30.0",
+    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-prettier": "^5.1.3",
-    "jest": "^27.0.6",
+    "jest": "^29.7.0",
-    "prettier": "^2.3.2",
+    "prettier": "^3.2.4",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.5",
-    "ts-jest": "^27.0.3",
+    "ts-jest": "^29.1.2",
-    "type-fest": "^1.2.2",
+    "type-fest": "^4.10.1",
-    "typescript": "^4.3.5"
+    "typescript": "^5.3.3"
   },
   "contributors": [
     "Yu Zhu"

src/index.ts

@@ -21,4 +21,4 @@ async function run(): Promise<void> {
     }
 }
 
-run().catch((e) => core.error(e));
+run().catch((e: Error) => core.error(e));

tsconfig.json

@@ -7,6 +7,6 @@
     "module": "commonjs",
     "target": "es2018",
     "outDir": "dist",
-    "types": ["node", "jest"]
+    "types": ["node", "jest"],
-  }
+  },
 }