feat: Support scriptcat background script

packages/vite-plugin-monkey/src/node/index.ts

@@ -1,4 +1,4 @@
-import type { Plugin } from 'vite';
+import type { Plugin, UserConfig } from 'vite';
 import { resolvedOption } from './option';
 import monkeyPluginList from './plugins';
 import type { MonkeyOption } from './types';
@@ -30,7 +30,7 @@ export default (pluginOption: MonkeyOption): Plugin[] => {
     async config(userConfig, { command }) {
       const isServe = command == 'serve';
 
-      return {
+      const ret: UserConfig = {
         resolve: {
           alias: {
             [finalPluginOption.clientAlias]: 'vite-plugin-monkey/dist/client',
@@ -56,16 +56,33 @@ export default (pluginOption: MonkeyOption): Plugin[] => {
           cssCodeSplit: false,
           minify: userConfig.build?.minify ?? false,
           cssMinify: userConfig.build?.cssMinify ?? true,
-          rollupOptions: {
-            // serve pre-bundling need
-            input: finalPluginOption.entry,
-          },
+
           sourcemap: false,
 
           // TODO
           // sourcemap: sourcemap,
         },
       };
+
+      // background or crontab script use lib
+      if (
+        finalPluginOption.userscript.background ||
+        finalPluginOption.userscript.crontab
+      ) {
+        ret.build!.lib = {
+          entry: finalPluginOption.entry,
+          name: 'monkey',
+          formats: ['umd'],
+          fileName: 'monkey.user.js',
+        };
+      } else {
+        ret.build!.rollupOptions = {
+          // serve pre-bundling need
+          input: finalPluginOption.entry,
+        };
+      }
+
+      return ret;
     },
   };
 

packages/vite-plugin-monkey/src/node/option.ts

@@ -209,6 +209,8 @@ export const resolvedOption = (
     compatible,
     sandbox,
     unwrap = false,
+    background,
+    crontab,
   } = pluginOption.userscript ?? {};
 
   const { fileName = projectPkg.name + '.user.js' } = build;
@@ -281,6 +283,8 @@ export const resolvedOption = (
       sandbox,
       unwrap,
       webRequest: webRequest.map((w) => JSON.stringify(w)),
+      background,
+      crontab,
     },
     clientAlias: pluginOption.clientAlias ?? '$',
     entry: pluginOption.entry,

packages/vite-plugin-monkey/src/node/plugins/finalBundle.ts

@@ -1,4 +1,4 @@
-import type { OutputChunk, RollupOutput } from 'rollup';
+import type { OutputChunk, RollupOutput, OutputAsset } from 'rollup';
 import { Plugin, build } from 'vite';
 import { lazyValue } from '../_lazy';
 import {
@@ -57,91 +57,100 @@ export const finalBundlePlugin = (finalOption: FinalMonkeyOption): Plugin => {
 
       const tlaIdentifier = lazyValue(() => findSafeTlaIdentifier(rawBundle));
 
-      const buildResult = (await build({
-        logLevel: 'error',
-        configFile: false,
-        esbuild: false,
-        plugins: [
-          {
-            name: 'mokey:mock',
-            enforce: 'pre',
-            resolveId(source, importer, options) {
-              if (!importer && options.isEntry) {
-                return '\0' + source;
-              }
-              const chunk = Object.values(rawBundle).find(
-                (chunk) =>
-                  chunk.type == 'chunk' && source.endsWith(chunk.fileName),
-              ) as OutputChunk | undefined;
-              if (chunk) {
-                return '\0' + source;
-              }
-            },
-            async load(id) {
-              if (!id.startsWith('\0')) return;
+      const bgScript =
+        finalOption.userscript.background || finalOption.userscript.crontab;
+      let buildBundle: (OutputChunk | OutputAsset)[];
+      if (bgScript) {
+        buildBundle = [fristEntryChunk!];
+      } else {
+        const buildResult = (await build({
+          logLevel: 'error',
+          configFile: false,
+          esbuild: false,
+          plugins: [
+            {
+              name: 'mokey:mock',
+              enforce: 'pre',
+              resolveId(source, importer, options) {
+                if (!importer && options.isEntry) {
+                  return '\0' + source;
+                }
+                const chunk = Object.values(rawBundle).find(
+                  (chunk) =>
+                    chunk.type == 'chunk' && source.endsWith(chunk.fileName),
+                ) as OutputChunk | undefined;
+                if (chunk) {
+                  return '\0' + source;
+                }
+              },
+              async load(id) {
+                if (!id.startsWith('\0')) return;
 
-              if (id.endsWith(__entry_name)) {
-                return entryChunks
-                  .map((a) => `import ${JSON.stringify(`./${a.fileName}`)};`)
-                  .join('\n');
-              }
-              const [k, chunk] =
-                Object.entries(rawBundle).find(([k, chunk]) =>
-                  id.endsWith(chunk.fileName),
-                ) ?? [];
-              if (chunk && chunk.type == 'chunk' && k) {
-                usedModules.add(k);
-                if (!hasDynamicImport) {
-                  const ch = transformTlaToIdentifier(
-                    this,
-                    chunk,
-                    tlaIdentifier.value,
-                  );
-                  if (ch) return ch;
+                if (id.endsWith(__entry_name)) {
+                  return entryChunks
+                    .map((a) => `import ${JSON.stringify(`./${a.fileName}`)};`)
+                    .join('\n');
                 }
-                return {
-                  code: chunk.code,
-                  map: chunk.map,
-                };
-              }
-            },
-            generateBundle(_, iifeBundle) {
-              if (hasDynamicImport) {
-                return;
-              }
-              Object.entries(iifeBundle).forEach(([k, chunk]) => {
-                transformIdentifierToTla(this, chunk, tlaIdentifier.value);
-              });
+                const [k, chunk] =
+                  Object.entries(rawBundle).find(([k, chunk]) =>
+                    id.endsWith(chunk.fileName),
+                  ) ?? [];
+                if (chunk && chunk.type == 'chunk' && k) {
+                  usedModules.add(k);
+                  if (!hasDynamicImport) {
+                    const ch = transformTlaToIdentifier(
+                      this,
+                      chunk,
+                      tlaIdentifier.value,
+                    );
+                    if (ch) return ch;
+                  }
+                  return {
+                    code: chunk.code,
+                    map: chunk.map,
+                  };
+                }
+              },
+              generateBundle(_, iifeBundle) {
+                if (hasDynamicImport) {
+                  return;
+                }
+                Object.entries(iifeBundle).forEach(([k, chunk]) => {
+                  transformIdentifierToTla(this, chunk, tlaIdentifier.value);
+                });
+              },
             },
-          },
-        ],
-        build: {
-          write: false,
-          minify: false,
-          target: 'esnext',
-          rollupOptions: {
-            external(source) {
-              return source in finalOption.globalsPkg2VarName;
+          ],
+          build: {
+            write: false,
+            minify: false,
+            target: 'esnext',
+            rollupOptions: {
+              external(source) {
+                return source in finalOption.globalsPkg2VarName;
+              },
+              output: {
+                globals: finalOption.globalsPkg2VarName,
+              },
             },
-            output: {
-              globals: finalOption.globalsPkg2VarName,
+            lib: {
+              entry: __entry_name,
+              formats: bgScript
+                ? undefined
+                : ([hasDynamicImport ? 'system' : 'iife'] as any),
+              name: hasDynamicImport ? undefined : '__expose__',
+              fileName: () => `__entry.js`,
             },
           },
-          lib: {
-            entry: __entry_name,
-            formats: [hasDynamicImport ? 'system' : 'iife'] as any,
-            name: hasDynamicImport ? undefined : '__expose__',
-            fileName: () => `__entry.js`,
-          },
-        },
-      })) as RollupOutput[];
-      usedModules.forEach((k) => {
-        if (fristEntryChunk != rawBundle[k]) {
-          delete rawBundle[k];
-        }
-      });
+        })) as RollupOutput[];
+        usedModules.forEach((k) => {
+          if (fristEntryChunk != rawBundle[k]) {
+            delete rawBundle[k];
+          }
+        });
+        buildBundle = buildResult[0].output.flat();
+      }
 
-      const buildBundle = buildResult[0].output.flat();
       let finalJsCode = ``;
       if (hasDynamicImport) {
         const systemJsModules: string[] = [];
@@ -225,6 +234,10 @@ export const finalBundlePlugin = (finalOption: FinalMonkeyOption): Plugin => {
         'build',
       );
 
+      if (bgScript) {
+        finalJsCode += `\nreturn window.monkey;`;
+      }
+
       const mergedCode = [comment, injectCssCode, finalJsCode]
         .filter((s) => s)
         .join(`\n\n`)

packages/vite-plugin-monkey/src/node/userscript/index.ts

@@ -6,6 +6,7 @@ import type {
   GreaseRunAt,
 } from './greasemonkey';
 import { GreaseGrantValueList } from './greasemonkey';
+import { ScriptcatUserScript } from './scriptcat';
 import type {
   AntifeatureType,
   TamperGrant,
@@ -24,6 +25,7 @@ export type {
   GreasemonkeyUserScript,
   TampermonkeyUserScript,
   ViolentmonkeyUserScript,
+  ScriptcatUserScript,
   Format,
 };
 
@@ -144,6 +146,7 @@ export type MonkeyUserScript = GreasemonkeyUserScript &
   TampermonkeyUserScript &
   ViolentmonkeyUserScript &
   GreasyforkUserScript &
+  ScriptcatUserScript &
   MergemonkeyUserScript;
 
 export type FinalUserScript = {
@@ -183,6 +186,10 @@ export type FinalUserScript = {
   'run-at'?: GreaseRunAt | TamperRunAt | ViolentRunAt;
   grant: Set<string>;
   $extra: [string, ...string[]][];
+
+  // scriptcat backgroud script
+  background?: boolean;
+  crontab?: string;
 } & GreasyforkUserScript;
 
 export const finalMonkeyOptionToComment = async (
@@ -244,6 +251,9 @@ export const finalMonkeyOptionToComment = async (
     unwrap,
     webRequest,
     $extra,
+
+    background,
+    crontab,
   } = userscript;
   Object.entries({
     namespace,
@@ -352,6 +362,14 @@ export const finalMonkeyOptionToComment = async (
 
   attrList = defaultSortFormat(attrList);
 
+  if (background) {
+    attrList.push(['background']);
+  }
+
+  if (crontab) {
+    attrList.push(['crontab', crontab]);
+  }
+
   let { align = 2 } = format;
 
   if (align === true) {