chore: add formatter and github workflow for format check

- Added prettier and updated eslint config
- Formatted all files and resolved conflicts
- Added format check github workflow on push and PR

refs: #243

Author: yinanazhou

.eslintrc.json

@@ -1,56 +1,64 @@
 {
-    "root": true,
-    "env": {
-        "es2021": true
-    },
-    "ignorePatterns": ["src/public/**/*"],
-    // "extends": "eslint:recommended",
-    "parser": "@babel/eslint-parser",
-    "parserOptions": {
-        "sourceType": "module",
-        "ecmaVersion": 12,
-        "ecmaFeatures": {
-            "impliedStrict": true
-        }
-    },
-    // (first parameter of a rule) 0: off, 1: warning, 2: error
-    "rules": {
-        "indent": [2, 2, { "SwitchCase": 1 }],
-        "linebreak-style": [2, "unix"],
-        "quotes": [2, "single", { "allowTemplateLiterals": true }],
-        "semi": [2, "never"],
-
-        "array-bracket-spacing": [2, "never"],
-        "arrow-spacing": 2,
-        "brace-style": [2, "1tbs", { "allowSingleLine": true }],
-        "block-spacing": 2,
-        "comma-spacing": 2,
-        "computed-property-spacing": [2, "never"],
-        "func-call-spacing": 2,
-        "keyword-spacing": 2,
-        "key-spacing": [2, { "mode": "minimum" }],
-        "object-curly-spacing": [2, "always"],
-        "no-irregular-whitespace": 2,
-        "no-multi-spaces": [2, {
-            "exceptions": {
-                "ImportDeclaration": true
-            }
-        }],
-        "no-multiple-empty-lines": [2, { "max": 1 }],
-        "no-spaced-func": 2,
-        "rest-spread-spacing": [2, "never"],
-        "semi-spacing": [2, {"before": false, "after": true}],
-        "space-before-blocks": 2,
-        "space-before-function-paren": [0, { "asyncArrow": "always" }],
-        "space-in-parens": 2,
-        "space-infix-ops": 2,
-        "space-unary-ops": 2,
-        "spaced-comment": [2, "always", {
-            "block": {
-                "balanced": true
-            }
-        }],
-        "template-curly-spacing": [2, "never"],
-        "template-tag-spacing": [2, "always"]
+  "root": true,
+  "env": {
+    "es2021": true
+  },
+  "ignorePatterns": ["src/public/**/*"],
+  // "extends": "eslint:recommended",
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 12,
+    "ecmaFeatures": {
+      "impliedStrict": true
     }
+  },
+  "plugins": ["prettier"],
+  // (first parameter of a rule) 0: off, 1: warning, 2: error
+  "rules": {
+    "indent": [2, 2, { "SwitchCase": 1 }],
+    "linebreak-style": [2, "unix"],
+    "quotes": [2, "single", { "allowTemplateLiterals": true }],
+    "semi": [2, "always"],
+
+    "array-bracket-spacing": [2, "never"],
+    "arrow-spacing": 2,
+    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
+    "block-spacing": 2,
+    "comma-spacing": 2,
+    "computed-property-spacing": [2, "never"],
+    "func-call-spacing": 2,
+    "keyword-spacing": 2,
+    "key-spacing": [2, { "mode": "minimum" }],
+    "object-curly-spacing": [2, "always"],
+    "no-irregular-whitespace": 2,
+    "no-multi-spaces": [
+      2,
+      {
+        "exceptions": {
+          "ImportDeclaration": true
+        }
+      }
+    ],
+    "no-multiple-empty-lines": [2, { "max": 1 }],
+    "no-spaced-func": 2,
+    "rest-spread-spacing": [2, "never"],
+    "semi-spacing": [2, { "before": false, "after": true }],
+    "space-before-blocks": 2,
+    "space-before-function-paren": [0, { "asyncArrow": "always" }],
+    "space-in-parens": 2,
+    "space-infix-ops": 2,
+    "space-unary-ops": 2,
+    "spaced-comment": [
+      2,
+      "always",
+      {
+        "block": {
+          "balanced": true
+        }
+      }
+    ],
+    "template-curly-spacing": [2, "never"],
+    "template-tag-spacing": [2, "always"]
+  }
 }

.github/workflows/format-check.yml

@@ -0,0 +1,22 @@
+name: Format Check
+
+on: [push, pull_request]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Prettier format check
+        run: npm run format:check

.prettierrc

@@ -0,0 +1,8 @@
+{
+    "semi": true,
+    "tabWidth": 2,
+    "printWidth": 100,
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "bracketSpacing": true
+}