feat: add meta header for update and download userscript

Author: crashmax-dev

src/banner.ts

@@ -1,33 +1,50 @@
 import type { HeaderConfig } from './types.js'
 
-export function banner(config: HeaderConfig): string {
-  const header: string[] = []
-  const configKeys = Object.keys(config)
-  const maxKeyLength = Math.max(...configKeys.map((key) => key.length)) + 1
+export class Banner {
+  private header: string[] = []
+  private configKeys: string[]
+  private maxKeyLength: number
 
-  const addSpaces = (str: string): string => {
-    return ' '.repeat(maxKeyLength - str.length)
+  constructor(private readonly config: HeaderConfig) {
+    this.downloadMeta()
+    this.configKeys = Object.keys(this.config)
+    this.maxKeyLength =
+      Math.max(...this.configKeys.map((key) => key.length)) + 1
   }
 
-  const addMetadata = (key: string, value: string | number | boolean): void => {
+  private downloadMeta(): void {
+    const { name, homepage, updateURL, downloadURL } = this.config
+    if (homepage && !updateURL && !downloadURL) {
+      this.config.updateURL = new URL(`${name}.meta.js`, homepage).href
+      this.config.downloadURL = new URL(`${name}.user.js`, homepage).href
+    }
+  }
+
+  private addSpaces(str: string): string {
+    return ' '.repeat(this.maxKeyLength - str.length)
+  }
+
+  private addMetadata(key: string, value: string | number | boolean): void {
     const isBoolean = typeof value === 'boolean'
     if (isBoolean && !value) return
-    value = !isBoolean ? addSpaces(key) + value.toString() : ''
-    header.push(`// @${key}${value}`)
+    value = !isBoolean ? `${this.addSpaces(key)}${value}` : ''
+    this.header.push(`// @${key}${value}`)
   }
 
-  for (const [key, value] of Object.entries(config)) {
-    if (Array.isArray(value)) {
-      value.forEach((value) => addMetadata(key, value))
-    } else {
-      if (value === undefined) continue
-      addMetadata(key, value)
+  generate(): string {
+    for (const [key, value] of Object.entries(this.config)) {
+      if (Array.isArray(value)) {
+        value.forEach((value) => this.addMetadata(key, value))
+      } else {
+        if (value === undefined) continue
+        this.addMetadata(key, value)
+      }
     }
-  }
 
-  return [
-    '// ==UserScript==',
-    ...header,
-    '// ==/UserScript=='
-  ].join('\n')
+    return [
+      '// ==UserScript==',
+      ...this.header,
+      '// ==/UserScript=='
+    ].join('\n')
+  }
 }

src/index.ts

@@ -10,7 +10,7 @@ import serveHandler from 'serve-handler'
 import { PluginOption, ResolvedConfig, createLogger } from 'vite'
 import { server } from 'websocket'
 import type { connection } from 'websocket'
-import { banner } from './banner.js'
+import { Banner } from './banner.js'
 import { userConfig } from './config.js'
 import { grants, regexpScripts, regexpStyles } from './constants.js'
 import css from './css.js'
@@ -104,17 +104,19 @@ export default function UserscriptPlugin(
     },
     async writeBundle(_, bundle) {
       const { open, port } = config.server!
+      const userFilename = `${config.header.name}.user.js`
       const proxyFilename = `${config.header.name}.proxy.user.js`
+      const metaFilename = `${config.header.name}.meta.js`
 
       for (const [fileName] of Object.entries(bundle)) {
         if (regexpScripts.test(fileName)) {
           const rootDir = pluginConfig.root
           const outDir = pluginConfig.build.outDir
-          const userFilename = `${config.header.name}.user.js`
 
           const outPath = resolve(rootDir, outDir, fileName)
-          const proxyFilePath = resolve(rootDir, outDir, proxyFilename)
           const userFilePath = resolve(rootDir, outDir, userFilename)
+          const proxyFilePath = resolve(rootDir, outDir, proxyFilename)
+          const metaFilePath = resolve(rootDir, outDir, metaFilename)
           const hotReloadPath = resolve(
             dirname(fileURLToPath(import.meta.url)),
             `hot-reload-${config.header.name}.js`
@@ -141,14 +143,14 @@ export default function UserscriptPlugin(
               writeFileSync(hotReloadPath, hotReloadScript)
               writeFileSync(
                 proxyFilePath,
-                banner({
+                new Banner({
                   ...config.header,
                   require: [
                     ...config.header.require!,
                     'file://' + hotReloadPath,
                     'file://' + outPath
                   ]
-                })
+                }).generate()
               )
             }
 
@@ -165,8 +167,10 @@ export default function UserscriptPlugin(
                 : [...defineGrants(source), ...(config.header.grant ?? [])]
             )
 
+            const banner = new Banner(config.header).generate()
             writeFileSync(outPath, source)
-            writeFileSync(userFilePath, `${banner(config.header)}\n\n${source}`)
+            writeFileSync(userFilePath, `${banner}\n\n${source}`)
+            writeFileSync(metaFilePath, banner)
           } catch (err) {
             console.log(err)
           }