feat: quantumultx plugin

.npmrc

@@ -1,2 +1,3 @@
 registry=https://registry.npmjs.org/
-link-workspace-packages=true
+link-workspace-packages=true
+enable-pre-post-scripts=true

packages/modkit/plugins/quantumultx/modern.config.ts

@@ -0,0 +1,13 @@
+import fs from 'node:fs';
+import { dualBuildConfigs } from '@iringo/modkit-config/modern.config.ts';
+import { defineConfig, moduleTools } from '@modern-js/module-tools';
+
+export default defineConfig({
+  plugins: [moduleTools()],
+  buildConfig: dualBuildConfigs.map((item) => ({
+    ...item,
+    define: {
+      'process.env.TEMP': fs.readFileSync('./template.ejs', 'utf-8'),
+    },
+  })),
+});

packages/modkit/plugins/quantumultx/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@iringo/modkit-plugin-quantumultx",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "modern build -w",
+    "build": "modern build"
+  },
+  "files": ["dist", "types", "CHANGELOG.md"],
+  "dependencies": {
+    "@iringo/modkit-shared": "workspace:^"
+  },
+  "devDependencies": {
+    "@iringo/modkit-config": "workspace:^",
+    "@modern-js/module-tools": "^2.60.2",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.6.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NSRingo/engineering-solutions",
+    "directory": "packages/modkit/apps/quantumultx"
+  }
+}

packages/modkit/plugins/quantumultx/src/index.ts

@@ -0,0 +1,45 @@
+import type { ModkitPlugin } from '@iringo/modkit-shared';
+import { QuantumultxTemplate } from './template';
+
+export interface QuantumultxPluginOptions {
+  objectValuesHandler?: (obj: Record<string, any>) => string;
+}
+
+export const pluginQuantumultx = ({
+  objectValuesHandler = (obj) => {
+    if (Array.isArray(obj)) {
+      return `"${obj.join()}"`;
+    }
+    return `"${JSON.stringify(obj)}"`;
+  },
+}: QuantumultxPluginOptions = {}): ModkitPlugin => {
+  return {
+    name: 'quantumultx',
+    setup() {
+      return {
+        configurePlatform() {
+          return {
+            extension: '.snippet',
+            template: process.env.TEMP || '',
+          };
+        },
+        modifySource({ source }) {
+          source ??= {};
+          source.arguments = source.arguments?.filter((item) => {
+            if (typeof item.type === 'object' && item.type.quantumultx === 'exclude') {
+              return false;
+            }
+            return true;
+          });
+          return source;
+        },
+        templateParameters(params) {
+          const quantumultxTemplate = new QuantumultxTemplate(params, objectValuesHandler);
+          return {
+            quantumultxTemplate,
+          };
+        },
+      };
+    },
+  };
+};

packages/modkit/plugins/quantumultx/src/template.ts

