lack 1.3.17 → 1.4.0

package/README-en_US.md

@@ -0,0 +1,55 @@
+# lack
+[![NPM version](https://img.shields.io/npm/v/lack.svg?style=flat-square)](https://npmjs.org/package/lack)
+[![node version](https://img.shields.io/badge/node.js-%3E=_8-green.svg?style=flat-square)](http://nodejs.org/download/)
+[![npm download](https://img.shields.io/npm/dm/lack.svg?style=flat-square)](https://npmjs.org/package/lack)
+[![NPM count](https://img.shields.io/npm/dt/lack.svg?style=flat-square)](https://www.npmjs.com/package/lack)
+[![License](https://img.shields.io/npm/l/lack.svg?style=flat-square)](https://www.npmjs.com/package/lack)
+
+[中文](./README.md) · English
+
+A scaffolding tool for rapid [Whistle](https://github.com/avwo/whistle) plugin development.
+
+### Installation
+```sh
+npm i -g lack
+```
+
+### Usage
+1. Create plugin directory
+    ```sh
+    mkdir whistle.your-plugin-name
+    cd whistle.your-plugin-name
+    ```
+    > Note: Plugin name must follow `whistle.xxx` or `@scope/whistle.xxx` format where `xxx` can only contain `a-z`, `0-9`, `-` and `_` (underscore not recommended)
+
+2. Initialize project
+   - Interactive mode: `lack init`
+      > Prompts to select required plugin hooks (multiple selection supported)
+   - Quick command (`lack init hook1,hook2...`): [Plugin Development](https://wproxy.org/docs/extensions/dev.html)
+
+3. Install dependencies
+    ```sh
+    npm i
+    ```
+
+4. [Optional] Code style setup
+    ```sh
+    npx install-peerdeps --dev eslint-config-airbnb
+    ```
+    > Configuration reference: https://www.npmjs.com/package/eslint-config-airbnb
+
+5. Development mode
+    ```sh
+    lack watch
+    ```
+    Features:
+    - Auto-reloads plugin into running Whistle instance
+    - Automatically reloads on code changes
+    - Displays plugin `console.xxx` output in terminal
+
+6. View help
+    ```sh
+    lack --help
+    ```
+
+Complete development guide: [Plugin Development](https://wproxy.org/docs/extensions/dev.html)

package/README.md

@@ -5,7 +5,9 @@
 [![NPM count](https://img.shields.io/npm/dt/lack.svg?style=flat-square)](https://www.npmjs.com/package/lack)
 [![License](https://img.shields.io/npm/l/lack.svg?style=flat-square)](https://www.npmjs.com/package/lack)
 
-生成 [whistle](https://github.com/avwo/whistle) 插件的脚手架。
+中文 · [English](./README-en_US.md)
+
+用于快速生成 [Whistle](https://github.com/avwo/whistle) 插件的脚手架工具。
 
 ### 安装
 ``` sh
@@ -13,25 +15,36 @@ npm i -g lack
 ```
 
 ### 使用
-严格按以下步骤操作：
-1. 新建插件目录 `whistle.xxx`（如果已存在忽略此步骤）
-    > xxx 表示只包含 `a-z\d_-` 的任意字符串，具体参见帮助文档：[插件开发](https://wproxy.org/whistle/plugins.html)
-2. 进入插件目录，执行 `lack init` 后根据需要选择插件的钩子
-    > 有关插件钩子的功能参见帮助文档：[插件开发](https://wproxy.org/whistle/plugins.html)
-3. 选择好插件所需钩子并确定后，如果需要修改或新增钩子，可以删除已存在的钩子，并执行上面步骤2
-4. 【可选】配置eslint规则，参考：[eslint-config-imweb](https://github.com/imweb/eslint-config-imweb)
-5. 安装依赖 `npm i`
-6. 执行 `npm link` 将插件link到全局，这样可以在 whistle 界面的 Plugins 列表看到此插件
-7. 开启 whistle 调试模式
+1. 创建插件目录
+    ``` sh
+    mkdir whistle.your-plugin-name
+    cd whistle.your-plugin-name
+    ```
+    > 注意：插件名必须符合 `whistle.xxx` 或 `@scope/whistle.xxx` 格式，其中 `xxx` 只能包含 `a-z`、`0-9`、`-` 和 `_`（下划线不推荐使用）
+2. 初始化项目
+   - 手动选择：`lack init`
+      > 该命令会交互式询问你需要哪些插件钩子（支持多选），按需选择即可
+   - 快捷命令（`lack init hook1,hook2...`）：[插件开发](https://wproxy.org/docs/extensions/dev.html)
+3. 安装依赖
+      ``` sh
+      npm i
+      ```
+4. 【可选】代码规范配置
     ``` sh
-    w2 stop
-    w2 run
+    npx install-peerdeps --dev eslint-config-airbnb
     ```
-    > 这样可以在控制台里面看到插件 `console.log` 输出的内容
-8. 开启监听插件变更自动重启：
-    ```sh
+    > 详细配置参考：https://www.npmjs.com/package/eslint-config-airbnb
+5. 开发模式
+    ``` sh
     lack watch
     ```
-9. 更多帮助执行 `lack --help`
+    该命令的功能：
+    - 自动重新加载插件到运行的 Whistle 实例
+    - 插件代码变更时会自动重新加载
+    - 可以在命令行查看插件 `console.xxx` 输出的日志
+6. 查看帮助
+    ``` sh
+    lack --help
+    ```
 
-更多信息参考插件示例：[https://github.com/whistle-plugins/examples](https://github.com/whistle-plugins/examples)
+完整插件开发流程参考文档：[插件开发](https://wproxy.org/docs/extensions/dev.html)

package/assets/js/lib/auth.js

@@ -1,5 +1,38 @@
-
 module.exports = async (req, options) => {
+  /**
+  const { fullUrl } = req;
+  // Returns 403 Forbidden status code if URL contains '/test/forbidden'
+  if (fullUrl.includes('/test/forbidden')) {
+    return false;
+  }
+  // Returns 403 status code with custom HTML message if URL contains '/test/message/forbidden'
+  if (fullUrl.includes('/test/message/forbidden')) {
+    req.setHtml('<strong>Access Denied</strong>');
+    return false;
+  }
+
+  // Requires username/password authentication if URL contains '/test/login'
+  if (fullUrl.includes('/test/login')) {
+    const auth = req.headers.authorization || req.headers['proxy-authorization'];
+    if (auth) {
+      // TODO: Validate username and password - return true if valid, false otherwise
+      return true;
+    }
+    req.setLogin(true); // Triggers basic auth prompt
+    return false;
+  }
+
+  // Returns 302 redirect if URL contains '/test/redirect'
+  if (fullUrl.includes('/test/redirect')) {
+    req.setRedirect('https://www.example.com/test');
+    return false;
+  }
+
+  // All other requests are allowed by default
+  // Custom headers can be added using `req.setHeader`
+  // Only headers prefixed with 'x-whistle-' are supported
+  // Example: req.setHeader('x-whistle-xxx', 'value');
   req.setHeader('x-whistle-custom-header', 'lack');
-  return true; // false 直接返回 403
+  **/
+  return true;
 };

package/assets/js/lib/resRulesServer.js

@@ -1,6 +1,13 @@
 
 module.exports = (server, options) => {
   server.on('request', (req, res) => {
-    res.end();
+    // rules & values
+    // res.end(JSON.stringify({
+    //   rules: '',
+    //   values: {},
+    // }));
+
+    // rules
+    res.end('');
   });
 };

package/assets/js/lib/resStatsServer.js

@@ -1,6 +1,18 @@
 
-module.exports = (server, options) => {
-  server.on('request', (req, res) => {
-    // do something
+export default (server, options) => {
+  server.on('request', (req) => {
+    const { originalReq, originalRes } = req;
+    console.log('Value:', originalReq.ruleValue);
+    console.log('URL:', originalReq.fullUrl);
+    console.log('Method:', originalReq.method);
+    console.log('Server IP', originalRes.serverIp);
+    console.log('Status Code:', originalRes.statusCode);
+    console.log('Response Headers:', originalReq.headers);
+    // get session data
+    req.getSession((reqSession) => {
+      if (reqSession) {
+        console.log('Response Body:', reqSession.res.body);
+      }
+    });
   });
 };

package/assets/js/lib/rulesServer.js

@@ -1,6 +1,13 @@
 
 module.exports = (server, options) => {
   server.on('request', (req, res) => {
-    res.end();
+    // rules & values
+    // res.end(JSON.stringify({
+    //   rules: '',
+    //   values: {},
+    // }));
+
+    // rules
+    res.end('');
   });
 };

package/assets/js/lib/sniCallback.js

@@ -1,4 +1,18 @@
-
+// sniCallback plugin handler - Dynamically controls TLS tunneling behavior based on request URL
 module.exports = async (req, options) => {
-  // return { key, cert }; // 可以返回 false、证书 { key, cert }、及其它
+  /**
+  const { fullUrl, originalReq } = req;
+  // Preserve TLS encryption for specific domains (skip MITM decryption)
+  if (fullUrl === 'https://tunnel.example.com' || originalReq.sniValue === 'tunnel') {
+    return false;
+  }
+
+  // Use custom certificate for targeted decryption
+  // Supports .crt, .pem, .cer certificate formats
+  if (fullUrl === 'https://custom.example.com') {
+    return { key, cert };
+  }
+  **/
+  // Default behavior: Decrypt TLS using Whistle's built-in certificate
+  return true;
 };

package/assets/js/lib/statsServer.js

@@ -1,6 +1,15 @@
-
-module.exports = (server, options) => {
-  server.on('request', (req, res) => {
-    // do something
+export default (server, options) => {
+  server.on('request', (req) => {
+    const { originalReq } = req;
+    console.log('Value:', originalReq.ruleValue);
+    console.log('URL:', originalReq.fullUrl);
+    console.log('Method:', originalReq.method);
+    console.log('Request Headers:', originalReq.headers);
+    // get request session
+    req.getReqSession((reqSession) => {
+      if (reqSession) {
+        console.log('Request Body:', reqSession.req.body);
+      }
+    });
   });
 };

package/assets/js/lib/uiServer/index.js

@@ -3,13 +3,14 @@ const bodyParser = require('koa-bodyparser');
 const onerror = require('koa-onerror');
 const serve = require('koa-static');
 const path = require('path');
-const router = require('koa-router')();
+const Router = require('@koa/router');
 const setupRouter = require('./router');
 
 const MAX_AGE = 1000 * 60 * 5;
 
 module.exports = (server, options) => {
   const app = new Koa();
+  const router = new Router();
   app.proxy = true;
   app.silent = true;
   onerror(app);

package/assets/js/lib/uiServer/router.js

@@ -1,4 +1,4 @@
-// For help see https://github.com/ZijianHe/koa-router#api-reference
+// For help, see https://github.com/koajs/router
 module.exports = (router) => {
   // router.get('/cgi-bin/init', (ctx) => {
   //   ctx.body = 'Hello whistle.';

package/assets/js/package.json

@@ -1,12 +1,13 @@
 {
   "name": "whistle.lack",
   "version": "1.0.0",
-  "description": "插件功能简介",
+  "description": "",
+  "whistleConfig": {},
   "dependencies": {
+    "@koa/router": "^13.1.1",
     "koa": "^2.15.0",
     "koa-bodyparser": "^4.4.1",
     "koa-onerror": "^4.2.0",
-    "koa-router": "^12.0.1",
     "koa-static": "^5.0.0"
   }
 }

package/assets/ts/package.json

@@ -1,24 +1,26 @@
 {
   "name": "whistle.lack",
   "version": "1.0.0",
-  "description": "插件功能简介",
+  "description": "",
   "scripts": {
     "dev": "tsc -w"
   },
+  "whistleConfig": {},
   "dependencies": {
     "koa": "^2.15.0",
     "koa-bodyparser": "^4.4.1",
     "koa-onerror": "^4.2.0",
-    "koa-router": "^12.0.1",
+    "@koa/router": "^13.1.1",
     "koa-static": "^5.0.0"
   },
   "devDependencies": {
+    "@types/node": "^24.0.14",
     "typescript": "^4.6.2"
   },
   "tsTypes": {
     "@types/koa": "^2.13.4",
+    "@types/koa__router": "^12.0.4",
     "@types/koa-bodyparser": "^4.3.5",
-    "@types/koa-router": "^7.4.4",
     "@types/koa-static": "^4.0.2"
   }
 }

package/assets/ts/src/auth.ts

@@ -1,5 +1,39 @@
 
 export default async (req: Whistle.PluginAuthRequest, options: Whistle.PluginOptions) => {
+  /**
+  const { fullUrl } = req;
+  // Returns 403 Forbidden status code if URL contains '/test/forbidden'
+  if (fullUrl.includes('/test/forbidden')) {
+    return false;
+  }
+  // Returns 403 status code with custom HTML message if URL contains '/test/message/forbidden'
+  if (fullUrl.includes('/test/message/forbidden')) {
+    req.setHtml('<strong>Access Denied</strong>');
+    return false;
+  }
+
+  // Requires username/password authentication if URL contains '/test/login'
+  if (fullUrl.includes('/test/login')) {
+    const auth = req.headers.authorization || req.headers['proxy-authorization'];
+    if (auth) {
+      // TODO: Validate username and password - return true if valid, false otherwise
+      return true;
+    }
+    req.setLogin(true); // Triggers basic auth prompt
+    return false;
+  }
+
+  // Returns 302 redirect if URL contains '/test/redirect'
+  if (fullUrl.includes('/test/redirect')) {
+    req.setRedirect('https://www.example.com/test');
+    return false;
+  }
+
+  // All other requests are allowed by default
+  // Custom headers can be added using `req.setHeader`
+  // Only headers prefixed with 'x-whistle-' are supported
+  // Example: req.setHeader('x-whistle-xxx', 'value');
   req.setHeader('x-whistle-custom-header', 'lack');
-  return true; // false 直接返回 403
+  **/
+  return true;
 };

package/assets/ts/src/resRulesServer.ts

@@ -1,6 +1,13 @@
 
 export default (server: Whistle.PluginServer, options: Whistle.PluginOptions) => {
   server.on('request', (req: Whistle.PluginRequest, res: Whistle.PluginResponse) => {
-    res.end();
+    // rules & values
+    // res.end(JSON.stringify({
+    //   rules: '',
+    //   values: {},
+    // }));
+
+    // rules
+    res.end('');
   });
 };

package/assets/ts/src/resStatsServer.ts

@@ -1,6 +1,18 @@
 
 export default (server: Whistle.PluginServer, options: Whistle.PluginOptions) => {
-  server.on('request', (req: Whistle.PluginRequest, res: Whistle.PluginResponse) => {
-    // do something
+  server.on('request', (req: Whistle.PluginRequest) => {
+    const { originalReq, originalRes } = req;
+    console.log('Value:', originalReq.ruleValue);
+    console.log('URL:', originalReq.fullUrl);
+    console.log('Method:', originalReq.method);
+    console.log('Server IP', originalRes.serverIp);
+    console.log('Status Code:', originalRes.statusCode);
+    console.log('Response Headers:', originalReq.headers);
+    // get session data
+    req.getSession((reqSession) => {
+      if (reqSession) {
+        console.log('Response Body:', reqSession.res.body);
+      }
+    });
   });
 };

package/assets/ts/src/rulesServer.ts

@@ -1,6 +1,13 @@
 
 export default (server: Whistle.PluginServer, options: Whistle.PluginOptions) => {
   server.on('request', (req: Whistle.PluginRequest, res: Whistle.PluginResponse) => {
-    res.end();
+    // rules & values
+    // res.end(JSON.stringify({
+    //   rules: '',
+    //   values: {},
+    // }));
+
+    // rules
+    res.end('');
   });
 };

package/assets/ts/src/sniCallback.ts

@@ -1,4 +1,18 @@
-
+// sniCallback plugin handler - Dynamically controls TLS tunneling behavior based on request URL
 export default async (req: Whistle.PluginSNIRequest, options: Whistle.PluginOptions) => {
-  // return { key, cert }; // 可以返回 false、证书 { key, cert }、及其它
+  /**
+  const { fullUrl } = req;
+  // Preserve TLS encryption for specific domains (skip MITM decryption)
+  if (fullUrl === 'https://tunnel.example.com') {
+    return false;
+  }
+
+  // Use custom certificate for targeted decryption
+  // Supports .crt, .pem, .cer certificate formats
+  if (fullUrl === 'https://custom.example.com') {
+    return { key, cert };
+  }
+  **/
+  // Default behavior: Decrypt TLS using Whistle's built-in certificate
+  return true;
 };

package/assets/ts/src/statsServer.ts

@@ -1,6 +1,15 @@
-
 export default (server: Whistle.PluginServer, options: Whistle.PluginOptions) => {
-  server.on('request', (req: Whistle.PluginRequest, res: Whistle.PluginResponse) => {
-    // do something
+  server.on('request', (req: Whistle.PluginRequest) => {
+    const { originalReq } = req;
+    console.log('Value:', originalReq.ruleValue);
+    console.log('URL:', originalReq.fullUrl);
+    console.log('Method:', originalReq.method);
+    console.log('Request Headers:', originalReq.headers);
+    // get request session
+    req.getReqSession((reqSession) => {
+      if (reqSession) {
+        console.log('Request Body:', reqSession.req.body);
+      }
+    });
   });
 };

package/assets/ts/src/types/global.d.ts

@@ -200,6 +200,7 @@ declare namespace Whistle {
     sharedStorage: SharedStorage;
     baseUrl: string;
     LRU: LRUCache;
+    zipBody(body: any, stream: WhistleBase.Request | WhistleBase.Response, cb: (result: Buffer | '') => void): void;
     getValue(key: string, cb: (value: string) => void): void;
     getCert(domain: string, cb: (cert: any) => void): void;
     getRootCA(cb: (cert: any) => void): void;
@@ -243,13 +244,13 @@ declare namespace Whistle {
   type PassThrough = (uri?: PassThroughReq, trailers?: PassThroughRes) => void;
 
   interface WriteHead {
-    (code: string | number, msg?: string, headers?: any): void;
-    (code: string | number, headers?: any): void;
+    (code?: string | number, msg?: string, headers?: any): void;
+    (code?: string | number, headers?: any): void;
   }
 
   interface RequestFn {
-    (uri: any, cb?: (res: any) => void, opts?: any): any;
-    (uri: any, opts?: any, cb?: (res: any) => void): any;
+    (uri?: any, cb?: (res: any) => void, opts?: any): any;
+    (uri?: any, opts?: any, cb?: (res: any) => void): any;
   }
 
   class PluginRequest extends WhistleBase.Request {
@@ -309,6 +310,8 @@ declare namespace Whistle {
       isRexExp?: boolean;
       pattern?: string;
       customParser?: boolean | '';
+      serverIp: string;
+      statusCode: string;
     };
     originalRes: {
       serverIp: string;
@@ -338,6 +341,7 @@ declare namespace Whistle {
     setReqRules: SetRules;
     setResRules: SetRules;
     disableTrailers?: boolean;
+    writeHead: WriteHead;
   }
   class PluginUIRequest extends WhistleBase.Request {
     clientIp: string;

package/assets/ts/src/uiServer/index.ts

@@ -3,7 +3,7 @@ import bodyParser from 'koa-bodyparser';
 import onerror from 'koa-onerror';
 import serve from 'koa-static';
 import path from 'path';
-import Router from 'koa-router';
+import Router from '@koa/router';
 import setupRouter from './router';
 
 const MAX_AGE = 1000 * 60 * 5;

package/assets/ts/src/uiServer/router.ts

@@ -1,6 +1,6 @@
-import Router from 'koa-router';
+import Router from '@koa/router';
 
-// For help see https://github.com/ZijianHe/koa-router#api-reference
+// For help, see https://github.com/koajs/router
 export default (router: Router) => {
   // router.get('/cgi-bin/init', (ctx) => {
   //   ctx.body = 'Hello whistle.';

package/assets/ts/tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "rootDir": "./src",
     "outDir": "./dist/",
     "noImplicitAny": true,
     "removeComments": true,

package/bin/index.js

@@ -8,11 +8,11 @@ let bingo;
 
 program
   .version(conf.version)
-  .command('init')
+  .command('init [hooks]')
   .description('create whistle plugin project.')
-  .action(() => {
+  .action((hooks) => {
     bingo = true;
-    init();
+    init(hooks);
   });
 
 program

package/bin/init.js

@@ -5,9 +5,12 @@ const path = require('path');
 /* eslint-disable no-sync */
 let type = 'ts';
 let srcDir = 'src';
+let curHooks = {};
+let curType;
+let hasHooks;
 const ROOT = path.join(__dirname, '../');
 const NAME_RE = /^(@[a-z\d_-]+\/)?(whistle\.)?([a-z\d_-]+)$/;
-const NAME_TIPS = 'The plugin name can only contain [a~z0~9_-].';
+const NAME_TIPS = 'Plugin name must match either \'whistle.[a-z0-9_-]+\' or \'@scope/whistle.[a-z0-9_-]+\'';
 const TS_PKG = fse.readJSONSync(path.join(ROOT, 'assets/ts/package.json'));
 const JS_PKG = fse.readJSONSync(path.join(ROOT, 'assets/js/package.json'));
 const TEMPLATES = [
@@ -43,13 +46,13 @@ const getPackage = () => {
   try {
     pkg = fse.readJSONSync('package.json');
   } catch (e) {}
-  return Object.assign({}, pkg);
+  return { ...pkg };
 };
 
 const copySync = (src, dest) => {
-  dest = dest || src;
-  if (!fs.existsSync(dest)) {
-    fse.copySync(path.join(ROOT, src), dest);
+  const d = dest || src;
+  if (!fs.existsSync(d)) {
+    fse.copySync(path.join(ROOT, src), d);
   }
 };
 
@@ -69,7 +72,7 @@ const readIndexFile = () => {
 };
 
 const selectTemplate = async () => {
-  const { template } = await inquirer.prompt([
+  const template = curType ? TEMPLATES[curType === 'ts' ? 0 : 1] : (await inquirer.prompt([
     {
       type: 'list',
       name: 'template',
@@ -77,7 +80,7 @@ const selectTemplate = async () => {
       message: 'Select template:',
       choices: TEMPLATES,
     },
-  ]);
+  ])).template;
   if (template === 'TypeScript') {
     return template;
   }
@@ -87,105 +90,132 @@ const selectTemplate = async () => {
 };
 
 const selectAuth = async () => {
-  const { auth } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      name: 'auth',
-      default: false,
-      message: 'Do you need auth function?',
-    },
-  ]);
+  let { auth } = curHooks;
+  if (!hasHooks) {
+    auth = (await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'auth',
+        default: false,
+        message: 'Do you need auth function?',
+      },
+    ])).auth;
+  }
   return auth && `${srcDir}/auth.${type}`;
 };
 
 const selectSni = async () => {
-  const { sni } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      name: 'sni',
-      default: false,
-      message: 'Do you need sniCallback function?',
-    },
-  ]);
+  let { sni } = curHooks;
+  if (!hasHooks) {
+    sni = (await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'sni',
+        default: false,
+        message: 'Do you need sniCallback function?',
+      },
+    ])).sni;
+  }
   return sni && `${srcDir}/sniCallback.${type}`;
 };
 
 const selectUIServer = async () => {
-  const { uiServer } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      name: 'uiServer',
-      default: false,
-      message: 'Do you need uiServer?',
-    },
-  ]);
+  let { uiServer } = curHooks;
+  if (!hasHooks) {
+    uiServer = (await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'uiServer',
+        default: false,
+        message: 'Do you need uiServer?',
+      },
+    ])).uiServer;
+  }
   return uiServer && `${srcDir}/uiServer`;
 };
 
 const setHookFile = (hooks) => {
   const servers = {};
-  hooks.forEach((hook) => {
-    servers[hook] = `${srcDir}/${hook}.${type}`;
-  });
+  if (hooks) {
+    hooks.forEach((hook) => {
+      servers[hook] = `${srcDir}/${hook}.${type}`;
+    });
+  }
   return servers;
 };
 
 const selectRulesServers = async () => {
-  const { rulesServers } = await inquirer.prompt([
-    {
-      type: 'checkbox',
-      name: 'rulesServers',
-      message: 'Select rules servers:',
-      choices: RULES_SERVERS,
-    },
-  ]);
+  let { rulesServers } = curHooks;
+  if (!hasHooks) {
+    rulesServers = (await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'rulesServers',
+        message: 'Select rules servers:',
+        choices: RULES_SERVERS,
+      },
+    ])).rulesServers;
+  }
   return setHookFile(rulesServers);
 };
 
 const selectStatsServers = async () => {
-  const { statsServers } = await inquirer.prompt([
-    {
-      type: 'checkbox',
-      name: 'statsServers',
-      message: 'Select stats servers:',
-      choices: STATS_SERVERS,
-    },
-  ]);
+  let { statsServers } = curHooks;
+  if (!hasHooks) {
+    statsServers = (await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'statsServers',
+        message: 'Select stats servers:',
+        choices: STATS_SERVERS,
+      },
+    ])).statsServers;
+  }
   return setHookFile(statsServers);
 };
 
 const selectPipeServers = async () => {
-  const { pipeServers } = await inquirer.prompt([
-    {
-      type: 'checkbox',
-      name: 'pipeServers',
-      message: 'Select pipe servers:',
-      choices: PIPE_SERVERS,
-    },
-  ]);
+  let { pipeServers } = curHooks;
+  if (!hasHooks) {
+    pipeServers = (await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'pipeServers',
+        message: 'Select pipe servers:',
+        choices: PIPE_SERVERS,
+      },
+    ])).pipeServers;
+  }
   const hooks = [];
-  pipeServers.join('+').split('+').forEach((hook) => {
-    hook = hook.trim();
-    if (hook) {
-      hooks.push(hook);
-    }
-  });
+  if (pipeServers) {
+    pipeServers.join('+').split('+').forEach((hook) => {
+      const h = hook.trim();
+      if (h) {
+        hooks.push(h);
+      }
+    });
+  }
   return setHookFile(hooks);
 };
 
 const selectRulesFiles = async () => {
+  let { rulesFiles } = curHooks;
+  if (!hasHooks) {
+    rulesFiles = (await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'rulesFiles',
+        message: 'Select rules files:',
+        choices: RULES_FILES,
+      },
+    ])).rulesFiles;
+  }
   const result = {};
-  const { rulesFiles } = await inquirer.prompt([
-    {
-      type: 'checkbox',
-      name: 'rulesFiles',
-      message: 'Select rules files:',
-      choices: RULES_FILES,
-    },
-  ]);
-  rulesFiles.forEach((hook) => {
-    result[hook] = hook;
-  });
+  if (rulesFiles) {
+    rulesFiles.forEach((hook) => {
+      result[hook] = hook;
+    });
+  }
   return result;
 };
 
@@ -198,59 +228,201 @@ const addMsg = (obj, msg, tips) => {
   }
 };
 
-const setPackage = (pkg, hasUIServer) => {
+const setPackage = (pkg, hasUIServer, hasJs) => {
   const newPkg = type === 'js' ? JS_PKG : TS_PKG;
-  const keys = ['scripts', 'devDependencies'];
+  const keys = hasJs ? ['scripts', 'devDependencies'] : [];
   if (hasUIServer) {
     keys.push('dependencies', 'tsTypes');
   }
   keys.forEach((key) => {
     const newValue = newPkg[key];
-    if (key === 'tsTypes') {
-      key = 'devDependencies';
-    }
-    const value = pkg[key];
+    const k = key === 'tsTypes' ? 'devDependencies' : key;
+    const value = pkg[k];
     if (!newValue) {
       return;
     }
     if (!value) {
-      pkg[key] = newValue;
+      pkg[k] = newValue;
       return;
     }
     Object.keys(newValue).forEach((name) => {
-      if (!value[name]) {
-        value[name] = newValue[name];
-      }
+      value[name] = value[name] || newValue[name];
     });
   });
 };
 
-module.exports = async () => {
+const trim = (str) => (typeof str === 'string' ? str.trim() : str);
+
+const getHooks = (hook) => {
+  const result = {};
+  const hooks = typeof hook === 'string' ? hook.trim().toLowerCase() : null;
+  if (!hooks) {
+    return result;
+  }
+  const addItem = (prop, name) => {
+    const list = result[prop] || [];
+    result[prop] = list;
+    if (list.indexOf(name) === -1) {
+      list.push(name);
+    }
+  };
+  hooks.split(/[^._a-z]/i).forEach((name) => {
+    const h = name.trim();
+    if (h === 'empty' || h === 'blank' || h === 'none') {
+      result.empty = true;
+      return;
+    }
+    if (h === 'ts' || h === 'typescript') {
+      curType = 'ts';
+      return;
+    }
+    if (h === 'js' || h === 'javascript') {
+      curType = 'js';
+      return;
+    }
+    if (h === 'rules' || h === 'rules.txt') {
+      addItem('rulesFiles', 'rules.txt');
+      return;
+    }
+    if (h === '_rules' || h === '_rules.txt' || h === 'reqrules' || h === 'reqrules.txt') {
+      addItem('rulesFiles', '_rules.txt');
+      return;
+    }
+    if (h === 'resrules' || h === 'resrules.txt') {
+      addItem('rulesFiles', 'resRules.txt');
+      return;
+    }
+
+    if (h === 'uiserver') {
+      result.uiServer = true;
+      return;
+    }
+
+    if (h === 'auth' || h === 'verify') {
+      result.auth = true;
+      return;
+    }
+
+    if (h === 'snicallback' || h === 'sni') {
+      result.sni = true;
+      return;
+    }
+
+    if (h === 'server') {
+      addItem('pipeServers', 'server');
+      return;
+    }
+
+    if (h === 'rulesserver') {
+      addItem('rulesServers', 'rulesServer');
+      return;
+    }
+
+    if (h === 'tunnelrulesserver') {
+      addItem('rulesServers', 'tunnelRulesServer');
+      return;
+    }
+
+    if (h === 'resrulesserver') {
+      addItem('rulesServers', 'resRulesServer');
+      return;
+    }
+    if (h === 'statsserver') {
+      addItem('statsServers', 'statsServer');
+      return;
+    }
+    if (h === 'resstatsserver') {
+      addItem('statsServers', 'resStatsServer');
+      return;
+    }
+
+    const isPipe = h === 'pipe';
+    const pipeTunnel = h === 'pipetunnel' || h === 'tunnelpipe';
+    const pipeHtttp = h === 'pipehttp' || h === 'httppipe';
+    const pipeWs = h === 'pipews' || h === 'wspipe';
+
+    if (isPipe || pipeTunnel || h === 'pipetunnelreq' || h === 'tunnelreqpipe' || h === 'tunnelreqread' || h === 'tunnelreqwrite') {
+      addItem('pipeServers', 'tunnelReqRead');
+      addItem('pipeServers', 'tunnelReqWrite');
+    }
+    if (isPipe || pipeTunnel || h === 'pipetunnelres' || h === 'tunnelrespipe' || h === 'tunnelresread' || h === 'tunnelreswrite') {
+      addItem('pipeServers', 'tunnelResRead');
+      addItem('pipeServers', 'tunnelResWrite');
+    }
+
+    if (isPipe || pipeHtttp || h === 'pipereq' || h === 'reqpipe' || h === 'reqread' || h === 'reqwrite') {
+      addItem('pipeServers', 'reqRead');
+      addItem('pipeServers', 'reqWrite');
+    }
+    if (isPipe || pipeHtttp || h === 'piperes' || h === 'respipe' || h === 'resread' || h === 'reswrite') {
+      addItem('pipeServers', 'resRead');
+      addItem('pipeServers', 'resWrite');
+    }
+
+    if (isPipe || pipeWs || h === 'pipewsreq' || h === 'wsreqpipe' || h === 'wsreqread' || h === 'wsreqwrite') {
+      addItem('pipeServers', 'wsReqRead');
+      addItem('pipeServers', 'wsReqWrite');
+    }
+    if (isPipe || pipeWs || h === 'pipewsres' || h === 'wsrespipe' || h === 'wsresread' || h === 'wsreswrite') {
+      addItem('pipeServers', 'wsResRead');
+      addItem('pipeServers', 'wsResWrite');
+    }
+  });
+  return result;
+};
+
+module.exports = async (hooks) => {
+  const isBlank = hooks === 'blank' || hooks === 'empty';
+  curHooks = isBlank ? {} : getHooks(hooks);
+  hasHooks = isBlank || Object.keys(curHooks).length > 0;
   const pkg = getPackage();
   let defaultName;
+  if (hasHooks && !curType) {
+    curType = fs.existsSync('lib') ? 'js' : 'ts';
+  }
   if (/^@[a-z\d_-]+\/whistle\.[a-z\d_-]+$/.test(pkg.name)) {
     defaultName = pkg.name;
   } else if (NAME_RE.test(path.basename(process.cwd()))) {
     defaultName = `${RegExp.$1 || ''}${RegExp.$2 || 'whistle.'}${RegExp.$3}`;
   }
-  console.log('\n\nFor help see https://github.com/avwo/lack\n\n'); // eslint-disable-line
-  const { name } = await inquirer.prompt([
+  console.log('\nFor help see https://github.com/avwo/lack\n'); // eslint-disable-line
+  const name = hasHooks ? defaultName : (await inquirer.prompt([
     {
       type: 'input',
       name: 'name',
       message: 'Plugin Name:',
       default: defaultName,
-      validate: (input) => {
-        return NAME_RE.test(input) || NAME_TIPS;
-      },
+      validate: (input) => NAME_RE.test(input) || NAME_TIPS,
     },
-  ]);
+  ])).name;
   if (!NAME_RE.test(name)) {
     throw new Error(NAME_TIPS);
   }
   pkg.name = `${RegExp.$1 || ''}${RegExp.$2 || 'whistle.'}${RegExp.$3}`;
-  pkg.version = pkg.version || '1.0.0';
-  pkg.description = pkg.description || '';
+  const defaultVersion = pkg.version || '1.0.0';
+  let version;
+  let description;
+  if (!hasHooks) {
+    version = (await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'version',
+        message: 'Version:',
+        default: defaultVersion,
+      },
+    ])).version;
+    description = (await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'description',
+        message: 'Description:',
+        default: pkg.description || null,
+      },
+    ])).description;
+  }
+  pkg.version = trim(version) || defaultVersion;
+  pkg.description = trim(description) || pkg.description || '';
+  pkg.whistleConfig = pkg.whistleConfig || {};
 
   const template = await selectTemplate();
   const uiServer = await selectUIServer();
@@ -260,7 +432,8 @@ module.exports = async () => {
   const statsServers = await selectStatsServers();
   const pipeServers = await selectPipeServers();
   const rulesFiles = await selectRulesFiles();
-  const msg = [`\n\n\nPlugin Name: ${pkg.name}`, `\nTemplate: ${template}`];
+  const msg = [`Plugin Name: ${pkg.name}`, `\nVersion: ${pkg.version}`,
+    `\nDescription: ${pkg.description}`, `\nTemplate: ${template}`];
   if (authFn) {
     msg.push('\nAuth function: Yes');
   }
@@ -274,19 +447,28 @@ module.exports = async () => {
   addMsg(statsServers, msg, 'Stats Servers:');
   addMsg(pipeServers, msg, 'Pipe Servers:');
   addMsg(rulesFiles, msg, 'Rules Files:');
-  if (msg.length < 3) {
+  const len = msg.length;
+  if (len < 4) {
     return;
   }
-  msg.push('\nIs this ok?');
-  const { ok } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      name: 'ok',
-      message: msg.join('\n'),
-    },
-  ]);
+  if (len === 4) {
+    msg.pop();
+  }
+  let ok = hasHooks;
   if (!ok) {
-    return;
+    msg.push('\nIs this ok?');
+    ok = (await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'ok',
+        message: msg.join('\n'),
+      },
+    ])).ok;
+    if (!ok) {
+      return;
+    }
+  } else {
+    console.log(msg.join('\n')); // eslint-disable-line
   }
 
   initReadme(pkg);
@@ -333,17 +515,18 @@ module.exports = async () => {
   if (hasChanged) {
     fs.writeFileSync('index.js', indexFile);
   }
-  setPackage(pkg, uiServer);
+  setPackage(pkg, uiServer, hasChanged);
   fs.writeFileSync('package.json', JSON.stringify(pkg, null, '  '));
   let showInstall = uiServer;
-  if (!isJs) {
+  if (!isJs && (hasChanged || !fs.existsSync('assets/ts/src/types'))) {
     showInstall = true;
     copySync('assets/ts/src/types/base.d.ts', 'src/types/base.d.ts');
     copySync('assets/ts/src/types/global.d.ts', 'src/types/global.d.ts');
     copySync('assets/ts/tsconfig.json', 'tsconfig.json');
   }
   if (showInstall) {
-    console.log(`\nRun \`npm i\` to install dependencies`); // eslint-disable-line
+    console.log(`\nRun \`npm i\` to install dependencies\n`); // eslint-disable-line
+  } else {
+    console.log(); // eslint-disable-line
   }
-  console.log(`${showInstall ? '\n' : '\n\n'}For help see https://github.com/avwo/lack\n\n`); // eslint-disable-line
 };

package/bin/watch.js

@@ -8,6 +8,7 @@ const HOME_DIR_RE = /^[~～]\//;
 const PLUGIN_NAME_RE = /^(?:@[\w-]+\/)?(whistle\.[a-z\d_-]+)$/;
 const REL_RE = /^\.\.[\\/]+/;
 const SLASH_RE = /[\\/]/;
+const BOUNDARY = '\n************************************************\n';
 
 const getWhistlePath = () => {
   const dir = process.env.WHISTLE_PATH;
@@ -17,6 +18,10 @@ const getWhistlePath = () => {
   return path.join(os.homedir(), '.WhistleAppData');
 };
 
+const showLog = (msg) => {
+  console.log(msg); // eslint-disable-line
+};
+
 const DEV_PLUGINS = path.join(getWhistlePath(), 'dev_plugins');
 const ROOT = process.cwd();
 const pkgFile = path.join(ROOT, 'package.json');
@@ -80,13 +85,13 @@ module.exports = (dirs) => {
     fs.unlinkSync(logFile); // eslint-disable-line
   } catch (e) {}
   fse.ensureDirSync(DEV_PLUGINS);
-  const watchList = ['index.js', 'rules.txt', '_rules.txt', 'reqRules.txt', 'resRules.txt',
-    '_values.txt', 'lib', 'dist', 'public', 'initial.js', 'initialize.js'];
+  const watchList = ['index.js', 'rules.txt', '_rules(reqRules).txt', '_values.txt',
+    'resRules.txt', 'lib', 'dist', 'public', 'initial(initialize).js'];
   if (dirs && typeof dirs === 'string') {
     dirs.split(',').forEach((dir) => {
-      dir = dir.trim();
-      if (dir && watchList.indexOf(dir) === -1) {
-        watchList.push(dir);
+      const d = dir.trim();
+      if (d && watchList.indexOf(d) === -1) {
+        watchList.push(d);
       }
     });
   }
@@ -104,15 +109,17 @@ module.exports = (dirs) => {
         return true;
       }
     }
+    return false;
   };
-  console.log(`Watching the following files/folders changes:\n${tips}`); // eslint-disable-line
-  console.log('\n*********************************************\n'); // eslint-disable-line
+  showLog(BOUNDARY);
+  showLog(`Watching the following files/folders changes:\n${tips}`);
+  showLog(BOUNDARY);
   const ignoredRe = /(^|[/\\])(\..|node_modules([/\\]|$))/;
   chokidar.watch(watchList, {
     ignored: ignoredRe,
   }).on('raw', (_, filename, details) => {
-    if (filename.includes('package.json') || filename.includes('.console.log') ||
-      ignoredRe.test(filename)) {
+    if (filename.includes('package.json') || filename.includes('.console.log')
+      || ignoredRe.test(filename)) {
       return;
     }
     const watchedPath = (details && details.watchedPath) || filename;
@@ -122,8 +129,7 @@ module.exports = (dirs) => {
     }
     clearTimeout(timer);
     timer = setTimeout(() => {
-      console.log(''); // eslint-disable-line
-      console.log(`${hasSlash ? watchedPath : filename} is changed.`); // eslint-disable-line
+      showLog(`\n${hasSlash ? watchedPath : filename} is changed.`);
       touch();
     }, 1000);
   }).on('error', () => {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lack",
-  "version": "1.3.17",
+  "version": "1.4.0",
   "description": "whistle extension tools",
   "author": "avenwu <avwu@qq.com>",
   "license": "MIT",
@@ -35,9 +35,8 @@
     "lru-cache": "^6.0.0"
   },
   "devDependencies": {
-    "@types/node": "*",
-    "babel-eslint": "^10.0.1",
-    "eslint": "^5.16.0",
-    "eslint-config-imweb": "^0.2.17"
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.32.0"
   }
 }