Merge pull request #1 from kungfux/feature/project_skeleton

kungfux · web-flow · commit f8b18e2ae6de · 2023-04-19T11:41:22.000+04:00
Add project structure and configuration
diff --git a/.editorconfig b/.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
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,3 @@
+node_modules/
+dist/
+package-lock.json
diff --git a/.eslintrc.json b/.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"
+      }
+    }
+  ]
+}
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.png filter=lfs diff=lfs merge=lfs -text
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,55 @@
+name: Build extension
+
+on:
+  push:
+    branches: ['master', 'dev']
+  pull_request:
+    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:
+      matrix:
+        browser: ['chrome', 'firefox']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+
+      - name: Build
+        run: |
+          npm install
+          npm run build:${{matrix.browser}}
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: jira-automation-extension
+          path: |
+            dist/
+            !dist/**/*.zip
+          if-no-files-found: error
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+dist/
+package-lock.json
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,3 @@
+node_modules/
+dist/
+package-lock.json
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "endOfLine": "lf"
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,4 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"],
+  "unwantedRecommendations": []
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,8 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "files.insertFinalNewline": true,
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
+# Introduction
+
+`JIRA Automation` is a browser extension to add extra features to JIRA.
+
+# Features
+
+- TBD
+
+# Install
+
+Add an extension to your favorite browser by visiting extensions store
+
+TBD
+
+# Build and test locally
+
+- Install [Node.js](https://nodejs.org/) (LTS version)
+- Run following commands from project's root directory to build extension
+
+```bash
+$ npm install # Restore project dependencies
+$ npm run build:chrome # Build extension for Chrome
+$ npm run build:firefox # Build extension for Firefox
+```
+
+- Run following commands to debug extension
+
+```bash
+$ npm run watch:chrome
+$ npm run watch:firefox
+```
+
+- Follow these articles to load unpacked extension from `dist` folder into your browser
+  - [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing)
+  - [Chrome](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/#load-unpacked)
+
+# License information
+
+- Check out [LICENSE](LICENSE) for the license details
+- Icons by [Flatart](https://www.freepik.com/author/flatart)
diff --git a/package.json b/package.json
@@ -0,0 +1,48 @@
+{
+  "name": "jira-automation-extension",
+  "version": "1.0.0",
+  "description": "Add extra features to JIRA.",
+  "private": true,
+  "scripts": {
+    "build:chrome": "npm run build -- --env BROWSER=chrome",
+    "build:firefox": "npm run build -- --env BROWSER=firefox",
+    "build": "webpack --config webpack.prod.js",
+    "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": {
+    "type": "git",
+    "url": "git+https://github.com/kungfux/jira-automation-extension.git"
+  },
+  "author": "Alexander Fuks",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kungfux/jira-automation-extension/issues"
+  },
+  "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.79.0",
+    "webpack-cli": "^5.0.1",
+    "webpack-merge": "^5.8.0"
+  }
+}
diff --git a/src/icons/logo128.png b/src/icons/logo128.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0c7d0c0c50a7fc4b9cb68f83cf5f25087844957b4df0aa9588c57ced37af011f
+size 1356
diff --git a/src/icons/logo48.png b/src/icons/logo48.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:db5b5b6c16111faeb4bdc41a1159247748eba5a8b655d7060a842945f233ff2c
+size 530
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,9 @@
+class Test {
+  main(): void {
+    console.log('OK');
+    console.log('OK');
+    console.dir({ foo: 'bar' });
+  }
+}
+
+new Test().main();
diff --git a/src/manifest.chrome.json b/src/manifest.chrome.json
@@ -0,0 +1 @@
+{}
diff --git a/src/manifest.firefox.json b/src/manifest.firefox.json
@@ -0,0 +1,8 @@
+{
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "{eb6d1100-3fa7-4869-8370-11bc3e058fe1}",
+      "strict_min_version": "109.0"
+    }
+  }
+}
diff --git a/src/manifest.json b/src/manifest.json
@@ -0,0 +1,17 @@
+{
+  "manifest_version": 3,
+  "name": "JIRA Automation",
+  "version": "1.0",
+  "description": "Browser extension to automate typical actions in JIRA.",
+  "icons": {
+    "48": "icons/logo48.png",
+    "128": "icons/logo128.png"
+  },
+  "content_scripts": [
+    {
+      "matches": ["*://*.atlassian.net/jira/*"],
+      "js": ["bundle.js"]
+    }
+  ],
+  "host_permissions": ["*://*.atlassian.net/jira/*"]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "sourceMap": true,
+    "noImplicitAny": true,
+    "module": "es6",
+    "target": "es5",
+    "moduleResolution": "node",
+    "strictNullChecks": true
+  }
+}
diff --git a/webpack.common.js b/webpack.common.js
@@ -0,0 +1,41 @@
+const path = require('path');
+const CopyPlugin = require('copy-webpack-plugin');
+const MergeJsonWebpackPlugin = require('merge-jsons-webpack-plugin');
+
+module.exports = (env) => {
+  return {
+    entry: './src/index.ts',
+    output: {
+      filename: 'bundle.js',
+      path: path.resolve(__dirname, `dist/${env.BROWSER ?? 'chrome'}`),
+      clean: true,
+    },
+    module: {
+      rules: [
+        {
+          test: /\.tsx?$/,
+          use: 'ts-loader',
+          exclude: /node_modules/,
+        },
+      ],
+    },
+    resolve: {
+      extensions: ['.tsx', '.ts', '.js'],
+    },
+    plugins: [
+      new CopyPlugin({
+        patterns: [{ from: './src/icons', to: 'icons' }],
+      }),
+      new MergeJsonWebpackPlugin({
+        space: 2,
+        files: [
+          './src/manifest.json',
+          `./src/manifest.${env.BROWSER ?? 'chrome'}.json`,
+        ],
+        output: {
+          fileName: 'manifest.json',
+        },
+      }),
+    ],
+  };
+};
diff --git a/webpack.dev.js b/webpack.dev.js
@@ -0,0 +1,9 @@
+const { merge } = require('webpack-merge');
+const common = require('./webpack.common.js');
+
+module.exports = (env) => {
+  return merge(common(env), {
+    mode: 'development',
+    devtool: 'inline-source-map',
+  });
+};
diff --git a/webpack.prod.js b/webpack.prod.js
@@ -0,0 +1,8 @@
+const { merge } = require('webpack-merge');
+const common = require('./webpack.common.js');
+
+module.exports = (env) => {
+  return merge(common(env), {
+    mode: 'production',
+  });
+};

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules/`
	`2`	`+dist/`
	`3`	`+package-lock.json`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+* text=auto eol=lf`
	`2`	`+*.png filter=lfs diff=lfs merge=lfs -text`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"],
 +  "unwantedRecommendations": []
 +}