[Style] Add GitHub action for linter and pre-commit hook formater (#412)

### Overview Currently this repo doesn't have a formatter setup. Besides, even though we have ESLint rule set up, these rules are not currently enforced in this repo. This PR adds the following to ensure better code quality: - Add `prettier` for code auto formatting - Run prettier format on every commit using pre-commit hook using `husky` - Add GitHub actions for automatically checks ESLint and Prettier on PRs and pushes All other changes are just auto formatting and can be safely ignored. ### Testing Pre-commit hooks: ``` git commit -m "[Style] Add GitHub action for linter and pre-commit hook formater" ✔ Preparing lint-staged... ✔ Running tasks for staged files... ✔ Applying modifications from tasks... ✔ Cleaning up temporary files... ```
mlc-ai · May 22, 2024 · d7fe670 · d7fe670
1 parent fe89f36
commit d7fe670
Show file tree

Hide file tree

Showing 24 changed files with 2,094 additions and 1,468 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -3,4 +3,5 @@ debug
 lib
 build
 node_modules
+3rdparty
 .eslintrc.cjs
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,9 +1,10 @@
 module.exports = {
-    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
     parser: '@typescript-eslint/parser',
     plugins: ['@typescript-eslint'],
     root: true,
     rules: {
-        "@typescript-eslint/no-explicit-any": "off"
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-empty-function": "off"
     }
 };
diff --git a/.github/workflows/linter.yaml b/.github/workflows/linter.yaml
@@ -0,0 +1,27 @@
+name: Linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run lint
+        run: npm run lint
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1 @@
+npx lint-staged
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,6 @@
+{
+  "./**/*.{js,ts,jsx,tsx,json,html,css,md}": [
+    "eslint --fix",
+    "prettier --write"
+  ]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+dist
+debug
+lib
+build
+node_modules
+3rdparty
+.eslintrc.cjs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,8 +7,10 @@
   "type": "module",
   "scripts": {
     "build": "rollup -c && ./cleanup-index-js.sh",
-    "lint": "npx eslint .",
-    "test": "yarn jest"
+    "lint": "npx eslint ./src/ && npx prettier ./src --check",
+    "test": "yarn jest",
+    "format": "prettier --write \"./src/\"",
+    "prepare": "husky"
   },
   "files": [
     "lib"
@@ -36,7 +38,11 @@
     "@webgpu/types": "^0.1.24",
     "buffer": "^5.7.1",
     "eslint": "^8.41.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "husky": "^9.0.11",
     "jest": "^29.7.0",
+    "prettier": "3.2.5",
     "process": "^0.11.10",
     "rollup": "^2.56.2",
     "rollup-plugin-ignore": "^1.0.10",

diff --git a/src/cache_util.ts b/src/cache_util.ts
@@ -1,21 +1,20 @@
 import * as tvmjs from "tvmjs";
-import {
-  AppConfig,
-  ModelRecord,
-  prebuiltAppConfig,
-} from "./config";
+import { AppConfig, ModelRecord, prebuiltAppConfig } from "./config";
 
 function findModelRecord(modelId: string, appConfig?: AppConfig): ModelRecord {
   const matchedItem = appConfig?.model_list.find(
-    item => item.model_id == modelId
+    (item) => item.model_id == modelId,
   );
   if (matchedItem !== undefined) {
     return matchedItem;
   }
   throw Error("Cannot find model_url for " + modelId);
 }
 
-export async function hasModelInCache(modelId: string, appConfig?: AppConfig): Promise<boolean> {
+export async function hasModelInCache(
+  modelId: string,
+  appConfig?: AppConfig,
+): Promise<boolean> {
   if (appConfig === undefined) {
     appConfig = prebuiltAppConfig;
   }
@@ -25,7 +24,10 @@ export async function hasModelInCache(modelId: string, appConfig?: AppConfig): P
   return tvmjs.hasNDArrayInCache(modelUrl, "webllm/model", cacheType);
 }
 
-export async function deleteModelAllInfoInCache(modelId: string, appConfig?: AppConfig) {
+export async function deleteModelAllInfoInCache(
+  modelId: string,
+  appConfig?: AppConfig,
+) {
   // function to delete model all information in cache
   if (appConfig === undefined) {
     appConfig = prebuiltAppConfig;
@@ -34,30 +36,43 @@ export async function deleteModelAllInfoInCache(modelId: string, appConfig?: App
   await deleteModelInCache(modelId, appConfig);
   // delete wasm in cache
   await deleteModelWasmInCache(modelId, appConfig);
-  // delete chat config 
+  // delete chat config
   await deleteChatConfigInCache(modelId, appConfig);
 }
 
-
-export async function deleteModelInCache(modelId: string, appConfig?: AppConfig) {
+export async function deleteModelInCache(
+  modelId: string,
+  appConfig?: AppConfig,
+) {
   // delete the model NDArray In Cache
   if (appConfig === undefined) {
     appConfig = prebuiltAppConfig;
   }
   const modelRecord = findModelRecord(modelId, appConfig);
   let modelCache: tvmjs.ArtifactCacheTemplate;
   if (appConfig.useIndexedDBCache) {
-    tvmjs.deleteNDArrayCache(modelRecord.model_url, "webllm/model", "indexeddb");
+    tvmjs.deleteNDArrayCache(
+      modelRecord.model_url,
+      "webllm/model",
+      "indexeddb",
+    );
     modelCache = new tvmjs.ArtifactIndexedDBCache("webllm/model");
   } else {
     tvmjs.deleteNDArrayCache(modelRecord.model_url, "webllm/model", "cache");
     modelCache = new tvmjs.ArtifactCache("webllm/model");
   }
-  await modelCache.deleteInCache(new URL("tokenizer.model", modelRecord.model_url).href);
-  await modelCache.deleteInCache(new URL("tokenizer.json", modelRecord.model_url).href);
+  await modelCache.deleteInCache(
+    new URL("tokenizer.model", modelRecord.model_url).href,
+  );
+  await modelCache.deleteInCache(
+    new URL("tokenizer.json", modelRecord.model_url).href,
+  );
 }
 
-export async function deleteChatConfigInCache(modelId: string, appConfig?: AppConfig) {
+export async function deleteChatConfigInCache(
+  modelId: string,
+  appConfig?: AppConfig,
+) {
   // delete the chat configuration in Cache
   if (appConfig === undefined) {
     appConfig = prebuiltAppConfig;
@@ -73,7 +88,10 @@ export async function deleteChatConfigInCache(modelId: string, appConfig?: AppCo
   await configCache.deleteInCache(configUrl);
 }
 
-export async function deleteModelWasmInCache(modelId: string, appConfig?: AppConfig) {
+export async function deleteModelWasmInCache(
+  modelId: string,
+  appConfig?: AppConfig,
+) {
   // delete the wasm in Cache
   if (appConfig === undefined) {
     appConfig = prebuiltAppConfig;
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,4 +3,5 @@ debug @@
     lib
     build
     node_modules
+rdparty
     .eslintrc.cjs