Merge pull request #14 from crashmax-dev/gm-promisify

feat: GM dot alias, GM promised

Author: crashmax-dev

examples/basic/vite.config.ts

@@ -10,9 +10,9 @@ export default defineConfig({
         name,
         version,
         match: [
-          'https://example.com',
-          'https://example.org',
-          'https://example.edu'
+          '*://example.com',
+          '*://example.org',
+          '*://example.edu'
         ]
       }
     })

examples/jsx/vite.config.ts

@@ -11,7 +11,7 @@ export default defineConfig({
       header: {
         name,
         version,
-        match: 'https://example.com'
+        match: '*://example.com'
       }
     })
   ]

src/constants.ts

@@ -1,32 +1,43 @@
+import type { Grants } from './types.js'
+
 export const regexpScripts = new RegExp(/.(t|j)sx?/)
 export const regexpStyles = new RegExp(/\.(s?css|sass)$/)
 
-export const grants = [
+export const GM = [
+  'setValue',
+  'getValue',
+  'deleteValue',
+  'listValues',
+  'setClipboard',
+  'addStyle',
+  'addElement',
+  'addValueChangeListener',
+  'removeValueChangeListener',
+  'registerMenuCommand',
+  'unregisterMenuCommand',
+  'download',
+  'getTab',
+  'getTabs',
+  'saveTab',
+  'openInTab',
+  'notification',
+  'getResourceURL',
+  'getResourceText',
+  'xmlhttpRequest',
+  'log',
+  'info'
+] as const
+
+export const GMwindow = [
   'unsafeWindow',
   'window.onurlchange',
   'window.focus',
-  'window.close',
-  'GM_setValue',
-  'GM_getValue',
-  'GM_deleteValue',
-  'GM_listValues',
-  'GM_setClipboard',
-  'GM_addStyle',
-  'GM_addElement',
-  'GM_addValueChangeListener',
-  'GM_removeValueChangeListener',
-  'GM_registerMenuCommand',
-  'GM_unregisterMenuCommand',
-  'GM_download',
-  'GM_getTab',
-  'GM_getTabs',
-  'GM_saveTab',
-  'GM_openInTab',
-  'GM_notification',
-  'GM_getResourceURL',
-  'GM_getResourceText',
-  'GM_xmlhttpRequest',
-  'GM_webRequest',
-  'GM_log',
-  'GM_info'
+  'window.close'
 ] as const
+
+export const grants = GM.map<Grants[]>((grant) => [
+  `GM_${grant}`,
+  `GM.${grant}`
+]).flat()
+
+grants.push(...GMwindow)

src/index.ts

@@ -26,6 +26,7 @@ export default function UserscriptPlugin(
   let isBuildWatch: boolean
   let socketConnection: connection | null = null
 
+  const workdir = dirname(fileURLToPath(import.meta.url))
   const logger = createLogger('info', {
     prefix: '[vite-userscript-plugin]',
     allowClearScreen: true
@@ -120,7 +121,7 @@ export default function UserscriptPlugin(
           const proxyFilePath = resolve(rootDir, outDir, proxyFilename)
           const metaFilePath = resolve(rootDir, outDir, metaFilename)
           const hotReloadPath = resolve(
-            dirname(fileURLToPath(import.meta.url)),
+            workdir,
             `hot-reload-${config.header.name}.js`
           )
 
@@ -141,10 +142,7 @@ export default function UserscriptPlugin(
 
             if (isBuildWatch) {
               const hotReloadFile = readFileSync(
-                resolve(
-                  dirname(fileURLToPath(import.meta.url)),
-                  'hot-reload.js'
-                ),
+                resolve(workdir, 'hot-reload.js'),
                 'utf8'
               )
 

src/types.ts

@@ -1,4 +1,4 @@
-import { grants } from './constants.js'
+import { GM, GMwindow } from './constants.js'
 
 export interface Transform {
   file: string
@@ -13,7 +13,9 @@ export type RunAt =
   | 'document-idle'
   | 'context-menu'
 
-export type Grants = typeof grants[number]
+export type GMLiterals<T extends string> = [`GM_${T}` | `GM.${T}`]
+export type GMWindow = typeof GMwindow[number]
+export type Grants = GMWindow | GMLiterals<typeof GM[number]>[number]
 
 export type HeaderConfig = {
   [property: string]: string | boolean | number | string[] | undefined

test/__snapshots__/banner.test.ts.snap

@@ -21,33 +21,54 @@ exports[`banner default snapshot 1`] = `
 // @updateURL   https://vitest.dev
 // @resource    https://vitest.dev
 // @require     https://example.com/index.js
-// @grant       unsafeWindow
-// @grant       window.onurlchange
-// @grant       window.focus
-// @grant       window.close
 // @grant       GM_setValue
+// @grant       GM.setValue
 // @grant       GM_getValue
+// @grant       GM.getValue
 // @grant       GM_deleteValue
+// @grant       GM.deleteValue
 // @grant       GM_listValues
+// @grant       GM.listValues
 // @grant       GM_setClipboard
+// @grant       GM.setClipboard
 // @grant       GM_addStyle
+// @grant       GM.addStyle
 // @grant       GM_addElement
+// @grant       GM.addElement
 // @grant       GM_addValueChangeListener
+// @grant       GM.addValueChangeListener
 // @grant       GM_removeValueChangeListener
+// @grant       GM.removeValueChangeListener
 // @grant       GM_registerMenuCommand
+// @grant       GM.registerMenuCommand
 // @grant       GM_unregisterMenuCommand
+// @grant       GM.unregisterMenuCommand
 // @grant       GM_download
+// @grant       GM.download
 // @grant       GM_getTab
+// @grant       GM.getTab
 // @grant       GM_getTabs
+// @grant       GM.getTabs
 // @grant       GM_saveTab
+// @grant       GM.saveTab
 // @grant       GM_openInTab
+// @grant       GM.openInTab
 // @grant       GM_notification
+// @grant       GM.notification
 // @grant       GM_getResourceURL
+// @grant       GM.getResourceURL
 // @grant       GM_getResourceText
+// @grant       GM.getResourceText
 // @grant       GM_xmlhttpRequest
-// @grant       GM_webRequest
+// @grant       GM.xmlhttpRequest
 // @grant       GM_log
+// @grant       GM.log
 // @grant       GM_info
+// @grant       GM.info
+// @grant       unsafeWindow
+// @grant       window.onurlchange
+// @grant       window.focus
+// @grant       window.close
 // @match       https://vitest.dev
 // @run-at      document-start
 // ==/UserScript=="

tsup.config.ts

@@ -1,11 +1,22 @@
 import { defineConfig } from 'tsup'
 
-export default defineConfig((option) => ({
-  entry: ['src/index.ts', 'src/hot-reload.ts'],
-  format: ['cjs', 'esm'],
-  external: ['vite'],
-  dts: true,
-  clean: true,
-  minify: true,
-  watch: option.watch
-}))
+export default defineConfig((option) => {
+  return [
+    {
+      entry: ['src/index.ts'],
+      format: ['cjs', 'esm'],
+      external: ['vite'],
+      dts: true,
+      clean: true,
+      minify: true,
+      watch: option.watch
+    },
+    {
+      entry: ['src/hot-reload.ts'],
+      format: ['esm'],
+      clean: true,
+      minify: true,
+      watch: option.watch
+    }
+  ]
+})