browser-extension-settings 0.3.1 → 0.5.0

package/lib/common.ts

@@ -1,4 +1,4 @@
-export const besVersion = 30
+export const besVersion = 50
 export const openButton = `<svg viewBox="0 0 60.2601318359375 84.8134765625" version="1.1" xmlns="http://www.w3.org/2000/svg" class=" glyph-box" style="height: 9.62969px; width: 6.84191px;"><g transform="matrix(1 0 0 1 -6.194965820312518 77.63671875)"><path d="M66.4551-35.2539C66.4551-36.4746 65.9668-37.5977 65.0391-38.4766L26.3672-76.3672C25.4883-77.1973 24.4141-77.6367 23.1445-77.6367C20.6543-77.6367 18.7012-75.7324 18.7012-73.1934C18.7012-71.9727 19.1895-70.8496 19.9707-70.0195L55.5176-35.2539L19.9707-0.488281C19.1895 0.341797 18.7012 1.41602 18.7012 2.68555C18.7012 5.22461 20.6543 7.12891 23.1445 7.12891C24.4141 7.12891 25.4883 6.68945 26.3672 5.81055L65.0391-32.0312C65.9668-32.959 66.4551-34.0332 66.4551-35.2539Z"></path></g></svg>`
 export const openInNewTabButton = `<svg viewBox="0 0 72.127685546875 72.2177734375" version="1.1" xmlns="http://www.w3.org/2000/svg" class=" glyph-box" style="height: 8.19958px; width: 8.18935px;"><g transform="matrix(1 0 0 1 -12.451127929687573 71.3388671875)"><path d="M84.5703-17.334L84.5215-66.4551C84.5215-69.2383 82.7148-71.1914 79.7852-71.1914L30.6641-71.1914C27.9297-71.1914 26.0742-69.0918 26.0742-66.748C26.0742-64.4043 28.1738-62.4023 30.4688-62.4023L47.4609-62.4023L71.2891-63.1836L62.207-55.2246L13.8184-6.73828C12.9395-5.85938 12.4512-4.73633 12.4512-3.66211C12.4512-1.31836 14.5508 0.878906 16.9922 0.878906C18.1152 0.878906 19.1895 0.488281 20.0684-0.439453L68.5547-48.877L76.6113-58.0078L75.7324-35.2051L75.7324-17.1387C75.7324-14.8438 77.7344-12.6953 80.127-12.6953C82.4707-12.6953 84.5703-14.6973 84.5703-17.334Z"></path></g></svg>`
 export const settingButton = `<svg viewBox="0 0 16 16" version="1.1">

package/lib/extension-list.ts

@@ -8,6 +8,7 @@ import {
   removeClass,
 } from "browser-extension-utils"
 import { openButton, openInNewTabButton } from "./common"
+import { i } from "./messages"
 
 type InstalledExtension = {
   id: string
@@ -23,37 +24,47 @@ type RelatedExtension = {
   url: string
 }
 
+const lang = navigator.language
+let locale: string
+if (lang === "zh-TW" || lang === "zh-HK") {
+  locale = "zh-TW"
+} else if (lang.includes("zh")) {
+  locale = "zh-CN"
+} else {
+  locale = "en"
+}
+
 const relatedExtensions: RelatedExtension[] = [
   {
     id: "utags",
-    title: "🏷️ UTags - Add usertags to links",
-    url: "https://greasyfork.org/zh-CN/scripts/460718-utags-add-usertags-to-links",
+    title: i("settings.extensions.utags.title"),
+    url: `https://greasyfork.org/${locale}/scripts/460718-utags-add-usertags-to-links`,
   },
   {
     id: "links-helper",
-    title: "🔗 链接助手",
+    title: i("settings.extensions.links-helper.title"),
     description: "在新标签页中打开第三方网站链接，图片链接转图片标签等",
-    url: "https://greasyfork.org/zh-CN/scripts/464541-links-helper",
+    url: `https://greasyfork.org/${locale}/scripts/464541-links-helper`,
   },
   {
     id: "v2ex.rep",
-    title: "V2EX.REP - 专注提升 V2EX 主题回复浏览体验",
-    url: "https://greasyfork.org/zh-CN/scripts/466589-v2ex-rep-%E4%B8%93%E6%B3%A8%E6%8F%90%E5%8D%87-v2ex-%E4%B8%BB%E9%A2%98%E5%9B%9E%E5%A4%8D%E6%B5%8F%E8%A7%88%E4%BD%93%E9%AA%8C",
+    title: i("settings.extensions.v2ex.rep.title"),
+    url: `https://greasyfork.org/${locale}/scripts/466589-v2ex-rep-%E4%B8%93%E6%B3%A8%E6%8F%90%E5%8D%87-v2ex-%E4%B8%BB%E9%A2%98%E5%9B%9E%E5%A4%8D%E6%B5%8F%E8%A7%88%E4%BD%93%E9%AA%8C`,
   },
   {
     id: "v2ex.min",
-    title: "v2ex.min - V2EX 极简风格",
-    url: "https://greasyfork.org/zh-CN/scripts/463552-v2ex-min-v2ex-%E6%9E%81%E7%AE%80%E9%A3%8E%E6%A0%BC",
+    title: i("settings.extensions.v2ex.min.title"),
+    url: `https://greasyfork.org/${locale}/scripts/463552-v2ex-min-v2ex-%E6%9E%81%E7%AE%80%E9%A3%8E%E6%A0%BC`,
   },
   {
     id: "replace-ugly-avatars",
-    title: "赐你个头像吧",
-    url: "https://greasyfork.org/zh-CN/scripts/472616-replace-ugly-avatars",
+    title: i("settings.extensions.replace-ugly-avatars.title"),
+    url: `https://greasyfork.org/${locale}/scripts/472616-replace-ugly-avatars`,
   },
   {
     id: "more-by-pipecraft",
-    title: "更多有趣的脚本",
-    url: "https://greasyfork.org/zh-CN/users/1030884-pipecraft",
+    title: i("settings.extensions.more-by-pipecraft.title"),
+    url: `https://greasyfork.org/${locale}/users/1030884-pipecraft`,
   },
 ]
 

