feat:Add pre-commit check (#684)

feat: pre-commit ESLint

Author: yingyangxu2026

.github/CODEOWNERS

@@ -1 +1 @@
-* @LeoHChen @DonFungible @jacob-tucker @allenchuang @limengformal @lucas2brh @yingyangxu2026 @chao-peng-story @roycezhaoca
+* @LeoHChen @DonFungible @jacob-tucker @allenchuang @limengformal @lucas2brh @yingyangxu2026 @bonnie57

.github/workflows/pr-internal.yml

@@ -4,24 +4,9 @@ on:
   pull_request:
     branches:
       - main
-    paths-ignore:
-      - '.github/**'
-      - '.github/CODEOWNERS'
-      - '**/*.md'
-      - 'docs/**'
-      - '.gitignore'
-      - 'LICENSE'
-      
   push:
     branches:
       - main
-    paths-ignore:
-      - '.github/**'
-      - '.github/CODEOWNERS'
-      - '**/*.md'
-      - 'docs/**'
-      - '.gitignore'
-      - 'LICENSE' 
 
 jobs:
   Timestamp:
@@ -34,4 +19,6 @@ jobs:
     with:
       sha: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
       ENVIRONMENT: "odyssey"
-    secrets: inherit
+    secrets:
+      WALLET_PRIVATE_KEY: ${{ secrets.WALLET_PRIVATE_KEY }}
+      TEST_WALLET_ADDRESS: ${{ secrets.TEST_WALLET_ADDRESS }}

.gitignore

@@ -5,6 +5,7 @@
 node_modules
 .pnp
 .pnp.js
+.pnpm-store
 
 # testing
 coverage

.husky/pre-commit

@@ -0,0 +1 @@
+pnpm exec lint-staged

.pre-commit-config.yaml

@@ -4,3 +4,10 @@ repos:
     hooks:
       - id: gitleaks
         args: ['--verbose', '--redact']
+  - repo: local
+    hooks:
+      - id: lint-staged
+        name: lint-staged (ESLint)
+        entry: pnpm run lint-staged
+        language: system
+        pass_filenames: false

CONTRIBUTING.md

@@ -21,6 +21,7 @@ This section provides the instructions on how to build Story Protocol SDK from s
 - Install PNPM: Execute `npm install -g pnpm`
 - Install TypeScript: Run `pnpm add typescript -D`
 - Install Yalc: Use `npm install -g yalc`
+- Install dependencies: `pnpm install` (this automatically sets up Husky git hooks for ESLint checks on commit)
 
 #### Steps for Using Yalc for Local Testing of Core-SDK
 

docs/v1.4.4-release.md

@@ -8,14 +8,22 @@
   "scripts": {
     "build": "turbo run build",
     "lint": "turbo run lint",
+    "lint-staged": "node scripts/precommit-run-eslint.mjs",
     "fix": "turbo run fix",
     "test": "turbo run test --no-cache --concurrency=1",
-    "test:integration": "turbo run test:integration --no-cache"
+    "test:integration": "turbo run test:integration --no-cache",
+    "prepare": "husky"
   },
   "devDependencies": {
     "@changesets/cli": "2.29.6",
+    "eslint": "^9.26.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.2.1",
     "turbo": "^1.10.13"
   },
+  "lint-staged": {
+    "packages/core-sdk/**/*.{ts,tsx,js,jsx,mjs,cjs}": "node scripts/precommit-eslint-core-sdk.mjs"
+  },
   "engines": {
     "node": "^20.0.0"
   },

package.json

@@ -50,8 +50,6 @@
     "@types/mocha": "^10.0.2",
     "@types/node": "^20.8.2",
     "@types/sinon": "^10.0.18",
-    "@zerodev/ecdsa-validator": "^5.4.9",
-    "@zerodev/sdk": "^5.5.7",
     "c8": "^8.0.1",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",