feat: 支持用户自定义 emoji 替换规则

surgioproject · Sep 12, 2020 · bce9ec5 · bce9ec5
1 parent 7b363d6
commit bce9ec5
Show file tree

Hide file tree

Showing 9 changed files with 122 additions and 12 deletions.
diff --git a/lib/types.ts b/lib/types.ts
@@ -46,6 +46,9 @@ export interface CommandConfig {
     readonly v2ray?: string;
     vmess?: string;
   };
+  readonly flags?: {
+    [name: string]: ReadonlyArray<string|RegExp>|string|RegExp;
+  },
   readonly surgeConfig?: {
     readonly shadowsocksFormat?: 'ss'|'custom';
     readonly v2ray?: 'native'|'external';

diff --git a/lib/utils/config.ts b/lib/utils/config.ts
@@ -8,6 +8,7 @@ import { DEP005, DEP006 } from '../misc/deprecation';
 
 import { CommandConfig } from '../types';
 import { PROXY_TEST_INTERVAL, PROXY_TEST_URL } from './constant';
+import { addFlagMap } from './flag';
 import { ensureConfigFolder } from './index';
 
 const showDEP005 = deprecate(_.noop, DEP005, 'DEP005');
@@ -24,6 +25,22 @@ export const loadConfig = (cwd: string, configPath: string, override?: Partial<C
 
   validateConfig(userConfig);
 
+  if (userConfig.flags) {
+    Object.keys(userConfig.flags).forEach(emoji => {
+      if (userConfig.flags) {
+        if (typeof userConfig.flags[emoji] === 'string') {
+          addFlagMap(userConfig.flags[emoji] as string, emoji);
+        } else if (_.isRegExp(userConfig.flags[emoji])) {
+          addFlagMap(userConfig.flags[emoji] as RegExp, emoji);
+        } else {
+          (userConfig.flags[emoji] as ReadonlyArray<string|RegExp>).forEach(name => {
+            addFlagMap(name, emoji);
+          });
+        }
+      }
+    });
+  }
+
   if (override) {
     return {
       ...normalizeConfig(cwd, userConfig),
@@ -127,6 +144,19 @@ export const validateConfig = (userConfig: Partial<CommandConfig>): void => {
       v2ray: Joi.string().pattern(/^\//),
       vmess: Joi.string().pattern(/^\//),
     }),
+    flags: Joi
+      .object()
+      .pattern(
+        Joi.string(),
+        [
+          Joi.string(),
+          Joi.object().regex(),
+          Joi.array().items(
+            Joi.string(),
+            Joi.object().regex(),
+          )
+        ]
+      ),
     surgeConfig: Joi.object({
       shadowsocksFormat: Joi.string().valid('ss', 'custom'),
       v2ray: Joi.string().valid('native', 'external'),

diff --git a/lib/utils/flag.ts b/lib/utils/flag.ts
@@ -1,4 +1,6 @@
-import EmojiRegex from 'emoji-regex'
+import EmojiRegex from 'emoji-regex';
+import _ from 'lodash';
+
 import flag from '../misc/flag_cn';
 
 const flagMap: Map<string|RegExp, string> = new Map();
@@ -28,12 +30,12 @@ export const prependFlag = (str: string, removeExistingEmoji = false): string =>
   }
 
   for (const [key, value] of flagMap.entries()) {
-    if (typeof key === 'string') {
-      if (str.toUpperCase().includes(key)) {
+    if (_.isRegExp(key)) {
+      if (key.test(str)) {
         return `${value} ${str}`;
       }
     } else {
-      if (key.test(str)) {
+      if (str.toUpperCase().includes(key)) {
         return `${value} ${str}`;
       }
     }

diff --git a/test/cli.test.ts b/test/cli.test.ts
@@ -18,13 +18,17 @@ test.serial('doctor command', async t => {
   });
 });
 
-test.serial('cli works', async t => {
-  await coffee.fork(cli, ['generate', '-h'], {
-    cwd: resolve('plain'),
-  })
-    .expect('code', 0)
-    .end();
+test.serial('help command', async t => {
+  await t.notThrowsAsync(async () => {
+    await coffee.fork(cli, ['generate', '-h'], {
+      cwd: resolve('plain'),
+    })
+      .expect('code', 0)
+      .end();
+  });
+});
 
+test.serial.only('cli works', async t => {
   await coffee.fork(cli, ['generate'], {
     cwd: resolve('plain'),
     execArgv: ['--require', require.resolve('./stub-axios.js')],

diff --git a/test/fixture/plain/provider/custom.js b/test/fixture/plain/provider/custom.js
@@ -41,7 +41,21 @@ module.exports = {
       hostname: 'trojan.example.com',
       port: '443',
       password: 'password',
-    }
+    },
+    {
+      type: 'trojan',
+      nodeName: '火箭 trojan node',
+      hostname: 'trojan.example.com',
+      port: '443',
+      password: 'password',
+    },
+    {
+      type: 'trojan',
+      nodeName: 'foobar trojan node',
+      hostname: 'trojan.example.com',
+      port: '443',
+      password: 'password',
+    },
   ],
   renameNode: name => {
     if (name === 'rename to HTTPS') {

diff --git a/test/fixture/plain/surgio.conf.js b/test/fixture/plain/surgio.conf.js
@@ -80,6 +80,10 @@ module.exports = {
     shadowsocksr: '/usr/local/bin/ssr-local',
     v2ray: '/usr/local/bin/v2ray',
   },
+  flags: {
+    '🚀': '火箭',
+    '🎉': [/foobar/i],
+  },
   gateway: {
     accessToken: 'abcd',
   },

diff --git a/test/snapshots/cli.test.ts.md b/test/snapshots/cli.test.ts.md
@@ -705,3 +705,51 @@ Generated by [AVA](https://avajs.dev).
     DOMAIN,example.com,Proxy␊
     ␊
     `
+
+## cli works
+
+> Snapshot 3
+
+    `getSurgeNodes␊
+    测试 1 = vmess, 1.1.1.1, 8080, username=1386f85e-657b-4d6e-9d56-78badb75e1fd, ws=true, ws-path=/, ws-headers="host:example.com|user-agent:Mozilla/5.0 (iPhone; CPU iPhone OS 13_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1"␊
+    测试 2 = vmess, 1.1.1.1, 8080, username=1386f85e-657b-4d6e-9d56-78badb75e1fd␊
+    测试 tls = vmess, example.com, 443, username=1386f85e-657b-4d6e-9d56-78badb75e1fd, ws=true, ws-path=/, ws-headers="host:example.com|user-agent:Mozilla/5.0 (iPhone; CPU iPhone OS 13_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1", tls=true, tls13=false, skip-cert-verify=false, sni=example.com␊
+    ----␊
+    getNodeNames␊
+    测试 1, 测试 2, 测试 tls␊
+    ----␊
+    getQuantumultXNodes␊
+    vmess=1.1.1.1:8080, method=chacha20-ietf-poly1305, password=1386f85e-657b-4d6e-9d56-78badb75e1fd, obfs=ws, obfs-uri=/, obfs-host=example.com, tag=测试 1␊
+    vmess=1.1.1.1:8080, method=chacha20-ietf-poly1305, password=1386f85e-657b-4d6e-9d56-78badb75e1fd, tag=测试 2␊
+    vmess=example.com:443, method=chacha20-ietf-poly1305, password=1386f85e-657b-4d6e-9d56-78badb75e1fd, obfs=wss, obfs-uri=/, obfs-host=example.com, tag=测试 tls␊
+    ----␊
+    getSurgeNodes␊
+    ␊
+    ----␊
+    getMellowNodes␊
+    测试 1, vmess1, vmess1://1386f85e-657b-4d6e-9d56-78badb75e1fd@1.1.1.1:8080/?network=ws&tls=false&ws.host=example.com␊
+    测试 2, vmess1, vmess1://1386f85e-657b-4d6e-9d56-78badb75e1fd@1.1.1.1:8080/?network=tcp&tls=false␊
+    测试 tls, vmess1, vmess1://1386f85e-657b-4d6e-9d56-78badb75e1fd@example.com:443/?network=ws&tls=true&ws.host=example.com␊
+    ----␊
+    clashProxyConfig␊
+    ␊
+    ␊
+    ----␊
+    proxyTestUrl␊
+    http://www.google.com/generate_204␊
+    ----␊
+    downloadUrl␊
+    https://example.com/v2rayn.conf?access_token=abcd␊
+    ---␊
+    foo␊
+    ---␊
+    bar␊
+    ---␊
+    value␊
+    ---␊
+    DOMAIN,example.com,Proxy␊
+    ␊
+    ---␊
+    DOMAIN,example.com,Proxy␊
+    ␊
+    `
diff --git a/test/snapshots/cli.test.ts.snap b/test/snapshots/cli.test.ts.snap
diff --git a/test/utils/flag.test.ts b/test/utils/flag.test.ts
@@ -1,5 +1,9 @@
 import test from 'ava';
-import { prependFlag, removeFlag } from '../../lib/utils/flag';
+import { addFlagMap, prependFlag, removeFlag } from '../../lib/utils/flag';
+
+test.before(() => {
+  addFlagMap(/foobar/i, '🚀');
+});
 
 test('addFlag', t => {
   t.is(prependFlag('美国'), '🇺🇸 美国');
@@ -13,6 +17,7 @@ test('addFlag', t => {
   t.is(prependFlag('🇺🇸 jp', true), '🇯🇵 jp');
   t.is(prependFlag('🇯🇵 🇺🇸 jp', true), '🇯🇵 jp');
   t.is(prependFlag('🇺🇸 🇯🇵 US', true), '🇺🇸 US');
+  t.is(prependFlag('foobar 节点'), '🚀 foobar 节点');
 });
 
 test('removeFlag', t => {