Merge pull request #93 from amitsingh-007/next

.github/workflows/pre-merge.yml

@@ -19,9 +19,9 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8
+          version: 9
 
       - name: Setting up Node.js
         uses: actions/setup-node@v4

.github/workflows/verify-build.yml

@@ -17,9 +17,9 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8
+          version: 9
 
       - name: Setting up Node.js
         uses: actions/setup-node@v4

.husky/pre-commit

@@ -0,0 +1,3 @@
+pnpm dist
+# Commit updated dist
+git add dist/\*

contributing.md

@@ -0,0 +1,18 @@
+# Contributing
+
+## Running on local machine
+
+- Fork this repository.
+- This project uses pnpm instead of npm so make sure you have latest version of pnpm installed.
+- Run `pnpm install` in the root folder.
+- For local development:
+  - Run `pnpm build` to only build the dist folder.
+  - Run `pnpm lint` to lint all files.
+  - Run `pnpm test` to run all tests.
+  - Run `pnpm dist` before committing any changes to the repository.
+
+## Guidelines for development
+
+- Install [prettier]("https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode") and enable for this workplace, with default settings.
+- Follow `pascalCase` for this project.
+- Attach comments to complex logic, if required.

package.json

@@ -10,25 +10,27 @@
     "clean": "rimraf dist/",
     "dist": "pnpm lint && pnpm test && pnpm build",
     "lint": "eslint .",
-    "test": "vitest run"
+    "test": "vitest run",
+    "prepare": "husky"
   },
   "dependencies": {
     "@actions/core": "1.10.1",
     "@actions/github": "6.0.0",
-    "rimraf": "5.0.5"
+    "rimraf": "5.0.7"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
     "@vercel/ncc": "0.38.1",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "17.1.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-prettier": "5.1.3",
-    "prettier": "3.2.4",
-    "typescript": "5.3.3",
-    "vitest": "1.2.2"
+    "husky": "9.0.11",
+    "prettier": "3.2.5",
+    "typescript": "5.4.5",
+    "vitest": "1.6.0"
   }
 }