Add pre-commit hooks

Author: satya164

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/setup
 
       - name: Lint markdown
-        run: yarn markdownlint-cli2
+        run: yarn lint
 
       - name: Run Typecheck
         run: yarn typecheck

lefthook.yml

@@ -0,0 +1,21 @@
+pre-commit:
+  jobs:
+    - name: format
+      run: yarn prettier --write --ignore-unknown {staged_files}
+      stage_fixed: true
+
+    - name: checks
+      group:
+        parallel: true
+        jobs:
+          - name: lint
+            run: yarn lint --no-globs {staged_files}
+            glob: '*.md'
+
+          - name: typecheck
+            run: yarn typecheck
+            glob: '*.{cjs,js,json,jsx,mjs,ts,tsx}'
+
+          - name: test
+            run: yarn test
+            glob: '*.{cjs,js,json,jsx,mjs,ts,tsx}'

package.json

@@ -8,6 +8,8 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "swizzle": "docusaurus swizzle",
+    "lint": "markdownlint-cli2",
+    "format": "prettier --write .",
     "typecheck": "tsc",
     "deploy": "DEPLOYMENT_BRANCH=gh-pages docusaurus deploy",
     "test": "node --test --test-reporter=@voxpelli/node-test-pretty-reporter",
@@ -44,6 +46,7 @@
     "@types/react": "^19.2.8",
     "@types/react-dom": "^19.2.3",
     "@voxpelli/node-test-pretty-reporter": "^1.1.2",
+    "lefthook": "^2.1.10",
     "markdownlint": "^0.40.0",
     "markdownlint-cli2": "^0.19.1",
     "postcss": "^8.5.15",

src/__tests__/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

src/plugins/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

yarn.lock

@@ -8840,6 +8840,117 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lefthook-darwin-arm64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-darwin-arm64@npm:2.1.10"
+  conditions: os=darwin & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-darwin-x64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-darwin-x64@npm:2.1.10"
+  conditions: os=darwin & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-freebsd-arm64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-freebsd-arm64@npm:2.1.10"
+  conditions: os=freebsd & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-freebsd-x64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-freebsd-x64@npm:2.1.10"
+  conditions: os=freebsd & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-linux-arm64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-linux-arm64@npm:2.1.10"
+  conditions: os=linux & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-linux-x64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-linux-x64@npm:2.1.10"
+  conditions: os=linux & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-openbsd-arm64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-openbsd-arm64@npm:2.1.10"
+  conditions: os=openbsd & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-openbsd-x64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-openbsd-x64@npm:2.1.10"
+  conditions: os=openbsd & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-windows-arm64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-windows-arm64@npm:2.1.10"
+  conditions: os=win32 & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-windows-x64@npm:2.1.10":
+  version: 2.1.10
+  resolution: "lefthook-windows-x64@npm:2.1.10"
+  conditions: os=win32 & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook@npm:^2.1.10":
+  version: 2.1.10
+  resolution: "lefthook@npm:2.1.10"
+  dependencies:
+    lefthook-darwin-arm64: "npm:2.1.10"
+    lefthook-darwin-x64: "npm:2.1.10"
+    lefthook-freebsd-arm64: "npm:2.1.10"
+    lefthook-freebsd-x64: "npm:2.1.10"
+    lefthook-linux-arm64: "npm:2.1.10"
+    lefthook-linux-x64: "npm:2.1.10"
+    lefthook-openbsd-arm64: "npm:2.1.10"
+    lefthook-openbsd-x64: "npm:2.1.10"
+    lefthook-windows-arm64: "npm:2.1.10"
+    lefthook-windows-x64: "npm:2.1.10"
+  dependenciesMeta:
+    lefthook-darwin-arm64:
+      optional: true
+    lefthook-darwin-x64:
+      optional: true
+    lefthook-freebsd-arm64:
+      optional: true
+    lefthook-freebsd-x64:
+      optional: true
+    lefthook-linux-arm64:
+      optional: true
+    lefthook-linux-x64:
+      optional: true
+    lefthook-openbsd-arm64:
+      optional: true
+    lefthook-openbsd-x64:
+      optional: true
+    lefthook-windows-arm64:
+      optional: true
+    lefthook-windows-x64:
+      optional: true
+  bin:
+    lefthook: bin/index.js
+  checksum: be812e1517a967977750a41f15a2070cea63e1774137737426f636e1bd379f4dfc73482fa7f07df6b9a1413ee50c6e2d790936d7986bdcafd46255d871c17b76
+  languageName: node
+  linkType: hard
+
 "leven@npm:^3.1.0":
   version: 3.1.0
   resolution: "leven@npm:3.1.0"
@@ -12154,6 +12265,7 @@ __metadata:
     "@voxpelli/node-test-pretty-reporter": "npm:^1.1.2"
     dedent: "npm:^1.7.0"
     escape-html: "npm:^1.0.3"
+    lefthook: "npm:^2.1.10"
     markdownlint: "npm:^0.40.0"
     markdownlint-cli2: "npm:^0.19.1"
     mkdirp: "npm:^3.0.1"