Merge pull request #6 from kungfux/feature/copy_issue_number

Copy issue number to clipboard

Author: kungfux

.github/workflows/build.yml

@@ -50,6 +50,5 @@ jobs:
         with:
           name: jira-issue-expert
           path: |
-            dist/
-            !dist/**/*.zip
+            dist/**/*.zip
           if-no-files-found: error

.vscode/settings.json

@@ -1,7 +1,11 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
+  "files.eol": "\n",
   "files.insertFinalNewline": true,
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
   "[json]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   }

README.md

@@ -2,15 +2,30 @@
 
 `IssueExpert for JIRA` is a browser extension that adds extra functionality to JIRA for operating with issues.
 
+> Note: Currently supported JIRA version is 9.4.0 only!
+
 # Features
 
-- TBD
+> Check out [demo](#demo) section to see it in action.
+
+- Copy issue link, number, summary to clipboard
 
 # Install
 
 Add an extension to your favorite browser by visiting extensions store
 
-TBD
+[![](docs/get_addon_firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/issueexpert-for-jira/) [![](docs/get_addon_chrome.png)](https://chrome.google.com/webstore/detail/issueexpert-for-jira/fdpnlhakdaikopniehgchiagamknknom)
+
+## Note for Firefox users
+
+Make sure to allow the extension to access website:
+
+- Navigate to JIRA instance site
+- Click the extensions icon
+- Click gear icon
+- Click `Always Allow on *.issueexpert.com`
+
+![asd](docs/firefox_permissions.png)
 
 # Build and test locally
 
@@ -38,3 +53,8 @@ $ npm run watch:firefox
 
 - Check out [LICENSE](LICENSE) for the license details
 - Icons by [Flatart](https://www.freepik.com/author/flatart)
+
+# Demo
+
+![Copy issue number](docs/copy-issue-number.png)
+ 

docs/copy-issue-number.png

@@ -1,6 +1,6 @@
 {
   "name": "jira-issue-expert",
-  "version": "1.0.0",
+  "version": "0.1.4",
   "description": "Add extra functionality to JIRA for operating with issues.",
   "private": true,
   "scripts": {
@@ -29,24 +29,25 @@
   },
   "homepage": "https://github.com/kungfux/jira-issue-expert#readme",
   "devDependencies": {
-    "@eslint-recommended/eslint-config-typescript": "^17.0.3",
-    "@types/webextension-polyfill": "^0.10.0",
-    "@typescript-eslint/eslint-plugin": "^5.59.0",
+    "@eslint-recommended/eslint-config-typescript": "^33.0.0",
+    "@types/webextension-polyfill": "^0.10.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
     "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-prettier": "^4.2.1",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-n": "^16.2.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-promise": "^6.1.1",
-    "html-webpack-plugin": "^5.5.1",
+    "html-webpack-plugin": "^5.5.3",
     "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"
+    "prettier": "^3.0.3",
+    "ts-loader": "^9.5.0",
+    "typescript": "^5.2.2",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-merge": "^5.9.0",
+    "zip-webpack-plugin": "^4.0.1"
   },
   "dependencies": {
     "webextension-polyfill": "^0.10.0"

docs/firefox_permissions.png

@@ -1,6 +1,8 @@
 import type { Tabs, WebNavigation } from 'webextension-polyfill';
 import { tabs, webNavigation, scripting } from 'webextension-polyfill';
 import { Settings } from '../settings';
+import { Log } from '../log';
+import * as Browser from 'webextension-polyfill';
 
 export class BackgroundService {
   private readonly settings = new Settings();
@@ -25,15 +27,19 @@ export class BackgroundService {
     tabInfo: Tabs.Tab
   ): Promise<void> {
     if (changeInfo.url !== undefined && this.isJiraUrl(changeInfo.url)) {
+      void Log.info('onTabUpdated gets called');
       await this.injectContentScript(tabId);
+      this.sendNewUrlMessage(tabId, changeInfo.url);
     }
   }
 
   private async onNavigationCompleted(
     details: WebNavigation.OnCompletedDetailsType
   ): Promise<void> {
     if (details.url.length > 0 && this.isJiraUrl(details.url)) {
+      void Log.info('onNavigationCompleted gets called');
       await this.injectContentScript(details.tabId);
+      this.sendNewUrlMessage(details.tabId, details.url);
     }
   }
 
@@ -63,7 +69,11 @@ export class BackgroundService {
         files: ['content.bundle.js'],
       });
     } catch (error) {
-      console.error(`Failed to inject content script: ${String(error)}`);
+      void Log.error(`Failed to inject content script: ${String(error)}`);
     }
   }
+
+  private sendNewUrlMessage(tabId: number, newUrl: string): void {
+    void Browser.tabs.sendMessage(tabId, { newUrl });
+  }
 }

docs/get_addon_chrome.png

@@ -1,8 +1,10 @@
 import { runtime } from 'webextension-polyfill';
 import { BackgroundService } from './background-service';
 
-new BackgroundService().init();
-
-runtime.onInstalled.addListener(() => {
-  void runtime.openOptionsPage();
+runtime.onInstalled.addListener((details) => {
+  if (details.reason === 'install') {
+    void runtime.openOptionsPage();
+  }
 });
+
+new BackgroundService().init();