Setup git hooks and init CI pipeline (#1)

* ci: setup git hooks

* chore: lint issues

* chore: add env example

* ci: init pipeline

* fix(ci): rename job to match operation

* chore(ci): add explicit frozen lockfile

* chore: remove explicit cache and use setup-node action version

* chore: remove unused condition

.env.example

@@ -0,0 +1,10 @@
+# Twitch API
+PLASMO_PUBLIC_TWITCH_CLIENT_ID=
+PLASMO_PUBLIC_TWITCH_API_URL=https://api.twitch.tv/helix
+
+# Rust Consumer API
+PLASMO_PUBLIC_API_URL=
+
+# App Environment
+PLASMO_PUBLIC_ENVIRONMENT=development
+PLASMO_PUBLIC_STAGE=local

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Check lint
+        run: pnpm run check:ci

.gitignore

@@ -27,6 +27,7 @@ yarn-error.log*
 
 # local env files
 .env*
+!.env.example
 
 out/
 build/

.npmrc

@@ -0,0 +1,5 @@
+# Ensures exact versions are installed and saved in package.json
+save-exact=true
+
+# Disables caching of side effects to avoid issues with post-install scripts
+side-effects-cache=false

biome.jsonc

@@ -4,7 +4,8 @@
     "enabled": true
   },
   "files": {
-    "ignore": [".plasmo", "node_modules", "build"]
+    "ignore": [".plasmo", "node_modules", "build"],
+    "ignoreUnknown": true
   },
   "linter": {
     "enabled": true,
@@ -22,5 +23,10 @@
       "enabled": true
       // Add here things that aren't default
     }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
   }
 }

lefthook.yml

@@ -0,0 +1,17 @@
+# yaml-language-server: $schema=https://json.schemastore.org/lefthook.json
+
+# Refer for explanation to following link:
+# https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+
+assert_lefthook_installed: true
+
+pre-commit:
+  parallel: false
+  commands:
+    lint:
+      run: pnpx @biomejs/biome check --no-errors-on-unmatched --files-ignore-unknown=true -- {staged_files}
+pre-push:
+  parallel: false
+  commands:
+    lint:
+      run: pnpx @biomejs/biome check --no-errors-on-unmatched --files-ignore-unknown=true -- {push_files}

package.json

@@ -14,7 +14,8 @@
     "dev:chrome": "plasmo dev --target=chrome-mv3",
     "package": "plasmo package",
     "check": "biome check",
-    "check:fix": "biome check --write"
+    "check:fix": "biome check --write",
+    "check:ci": "biome ci ."
   },
   "dependencies": {
     "@plasmohq/messaging": "^0.6.2",
@@ -44,12 +45,12 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
-    "@ianvs/prettier-plugin-sort-imports": "4.1.1",
     "@types/chrome": "0.0.258",
     "@types/node": "20.11.5",
     "@types/react": "18.2.48",
     "@types/react-dom": "18.2.18",
     "@types/webextension-polyfill": "^0.10.7",
+    "lefthook": "1.7.12",
     "postcss": "8.4.33",
     "rimraf": "6.0.1",
     "typescript": "5.3.3",