@@ -0,0 +1,124 @@
+import { Template, logger, objectEntries, toKebabCase } from '@iringo/modkit-shared';
+
+export class QuantumultxTemplate extends Template {
+  get Metadata() {
+    const result: Record<string, string | undefined> = {};
+    result.name = this.metadata.name;
+    result.desc = this.metadata.description;
+    result.system = this.metadata.system?.join();
+    result.version = this.metadata.version;
+    Object.entries(this.metadata.extra || {}).forEach(([key, value]) => {
+      result[key] = Array.isArray(value) ? value.join(',') : value;
+    });
+    return this.renderKeyValuePairs(result, { prefix: '#!' });
+  }
+
+  get Rule() {
+    return this.content.rule
+      ?.map((rule) => {
+        if (typeof rule === 'string') {
+          return rule;
+        }
+        switch (rule.type) {
+          case 'RULE-SET': {
+            let result = `RULE-SET, ${this.utils.getFilePath(rule.assetKey)}`;
+            if (rule.policyName) {
+              result += `, ${rule.policyName}`;
+            }
+            return result;
+          }
+          default:
+            break;
+        }
+      })
+      .join('\n')
+      .trim();
+  }
+  get Rewrite() {
+    const urlRewrites: string[] = [];
+    const headerRewrites: string[] = [];
+    const bodyRewrites: string[] = [];
+    this.content.rewrite?.forEach((rewrite) => {
+      switch (rewrite.mode) {
+        case 'header':
+        case 302:
+        case 'reject': {
+          const options = [];
+          options.push(rewrite.pattern);
+          options.push(rewrite.content);
+          options.push(rewrite.mode);
+          urlRewrites.push(options.join(' '));
+          break;
+        }
+        case 'header-add':
+        case 'header-del':
+        case 'header-replace-regex': {
+          const options = [];
+          options.push(rewrite.type);
+          options.push(rewrite.pattern);
+          options.push(rewrite.mode);
+          options.push(rewrite.content);
+          headerRewrites.push(options.join(' '));
+          break;
+        }
+        case undefined: {
+          const options = [];
+          options.push(rewrite.type);
+          options.push(rewrite.pattern);
+          options.push(rewrite.content);
+          bodyRewrites.push(options.join(' '));
+          break;
+        }
+      }
+    });
+    return {
+      url: urlRewrites.join('\n').trim(),
+      header: headerRewrites.join('\n').trim(),
+      body: bodyRewrites.join('\n').trim(),
+    };
+  }
+
+  get Script() {
+    return this.content.script
+      ?.map((script, index) => {
+        let line = '';
+        const { type, pattern, cronexp, scriptKey, argument, injectArgument, name, ...rest } = script;
+        switch (type) {
+          case 'http-request':
+          case 'http-response':
+            line += `${type} ${pattern} `;
+            break;
+          case 'cron':
+            line += `${type} "${cronexp}" `;
+            break;
+          case 'generic':
+            line += `${type} `;
+            break;
+          // case 'network-changed':
+          case 'event':
+            line += 'network-changed ';
+            break;
+          case 'dns':
+            logger.warn('[Loon] Unsupported script type: dns');
+            break;
+        }
+        const parameters: Record<string, any> = {};
+        parameters['script-path'] = this.utils.getScriptPath(scriptKey);
+        parameters.tag = name || `Script${index}`;
+        objectEntries(rest).forEach(([key, value]) => {
+          parameters[toKebabCase(key)] = value;
+        });
+        if (injectArgument || argument) {
+          parameters.argument = argument || `[${this.source.arguments?.map((item) => `{${item.key}}`).join(',')}]`;
+        }
+        line += this.renderKeyValuePairs(parameters, { join: ', ', separator: '=' });
+        return line;
+      })
+      .join('\n')
+      .trim();
+  }
+
+  get MITM() {
+    return this.content.mitm?.hostname?.join(', ');
+  }
+}

packages/modkit/plugins/quantumultx/template.ejs

@@ -0,0 +1,26 @@
+<%= quantumultxTemplate.Metadata %>
+
+<% if (quantumultxTemplate.Host) { %>
+#[dns]
+<%= quantumultxTemplate.Host %>
+<% } %>
+
+<% if (quantumultxTemplate.Rule) { %>
+#[filter_local]
+<%= quantumultxTemplate.Rule %>
+<% } %>
+
+<% if (quantumultxTemplate.Rewrite) { %>
+#[rewrite_local]
+<%= quantumultxTemplate.Rewrite %>
+<% } %>
+
+<% if (quantumultxTemplate.Script) { %>
+#[rewrite_local]
+<%= quantumultxTemplate.Script %>
+<% } %>
+
+<% if (quantumultxTemplate.MITM) { %>
+#[mitm]
+<%= quantumultxTemplate.MITM %>
+<% } %>

packages/modkit/plugins/quantumultx/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@iringo/modkit-config/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "baseUrl": "./"
+  },
+  "include": ["src", "types"]
+}