chore: add SubscriptionUrl customization for debugging

Author: piquark6046

builder/source/build.ts

@@ -12,14 +12,16 @@ import { CreateBanner } from './banner/index.js'
 export type BuildOptions = {
   Minify: boolean
   UseCache: boolean
-  BuildType: 'production' | 'development'
+  BuildType: 'production' | 'development',
+  SubscriptionUrl: string
 }
 
 export async function Build(OptionsParam?: BuildOptions): Promise<void> {
   const Options = await Zod.strictObject({
     Minify: Zod.boolean(),
     UseCache: Zod.boolean(),
-    BuildType: Zod.enum(['production', 'development'])
+    BuildType: Zod.enum(['production', 'development']),
+    SubscriptionUrl: Zod.string().transform(Value => new URL(Value)).default(new URL('https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js'))
   }).parseAsync(OptionsParam)
 
   let MatchingDomains: Set<string> = new Set<string>()
@@ -37,15 +39,20 @@ export async function Build(OptionsParam?: BuildOptions): Promise<void> {
       ConvertWildcardSuffixToRegexPattern(Domain).forEach(GeneratedPattern => MatchingDomains.add(GeneratedPattern))
     }
   }
+
+  let ProjectRoot = Process.cwd()
+  if (Process.cwd().endsWith('/builder')) {
+    ProjectRoot = Process.cwd() + '/..'
+  }
 
   const Banner = CreateBanner({
-    Version: (await PackageJson.load(Process.cwd())).content.version ?? '0.0.0',
+    Version: (await PackageJson.load(ProjectRoot)).content.version ?? '0.0.0',
     BuildType: Options.BuildType ?? 'production',
     Domains: MatchingDomains,
     Name: 'tinyShield',
     Namespace: 'https://github.com/FilteringDev/tinyShield',
-    DownloadURL: new URL('https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js'),
-    UpdateURL: new URL('https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js'),
+    DownloadURL: Options.SubscriptionUrl,
+    UpdateURL: Options.SubscriptionUrl,
     HomepageURL: new URL('https://github.com/FilteringDev/tinyShield'),
     SupportURL: new URL('https://github.com/FilteringDev/tinyShield/issues'),
     License: 'MPL-2.0',
@@ -57,10 +64,6 @@ export async function Build(OptionsParam?: BuildOptions): Promise<void> {
     }
   })
 
-  let ProjectRoot = Process.cwd()
-  if (Process.cwd().endsWith('/builder')) {
-    ProjectRoot = Process.cwd() + '/..'
-  }
   await ESBuild.build({
     entryPoints: [ProjectRoot + '/userscript/source/index.ts'],
     bundle: true,

builder/source/buildci.ts

@@ -7,7 +7,8 @@ let ParsedArgv = (await PostProcessing<BuildOptions>(PreProcessing(Process.argv)
 let Options = await Zod.strictObject({
   Minify: Zod.string().pipe(Zod.enum(['true', 'false'])).transform(Value => Value === 'true').default(true),
   UseCache: Zod.string().pipe(Zod.enum(['true', 'false'])).transform(Value => Value === 'true').default(true),
-  BuildType: Zod.enum(['production', 'development'])
+  BuildType: Zod.enum(['production', 'development']),
+  SubscriptionUrl: Zod.string()
 }).parseAsync(ParsedArgv)
 
 await Build(Options)

builder/source/debug.ts

@@ -5,18 +5,21 @@ import * as Crypto from 'node:crypto'
 import { RunDebugServer } from './utils/http-server.js'
 import { Build } from './build.js'
 
-const ProcessCwd = Process.cwd()
+let ProjectRoot = Process.cwd()
+if (Process.cwd().endsWith('/builder')) {
+  ProjectRoot = Process.cwd().replaceAll(/\/builder$/g, '')
+}
 const WatchingGlob = [];
 ['builder/', 'userscript/', ''].forEach(Dir => {
-  WatchingGlob.push(`${ProcessCwd}/${Dir}sources/**/*.ts`)
-  WatchingGlob.push(`${ProcessCwd}/${Dir}sources/**/*.json`)
-  WatchingGlob.push(`${ProcessCwd}/${Dir}sources/**/*.txt`)
+  WatchingGlob.push(`${ProjectRoot}/${Dir}sources/**/*.ts`)
+  WatchingGlob.push(`${ProjectRoot}/${Dir}sources/**/*.json`)
+  WatchingGlob.push(`${ProjectRoot}/${Dir}sources/**/*.txt`)
 })
 const Watcher = Chokidar.watch([
-  `${ProcessCwd}/sources/**/*.ts`,
-  `${ProcessCwd}/sources/**/*.json`
+  `${ProjectRoot}/sources/**/*.ts`,
+  `${ProjectRoot}/sources/**/*.json`
 ], {
-  cwd: ProcessCwd,
+  cwd: ProjectRoot,
   ignored: '**/node_modules/**',
 })
 
@@ -27,11 +30,12 @@ Watcher.on('all', (WatcherEvent, WatcherPath) => {
   BuildCooldownTimer = setTimeout(async () => {
     console.log(`Detected file change (${WatcherEvent}):`, WatcherPath)
     ShouldPreventHTTPResponse = true
-    await Build({ Minify: false, UseCache: true, BuildType: 'development' })
+    await Build({ Minify: false, UseCache: true, BuildType: 'development', SubscriptionUrl: `http://localhost:${RandomPort}/tinyShield.dev.user.js` })
     ShouldPreventHTTPResponse = false
   }, 1500)
 })
 
 let RandomPort = Crypto.randomInt(8000, 8999)
+await Build({ Minify: false, UseCache: true, BuildType: 'development', SubscriptionUrl: `http://localhost:${RandomPort}/tinyShield.dev.user.js` })
 RunDebugServer(RandomPort, ['tinyShield.dev.user.js'], ShouldPreventHTTPResponse)
 console.log(`Debug HTTP server running on http://localhost:${RandomPort}/tinyShield.dev.user.js`)

package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "build:interface": "esbuild userscript/source/interface.ts --bundle --format=esm --splitting --sourcemap --target=es2024 --external:/node_modules --outdir=dist && tsc userscript/source/interface.ts --outDir dist/types --declaration --emitDeclarationOnly --skipLibCheck",
-    "build:userscript": "npm run build -w builder -- --minify true --use-cache false --build-type production",
+    "build:userscript": "npm run build -w builder -- --minify true --use-cache false --build-type production --SubscriptionUrl https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js",
     "build": "npm run build:interface && npm run build:userscript",
     "debug": "npm run debug -w builder",
     "lint": "npm run lint -w builder && npm run lint -w userscript"