Add eslint and prettier

Author: kungfux

.editorconfig

@@ -0,0 +1,7 @@
+[*]
+charset = utf-8
+insert_final_newline = true
+end_of_line = lf
+indent_style = space
+indent_size = 2
+max_line_length = 80

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+package-lock.json

.eslintrc.json

@@ -0,0 +1,29 @@
+{
+  "overrides": [
+    {
+      "env": {
+        "browser": true,
+        "es2021": true
+      },
+      "files": ["*.ts"],
+      "extends": ["@eslint-recommended/eslint-config-typescript", "prettier"],
+      "parserOptions": {
+        "project": "tsconfig.json",
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+      }
+    },
+    {
+      "env": {
+        "node": true,
+        "es2021": true
+      },
+      "files": ["*.js"],
+      "extends": ["eslint:recommended", "prettier"],
+      "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+      }
+    }
+  ]
+}

.github/workflows/build.yml

@@ -7,7 +7,25 @@ on:
     branches: ['master', 'dev']
 
 jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+
+      - name: Check code format and issues
+        run: |
+          npm install
+          npm run check
+
   build:
+    needs: check
+
     runs-on: ubuntu-latest
 
     strategy:
@@ -17,7 +35,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Setup Node.js LTS
+      - name: Use Node.js
         uses: actions/setup-node@v3
         with:
           node-version: lts/*

.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+package-lock.json

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "endOfLine": "lf"
+}

.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"],
+  "unwantedRecommendations": []
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "files.insertFinalNewline": true,
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package.json

@@ -10,6 +10,12 @@
     "watch:chrome": "npm run watch -- --env BROWSER=chrome",
     "watch:firefox": "npm run watch -- --env BROWSER=firefox",
     "watch": "webpack --watch --config webpack.dev.js",
+    "check:prettier": "npx prettier --check .",
+    "check:eslint": "npx eslint .",
+    "check": "npm run check:prettier & npm run check:eslint",
+    "fix:prettier": "npx prettier --write .",
+    "fix:eslint": "npx eslint --fix",
+    "fix": "npm run fix:prettier & npm run fix:eslint",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -23,11 +29,19 @@
   },
   "homepage": "https://github.com/kungfux/jira-automation-extension#readme",
   "devDependencies": {
+    "@eslint-recommended/eslint-config-typescript": "^17.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.0",
     "copy-webpack-plugin": "^11.0.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-promise": "^6.1.1",
     "merge-jsons-webpack-plugin": "^2.0.1",
+    "prettier": "^2.8.7",
     "ts-loader": "^9.4.2",
     "typescript": "^5.0.4",
-    "webpack": "^5.78.0",
+    "webpack": "^5.79.0",
     "webpack-cli": "^5.0.1",
     "webpack-merge": "^5.8.0"
   }

src/index.ts

@@ -0,0 +1,9 @@
+class Test {
+  main(): void {
+    console.log('OK');
+    console.log('OK');
+    console.dir({ foo: 'bar' });
+  }
+}
+
+new Test().main();