package/lib/messages/en.ts

@@ -0,0 +1,12 @@
+const messages = {
+  "settings.displaySettingsButtonInSideMenu": "Display Settings Button in Side Menu",
+  "settings.menu.settings": "⚙️ Settings",
+  "settings.extensions.utags.title": "🏷️ UTags - Add usertags to links",
+  "settings.extensions.links-helper.title": "🔗 Links Helper",
+  "settings.extensions.v2ex.rep.title": "V2EX.REP - 专注提升 V2EX 主题回复浏览体验",
+  "settings.extensions.v2ex.min.title": "v2ex.min - V2EX Minimalist (极简风格)",
+  "settings.extensions.replace-ugly-avatars.title": "Replace Ugly Avatars",
+  "settings.extensions.more-by-pipecraft.title": "Find more useful userscripts",
+}
+
+export default messages

package/lib/messages/index.ts

@@ -0,0 +1,8 @@
+import { initI18n } from "browser-extension-i18n"
+import messagesEn from "./en"
+import messagesZh from "./zh-cn"
+
+export const i = initI18n({
+  "en,en-US": messagesEn,
+  "zh,zh-CN": messagesZh,
+})

package/lib/messages/zh-cn.ts

@@ -0,0 +1,12 @@
+export const messages = {
+  "settings.displaySettingsButtonInSideMenu": "在侧边栏菜单中显示设置按钮",
+  "settings.menu.settings": "⚙️ 设置",
+  "settings.extensions.utags.title": "🏷️ 小鱼标签 (UTags) - 为链接添加用户标签",
+  "settings.extensions.links-helper.title": "🔗 链接助手",
+  "settings.extensions.v2ex.rep.title": "V2EX.REP - 专注提升 V2EX 主题回复浏览体验",
+  "settings.extensions.v2ex.min.title": "v2ex.min - V2EX 极简风格",
+  "settings.extensions.replace-ugly-avatars.title": "赐你个头像吧",
+  "settings.extensions.more-by-pipecraft.title": "更多有趣的脚本",
+}
+
+export default messages

package/lib/settings.ts

@@ -12,8 +12,9 @@ import {
   createHTML,
   doc,
   parseInt10,
+  registerMenuCommand,
   removeEventListener,
-  runWhenBodyExists,
+  runWhenDomReady,
   runWhenHeadExists,
 } from "browser-extension-utils"
 import styleText from "data-text:./style.scss"
@@ -26,6 +27,7 @@ import {
   deactiveExtensionList,
 } from "./extension-list"
 import { besVersion, settingButton } from "./common"
+import { i } from "./messages"
 
 const prefix = "browser_extension_settings_"
 
