Merge pull request #2 from gnehcwu/feat/typescript-re

Feat: improvements & typescript: - Re-write in typescript - List virtualization to improve performance - UI improvements: - improved focus/scrolling locking - added icons for commands - More shortcuts to enter action mode directly - Bump version to 1.2.3
gnehcwu · Dec 17, 2024 · d8e25fb · d8e25fb
2 parents d4aa0c6 + 795f2d6
commit d8e25fb
Show file tree

Hide file tree

Showing 95 changed files with 12,486 additions and 3,907 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -7,6 +7,7 @@ module.exports = {
   },
   extends: [
     'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
     'plugin:jsx-a11y/strict',
     'plugin:prettier/recommended',
     'plugin:react/recommended',
@@ -19,7 +20,7 @@ module.exports = {
       jsx: true,
     },
   },
-  plugins: ['react', 'react-hooks', 'jsx-a11y'],
+  plugins: ['react', 'react-hooks', 'jsx-a11y', '@typescript-eslint'],
   settings: {
     react: {
       version: 'detect',

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2023-present, Cheng Wu
 
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,29 +1,28 @@
 # SN Launcher browser extension
 
-Supercharge your workflow on ServiceNow instance with a crafted command bar.
+Supercharge your workflow on ServiceNow instance with a crafted command palette.
 
-[![SN Launcher youtube](https://img.youtube.com/vi/l-RVEdRNQdg/0.jpg)](https://www.youtube.com/watch?v=l-RVEdRNQdg)
+<a href="https://www.youtube.com/watch?v=nKIqjEVyTgc">
+  <img src="./docs/poster.png" alt="SN Launcher video" width="426" height="240">
+</a>
 
 ## Features
 
-- 🔍 Search and navigate Servicenow menus, history in a command bar
-- 🚀 Action mode
-  - search by sysid
-  - shortcut go to record list or new record
-  - switching between application scopes
-  - Search Servicenow documentation
-  - Search Servicenow next experience components
-- 🔤 Always ready for input & mouse free navigation
-- 🌙 Dark mode
+- Search and navigate ServiceNow instance menus in a command palette
+- Action mode
+  - Find record by sysId
+  - Search tables, histories, developer documentation, and seismic components
+  - Switch between application scopes
+- Browser extension shortcut commands to instantly enter action mode
+- Enable animations in accordance with the user's system motion preferences.
+- Light / Dark theme
 
-## Install
+## Install from store
 
 [Chrome, Edge, Chromium based browsers](https://chrome.google.com/webstore/detail/sn-launcher-servicenow-ut/pngglpnmlfdihkcdglcflibenhmcipmg)
 
 [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sn-launcher/)
 
 ## License
 
-[MIT](https://opensource.org/licenses/MIT)
-
-Copyright (c) 2023-present, Cheng Wu
+[MIT](LICENSE)
diff --git a/docs/README.md b/docs/README.md
@@ -2,4 +2,4 @@
 
 Website for browser extension SN Launcher, which is a browser extension aiming to quickly search / navigate on ServiceNow instance, to improve productivity, supports Chrome, Firefox, Edge and all Chromium based browsers.
 
-More details check 👉 [SN Launcher website](https://gnehcwu.github.io/snlauncher/)
+More details check 👉 [SN Launcher website](https://gnehcwu.github.io/sn-launcher/)
diff --git a/docs/index.html b/docs/index.html
@@ -4,12 +4,21 @@
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>SN Launcher - ServiceNow utility tool</title>
-    <meta property="og:title" content="SN Launcher - ServiceNow utility tool">
-    <meta name="twitter:title" content="SN Launcher - ServiceNow utility tool">
+    <meta property="og:title" content="SN Launcher - ServiceNow utility tool" />
+    <meta name="twitter:title" content="SN Launcher - ServiceNow utility tool" />
 
-    <meta name="description" content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance.">
-    <meta property="og:description" content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance.">
-    <meta name="twitter:description" content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance.">
+    <meta
+      name="description"
+      content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance."
+    />
+    <meta
+      property="og:description"
+      content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance."
+    />
+    <meta
+      name="twitter:description"
+      content="ServiceNow utility tool, supercharge your workflow on ServiceNow instance."
+    />
 
     <link rel="stylesheet" href="https://unpkg.com/open-props" />
     <!-- optional imports that use the props -->
@@ -22,7 +31,7 @@
     <div class="container">
       <div class="headerContainer">
         <div class="title">
-          <h1 class=" header gradient-text">SN Launcher</h1>
+          <h1 class="header gradient-text">SN Launcher</h1>
           <a href="https://github.com/gnehcwu/sn-launcher" target="_blank">
             <img width="28" height="28" src="./icons/github-mark.svg" alt="github repo" />
           </a>
@@ -40,16 +49,34 @@ <h3 class="gradient-text">Supported browsers</h3>
             target="_blank"
             href="https://chrome.google.com/webstore/detail/sn-launcher-servicenow-ut/pngglpnmlfdihkcdglcflibenhmcipmg"
           >
-            <img width="58" height="58" src="./icons/chrome.svg" alt="browser chrome" class="logo" />
-            <img width="58" height="58" src="./icons/edge.svg" alt="browser edge" class="logo" />
             <img
+              width="58"
+              height="58"
+              src="./icons/chrome.svg"
+              alt="browser chrome"
+              class="logo"
+            />
+          </a>
+          <a
+            class="chromium"
+            target="_blank"
+            href="https://chrome.google.com/webstore/detail/sn-launcher-servicenow-ut/pngglpnmlfdihkcdglcflibenhmcipmg"
+          >
+            <img
+              class="logo"
               width="58"
               height="58"
               src="./icons/chromium.svg"
               alt="browser chromium"
-              class="logo"
             />
           </a>
+          <a
+            class="edge"
+            target="_blank"
+            href="https://chrome.google.com/webstore/detail/sn-launcher-servicenow-ut/pngglpnmlfdihkcdglcflibenhmcipmg"
+          >
+            <img class="logo" width="58" height="58" src="./icons/edge.svg" alt="browser edge" />
+          </a>
           <a
             class="firefox"
             target="_blank"
@@ -68,10 +95,11 @@ <h3 class="gradient-text">Supported browsers</h3>
       <div class="screenshot">
         <h3 class="gradient-text">More</h3>
         <iframe
-          src="https://www.youtube.com/embed/l-RVEdRNQdg?si=RmLRhyyOOwvMqhAe"
-          title="YouTube video player - SN Launcher"
+          src="https://www.youtube.com/embed/nKIqjEVyTgc?si=i20jH-RJRE5goWUb"
+          title="YouTube video player"
           frameborder="0"
           allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+          referrerpolicy="strict-origin-when-cross-origin"
           allowfullscreen
         ></iframe>
       </div>

diff --git a/docs/poster.png b/docs/poster.png
diff --git a/docs/style.css b/docs/style.css
@@ -50,14 +50,12 @@ h3 {
 
 .platforms {
   display: flex;
-  justify-content: space-between;
+  flex-direction: row;
+  gap: 1.5rem;
 }
 
-.chromiums {
-  display: flex;
-  flex: row;
-  justify-content: space-between;
-  gap: 1.5rem;
+.platforms .firefox {
+  margin-left: 4.5rem;
 }
 
 .logo {

diff --git a/manifests/chromium/manifest.json b/manifests/chromium/manifest.json
@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "SN Launcher - ServiceNow utility tool",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "ServiceNow utility tool, search and navigate with a command palette.(personal project, not affiliated to ServiceNow)",
   "icons": {
     "16": "../../assets/icon.png",
@@ -10,13 +10,14 @@
     "128": "../../assets/icon.png"
   },
   "background": {
-    "service_worker": "../../src/scripts/background.js",
+    "service_worker": "../../src/scripts/background.ts",
     "type": "module"
   },
   "content_scripts": [
     {
       "matches": ["<all_urls>"],
-      "js": ["../../src/scripts/content.js"]
+      "js": ["/src/scripts/content.ts"],
+      "run_at": "document_idle"
     }
   ],
   "action": {
@@ -25,15 +26,45 @@
       "32": "../../assets/icon.png",
       "48": "../../assets/icon.png",
       "128": "../../assets/icon.png"
-    }
+    },
+    "default_title": "SN Launcher"
   },
   "commands": {
-    "snl-toggle-launcher": {
+    "snl-toggle-launcher-command": {
       "suggested_key": {
-        "default": "Ctrl+Shift+L",
-        "mac": "Command+Shift+L"
+        "windows": "Ctrl+Shift+L",
+        "mac": "Command+Shift+L",
+        "chromeos": "Ctrl+Shift+L",
+        "linux": "Ctrl+Shift+L"
       },
       "description": "Open launcher"
+    },
+    "snl-switch-scope-command": {
+      "suggested_key": {
+        "windows": "Ctrl+Shift+S",
+        "mac": "Command+Shift+S",
+        "chromeos": "Ctrl+Shift+S",
+        "linux": "Ctrl+Shift+S"
+      },
+      "description": "Switch scope"
+    },
+    "snl-search-table-command": {
+      "suggested_key": {
+        "windows": "Alt+Shift+A",
+        "mac": "Alt+Shift+A",
+        "chromeos": "Alt+Shift+A",
+        "linux": "Alt+Shift+A"
+      },
+      "description": "Search table"
+    },
+    "snl-search-history-command": {
+      "suggested_key": {
+        "windows": "Alt+Shift+H",
+        "mac": "Alt+Shift+H",
+        "chromeos": "Alt+Shift+H",
+        "linux": "Alt+Shift+H"
+      },
+      "description": "Search history"
     }
   },
   "permissions": ["tabs", "activeTab"]

diff --git a/manifests/firefox/manifest.json b/manifests/firefox/manifest.json
@@ -1,27 +1,63 @@
 {
-  "manifest_version": 2,
+  "manifest_version": 3,
   "name": "SN Launcher - ServiceNow utility tool",
   "description": "ServiceNow utility tool, search and navigate with a command palette.(personal project, not affiliated to ServiceNow)",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "content_scripts": [
     {
       "matches": ["<all_urls>"],
-      "js": ["../../src/scripts/content.js"]
+      "js": ["../../src/scripts/content.ts"],
+      "run_at": "document_idle"
     }
   ],
-  "browser_action": {
-    "default_icon": "../../assets/icon.png"
+  "action": {
+    "default_icon": {
+      "16": "../../assets/icon.png",
+      "32": "../../assets/icon.png",
+      "48": "../../assets/icon.png",
+      "128": "../../assets/icon.png"
+    },
+    "default_title": "SN Launcher"
   },
   "background": {
-    "scripts": ["../../src/scripts/background.js"]
+    "scripts": ["../../src/scripts/background.ts"]
   },
   "commands": {
-    "snl-toggle-launcher": {
+    "snl-toggle-launcher-command": {
       "suggested_key": {
-        "default": "Ctrl+Shift+L",
-        "mac": "Command+Shift+L"
+        "windows": "Ctrl+Shift+L",
+        "mac": "Command+Shift+L",
+        "chromeos": "Ctrl+Shift+L",
+        "linux": "Ctrl+Shift+L"
       },
       "description": "Open launcher"
+    },
+    "snl-switch-scope-command": {
+      "suggested_key": {
+        "windows": "Ctrl+Shift+S",
+        "mac": "Command+Shift+S",
+        "chromeos": "Ctrl+Shift+S",
+        "linux": "Ctrl+Shift+S"
+      },
+      "description": "Switch scope"
+    },
+    "snl-search-table-command": {
+      "suggested_key": {
+        "windows": "Alt+Shift+A",
+        "mac": "Alt+Shift+A",
+        "chromeos": "Alt+Shift+A",
+        "linux": "Alt+Shift+A"
+      },
+      "description": "Search table"
+    },
+    "snl-search-history-command": {
+      "suggested_key": {
+        "windows": "Alt+Shift+H",
+        "mac": "Alt+Shift+H",
+        "chromeos": "Alt+Shift+H",
+        "linux": "Alt+Shift+H"
+      },
+      "description": "Search history"
     }
   },
   "permissions": ["tabs", "activeTab"],
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		Website for browser extension SN Launcher, which is a browser extension aiming to quickly search / navigate on ServiceNow instance, to improve productivity, supports Chrome, Firefox, Edge and all Chromium based browsers.

		More details check 👉 [SN Launcher website](https://gnehcwu.github.io/snlauncher/)
		More details check 👉 [SN Launcher website](https://gnehcwu.github.io/sn-launcher/)