@@ -41,7 +43,11 @@ type SettingsOptions = {
 
 type SettingsTable = Record<
   string,
-  SettingsSwitchItem | SettingsInputItem | SettingsActionItem | SettingsTipItem
+  | SettingsSwitchItem
+  | SettingsInputItem
+  | SettingsActionItem
+  | SettingsSelectItem
+  | SettingsTipItem
 >
 
 type SettingsSwitchItem = {
@@ -71,6 +77,15 @@ type SettingsActionItem = {
   defaultValue?: any
 }
 
+type SettingsSelectItem = {
+  title: string
+  icon?: string
+  type: "select"
+  options: { string: { string: any } }
+  group?: number
+  defaultValue?: any
+}
+
 type SettingsTipItem = {
   title: string
   icon?: string
@@ -210,6 +225,18 @@ async function updateOptions() {
           break
         }
 
+        case "select": {
+          const options = $$(
+            `#${settingsElementId} .option_groups .select_option[data-key="${key}"] .bes_select option`
+          ) as HTMLOptionElement[]
+
+          for (const option of options) {
+            option.selected = option.value === String(getSettingsValue(key))
+          }
+
+          break
+        }
+
         case "textarea": {
           const textArea = $(
             `#${settingsElementId} .option_groups textarea[data-key="${key}"]`
@@ -393,6 +420,39 @@ function createSettingsElement() {
             break
           }
 
+          case "select": {
+            const div = addElement(optionGroup, "div", {
+              class: "select_option bes_option",
+              "data-key": key,
+            })
+            if (item.icon) {
+              addElement(div, "img", { src: item.icon, class: "bes_icon" })
+            }
+
+            addElement(div, "span", {
+              textContent: item.title,
+              class: "bes_title",
+            })
+
+            const select = addElement(div, "select", {
+              class: "bes_select",
+              async onchange() {
+                await saveSettingsValue(key, select.value)
+              },
+            }) as HTMLSelectElement
+
+            for (const option of Object.entries(
+              (item as SettingsSelectItem).options
+            )) {
+              addElement(select, "option", {
+                textContent: option[0],
+                value: option[1],
+              })
+            }
+
+            break
+          }
+
           case "tip": {
             const tip = addElement(optionGroup, "div", {
               class: "bes_tip",
@@ -455,7 +515,7 @@ function addSideMenu() {
   addElement(menu, "button", {
     type: "button",
     "data-bes-version": besVersion,
-    title: "设置",
+    title: i("settings.menu.settings"),
     onclick() {
       setTimeout(showSettings, 1)
     },
@@ -477,7 +537,7 @@ function addCommonSettings(settingsTable: SettingsTable) {
   }
 
   settingsTable.displaySettingsButtonInSideMenu = {
-    title: "Display Settings Button in Side Menu",
+    title: i("settings.displaySettingsButtonInSideMenu"),
     defaultValue: !(
       typeof GM === "object" && typeof GM.registerMenuCommand === "function"
     ),
@@ -522,10 +582,12 @@ export const initSettings = async (options: SettingsOptions) => {
   runWhenHeadExists(() => {
     addStyle(getSettingsStyle())
   })
-  runWhenBodyExists(() => {
+  runWhenDomReady(() => {
     initExtensionList()
     addSideMenu()
   })
 
+  registerMenuCommand(i("settings.menu.settings"), showSettings, "o")
+
   handleShowSettingsUrl()
 }

package/lib/style.scss

@@ -30,12 +30,18 @@
       font-size: 26px;
       font-weight: 800;
       border: none;
+      color: var(--browser-extension-settings-text-color);
+      margin: 18px 0;
+      padding: 0;
     }
 
     h2 {
       font-size: 18px;
       font-weight: 600;
       border: none;
+      color: var(--browser-extension-settings-text-color);
+      margin: 14px 0;
+      padding: 0;
     }
 
     .extension_list_container {
@@ -134,6 +140,7 @@
     font-size: 18px;
     font-weight: 600;
     border: none;
+    color: var(--browser-extension-settings-text-color);
   }
 
   footer {
@@ -208,7 +215,8 @@
     box-sizing: border-box;
   }
 
-  .switch_option {
+  .switch_option,
+  .select_option {
     display: flex;
     justify-content: space-between;
     align-items: center;
@@ -224,16 +232,31 @@
     border-top: none;
   }
 
-  .switch_option > img {
+  .bes_option > .bes_icon {
     width: 24px;
     height: 24px;
     margin-right: 10px;
   }
-  .switch_option > span {
+  .bes_option > .bes_title {
     margin-right: 10px;
     flex-grow: 1;
   }
 
+  .bes_option > .bes_select {
+    box-sizing: border-box;
+    background-color: #fff;
+    height: 24px;
+    padding: 0 2px 0 2px;
+    margin: 0;
+    border-radius: 6px;
+    border: 1px solid #ccc;
+    /*
+    -webkit-appearance: none;
+    -moz-appearance: none;
+    appearance: none;
+    */
+  }
+
   .option_groups .bes_tip {
     position: relative;
     margin: 0;

package/lib/switch.ts

@@ -44,12 +44,12 @@ export function createSwitchOption(
     return createSwitchOption(undefined, icon, text)
   }
 
-  const div = createElement("div", { class: "switch_option" })
+  const div = createElement("div", { class: "switch_option bes_option" })
   if (icon) {
-    addElement(div, "img", { src: icon })
+    addElement(div, "img", { src: icon, class: "bes_icon" })
   }
 
-  addElement(div, "span", { textContent: text })
+  addElement(div, "span", { textContent: text, class: "bes_title" })
   div.append(createSwitch(options))
   return div
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-settings",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Settings module for developing browser extensions and userscripts",
   "type": "module",
   "main": "./lib/index.ts",
@@ -27,8 +27,9 @@
   },
   "homepage": "https://github.com/utags/browser-extension-settings#readme",
   "dependencies": {
+    "browser-extension-i18n": "^0.0.4",
     "browser-extension-storage": "^0.1.2",
-    "browser-extension-utils": "^0.1.15"
+    "browser-extension-utils": "^0.1.17"
   },
   "devDependencies": {
     "@types/chrome": "^0.0.243",
@@ -56,6 +57,14 @@
       "import/extensions": 0,
       "@typescript-eslint/prefer-nullish-coalescing": 0,
       "capitalized-comments": 0
-    }
+    },
+    "overrides": [
+      {
+        "files": "lib/messages/*.ts",
+        "rules": {
+          "@typescript-eslint/naming-convention": 0
+        }
+      }
+    ]
   }
 }