@jayfong/x-server 2.12.7 → 2.12.15

package/lib/cli/api_generator.js

@@ -9,17 +9,15 @@ export class ApiGenerator {
   constructor() {
     this.debug = createDebug('api');
     this.cwd = process.cwd();
+    // cwd = '/Users/admin/Documents/jfWorks/x-server-test'
     this.project = void 0;
   }
-
   getTypeBySymbol(symbol) {
     return symbol.getTypeAtLocation(symbol.getDeclarations()[0] || symbol.getValueDeclarationOrThrow());
   }
-
   getComment(declaration) {
     var _declaration$getLeadi;
-
-    const text = ((declaration == null ? void 0 : (_declaration$getLeadi = declaration.getLeadingCommentRanges()[0]) == null ? void 0 : _declaration$getLeadi.getText()) || '').trim();
+    const text = ((declaration == null || (_declaration$getLeadi = declaration.getLeadingCommentRanges()[0]) == null ? void 0 : _declaration$getLeadi.getText()) || '').trim();
     const comment = parseComment.parse(text)[0];
     const description = (comment == null ? void 0 : comment.description) || '';
     const tags = new Map();
@@ -32,16 +30,12 @@ export class ApiGenerator {
       tags: tags
     };
   }
-
   getCommentBySymbol(symbol) {
     var _this$getComment;
-
     return ((_this$getComment = this.getComment(symbol.getDeclarations()[0])) == null ? void 0 : _this$getComment.description) || '';
   }
-
   typeToApiData(type, _symbol) {
     var _type$getSymbol, _type$getSymbol2, _type$getSymbol3;
-
     // ws
     if (((_type$getSymbol = type.getSymbol()) == null ? void 0 : _type$getSymbol.getName()) === 'SocketStream') {
       return {
@@ -52,12 +46,11 @@ export class ApiGenerator {
         children: [],
         enum: []
       };
-    } // XFile
-
+    }
 
+    // XFile
     if (((_type$getSymbol2 = type.getSymbol()) == null ? void 0 : _type$getSymbol2.getName()) === 'MultipartFile') {
       const symbol = _symbol || type.getSymbol();
-
       return {
         name: 'file',
         desc: symbol && this.getCommentBySymbol(symbol) || '',
@@ -67,25 +60,22 @@ export class ApiGenerator {
         enum: []
       };
     }
-
     let isRequired = true;
     let isUnion = type.isUnion();
     const unionTypes = isUnion ? type.getUnionTypes().filter(item => !item.isBooleanLiteral() && !item.isNull() && !item.isUndefined()) : [];
     isUnion = !!unionTypes.length;
-
     if (isUnion) {
       if (unionTypes.length === 1 && !unionTypes[0].isLiteral()) {
         isUnion = false;
-      } // 兼容 prisma 生成的类型用 null 表示可选
-
-
-      isRequired = unionTypes.length === type.getUnionTypes().length; // 必须用 getBaseTypeOfLiteralType 获取枚举字面量的原始类型
-
+      }
+      // 兼容 prisma 生成的类型用 null 表示可选
+      isRequired = unionTypes.length === type.getUnionTypes().length;
+      // 必须用 getBaseTypeOfLiteralType 获取枚举字面量的原始类型
       type = unionTypes[0].getBaseTypeOfLiteralType();
     }
-
     const isEnum = type.isEnum();
-    const enumData = isEnum ? // @ts-ignore
+    const enumData = isEnum ?
+    // @ts-ignore
     type.compilerType.types.reduce((res, item) => {
       res[item.getSymbol().getName()] = item.value;
       return res;
@@ -98,11 +88,10 @@ export class ApiGenerator {
     const isString = isEnum ? typeof enumValues[0] === 'string' : type.isString() || ['Date'].includes(((_type$getSymbol3 = type.getSymbol()) == null ? void 0 : _type$getSymbol3.getName()) || '');
     const isNumber = isEnum ? typeof enumValues[0] === 'number' : type.isNumber();
     const isBoolean = type.isBoolean() || type.isUnion() && type.getUnionTypes().some(item => item.isBooleanLiteral()) && type.getUnionTypes().every(item => item.isBooleanLiteral() || item.isNull() || item.isUndefined());
-    const isObject = !isArray && !isString && !isNumber && !isBoolean && type.isObject() || // 将交集类型视为对象
+    const isObject = !isArray && !isString && !isNumber && !isBoolean && type.isObject() ||
+    // 将交集类型视为对象
     isIntersection;
-
     const symbol = _symbol || type.getSymbol();
-
     const apiName = (symbol == null ? void 0 : symbol.getName()) || '__type';
     const apiDesc = [symbol && this.getCommentBySymbol(symbol), isEnum && `枚举：${enumKeys.map((key, index) => `${key}->${enumValues[index]}`).join('; ')}`].filter(Boolean).join('\n');
     const apiEnum = isUnion ? unionTypes.map(t => t.getLiteralValue()) : isEnum ? enumValues : [];
@@ -113,20 +102,21 @@ export class ApiGenerator {
       const compilerFactory = context.compilerFactory;
       const rawChecker = type.compilerType.checker;
       let symbols = [];
-
       if (intersectionTypes) {
         // https://github.com/microsoft/TypeScript/issues/38184
-        symbols = rawChecker.getAllPossiblePropertiesOfTypes(intersectionTypes.map(item => item.compilerType)) // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
+        symbols = rawChecker.getAllPossiblePropertiesOfTypes(intersectionTypes.map(item => item.compilerType))
+        // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
         .map(symbol => compilerFactory.getSymbol(symbol));
       } else {
         // symbols = type.getApparentProperties()
         // https://github.com/microsoft/TypeScript/issues/38184
-        symbols = rawChecker.getAllPossiblePropertiesOfTypes([type.compilerType]) // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
+        symbols = rawChecker.getAllPossiblePropertiesOfTypes([type.compilerType])
+        // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
         .map(symbol => compilerFactory.getSymbol(symbol));
       }
-
       return symbols.map(symbol => {
-        return this.typeToApiData(!symbol.compilerSymbol.declarations ? // 对于复杂对象，没有定义的，通过 type 直接获取（在前面通过 getText 预处理得到）
+        return this.typeToApiData(!symbol.compilerSymbol.declarations ?
+        // 对于复杂对象，没有定义的，通过 type 直接获取（在前面通过 getText 预处理得到）
         compilerFactory.getType(symbol.compilerSymbol.type) : this.getTypeBySymbol(symbol), symbol);
       });
     }) : [];
@@ -139,10 +129,8 @@ export class ApiGenerator {
       children: apiChildren
     };
   }
-
   apiDataToJsonSchema(apiData, jsonSchema = {}) {
     jsonSchema.description = apiData.desc;
-
     if (apiData.type === 'object') {
       jsonSchema.type = 'object';
       jsonSchema.properties = apiData.children.reduce((res, item) => {
@@ -156,18 +144,14 @@ export class ApiGenerator {
       jsonSchema.items = apiData.children.map(item => this.apiDataToJsonSchema(item))[0];
     } else {
       jsonSchema.type = apiData.type;
-
       if (apiData.enum.length) {
         jsonSchema.enum = apiData.enum;
       }
     }
-
     return jsonSchema;
   }
-
   genYApiData(handles) {
     const data = {};
-
     for (const handle of handles) {
       data[handle.category] = data[handle.category] || [];
       data[handle.category].push(handle.handlerMethod === 'GET' ? {
@@ -221,14 +205,12 @@ export class ApiGenerator {
         res_body: JSON.stringify(handle.responseDataJsonSchema)
       });
     }
-
     return Object.keys(data).map(cat => ({
       name: cat,
       desc: cat,
       list: data[cat]
     }));
   }
-
   async generate() {
     this.debug('启动项目...');
     this.project = new ts.Project({
@@ -240,11 +222,9 @@ export class ApiGenerator {
     const handlerGroup = sourceFile.getExportSymbols();
     const handles = [];
     this.debug('生成API文档...');
-
     for (const handlerList of handlerGroup) {
       const handlerListSourceFile = this.getTypeBySymbol(handlerList).getProperties()[0].getDeclarations()[0].getSourceFile();
       const basePath = `/${handlerListSourceFile.getFilePath().replace('.ts', '').split('/src/handlers/')[1].replace(/(^|\/)index$/, '/').split('/').map(v => snakeCase(v)).join('/')}/`.replace(/\/{2,}/g, '/');
-
       for (const handler of handlerListSourceFile.getVariableStatements().filter(item => item.isExported())) {
         // 重要：这一步必须，先调一遍 getText 获取看到的对象，后续对于复杂定义才不会报错
         handler.getDeclarations().forEach(exp => {
@@ -255,12 +235,10 @@ export class ApiGenerator {
         this.debug('生成接口: %s ...', handlerPath);
         const [requestType, responseType, methodType] = handlerExp.getType().getTypeArguments();
         const handlerComment = this.getComment(handlerExp.getParent().getParent());
-
         if (handlerComment.tags.has('private')) {
           this.debug('跳过生成接口: %s', `${handlerPath}`);
           continue;
         }
-
         const handlerCategory = pascalCase(basePath) || 'Index';
         const handlerName = handlerComment.description || handlerPath;
         const handlerMethod = methodType.getLiteralValueOrThrow();
@@ -282,7 +260,6 @@ export class ApiGenerator {
         });
       }
     }
-
     this.debug('写入文件...');
     await Promise.all([fs.outputJSON(path.join(this.cwd, 'temp/api.json'), handles, {
       spaces: 2
@@ -290,5 +267,6 @@ export class ApiGenerator {
       spaces: 2
     })]);
   }
+}
 
-} // new ApiGenerator().generate()
+// new ApiGenerator().generate()

package/lib/cli/build_util.js

@@ -8,7 +8,6 @@ import { dedent, uniq } from 'vtils';
 export class BuildUtil {
   static async build(options) {
     var _options$minify, _options$inlineEnvs;
-
     const mainFile = path.join(options.cwd, 'src/main.ts');
     const pkgFile = path.join(options.cwd, 'package.json');
     const pkgContent = await fs.readJson(pkgFile);
@@ -20,8 +19,9 @@ export class BuildUtil {
     const distNoInstallFile = path.join(distDir, 'no_install.lock');
     const distBundleFile = path.join(tempDir, `app.${pkgContent.version}.tgz`);
     await fs.ensureDir(distDir);
-    await fs.ensureDir(tempDir); // 处理 external
+    await fs.ensureDir(tempDir);
 
+    // 处理 external
     const external = uniq(options.external || []);
     const externalWithVersions = (await Promise.all(external.map(async item => {
       try {
@@ -39,17 +39,17 @@ export class BuildUtil {
           version: ''
         };
       }
-    }))).filter(item => !!item.version); // fix: hexoid 构建问题
+    }))).filter(item => !!item.version);
 
+    // fix: hexoid 构建问题
     try {
       const hexoidPackageJsonFile = require.resolve('hexoid/package.json');
-
       const pkg = await fs.readJson(hexoidPackageJsonFile);
       delete pkg.module;
       await fs.writeJson(hexoidPackageJsonFile, pkg);
-    } catch {} // 构建
-
+    } catch {}
 
+    // 构建
     await fs.emptyDir(distDir);
     await esbuild.build({
       entryPoints: [mainFile],
@@ -75,7 +75,6 @@ export class BuildUtil {
       },
       plugins: [{
         name: 'extract-assets',
-
         setup(build) {
           build.onLoad({
             filter: /\/svg-captcha\/lib\/option-manager\.js$/
@@ -114,30 +113,29 @@ export class BuildUtil {
             };
           });
         }
-
       }]
-    }); // 兼容 prisma
+    });
 
+    // 兼容 prisma
     const prismaSchemaFile = path.join(options.cwd, 'src/db/schema.prisma');
-
     if (await fs.pathExists(prismaSchemaFile)) {
       // 复制 schema.prisma
       const distPrismaSchemaFile = path.join(distDir, path.basename(prismaSchemaFile));
-      await fs.copyFile(prismaSchemaFile, distPrismaSchemaFile); // 复制查询引擎
+      await fs.copyFile(prismaSchemaFile, distPrismaSchemaFile);
 
+      // 复制查询引擎
       const libqueryEngineFiles = await globby('libquery_engine-*', {
         cwd: path.join(options.cwd, 'node_modules/.prisma/client'),
         ignore: ['libquery_engine-{darwin,windows}*'],
         onlyFiles: true,
         absolute: true
       });
-
       for (const libqueryEngineFile of libqueryEngineFiles) {
         await fs.copyFile(libqueryEngineFile, path.join(distDir, path.basename(libqueryEngineFile)));
       }
-    } // 写入 pkg
-
+    }
 
+    // 写入 pkg
     const deps = externalWithVersions.reduce((res, item) => {
       res[item.name] = item.version;
       return res;
@@ -147,8 +145,9 @@ export class BuildUtil {
       version: pkgContent.version,
       dependencies: deps
     };
-    await fs.writeJSON(distPkgFile, distPkgContent); // 写入 pm2 配置
+    await fs.writeJSON(distPkgFile, distPkgContent);
 
+    // 写入 pm2 配置
     await fs.writeFile(distPm2File, dedent`
         module.exports = {
           apps: [
@@ -160,7 +159,6 @@ export class BuildUtil {
           ],
         }
       `);
-
     if (externalWithVersions.length) {
       if (options.noInstall) {
         await fs.writeFile(distNoInstallFile, '');
@@ -177,10 +175,9 @@ export class BuildUtil {
           }
         });
       }
-    } // 打包为 tgz
-
+    }
 
+    // 打包为 tgz
     await compressing.tgz.compressDir(distDir, distBundleFile);
   }
-
 }

package/lib/cli/cli.js

@@ -20,14 +20,12 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
 }), async argv => {
   process.env.NODE_ENV = 'development';
   let lastRun;
-
   const run = () => {
-    lastRun = execa('node', ['-r', require.resolve("./register"), 'src/main.ts'], {
+    lastRun = execa('tsx', ['src/main.ts'], {
       cwd: process.cwd(),
       stdio: 'inherit'
     });
   };
-
   if (argv.npc) {
     const [server, vkey] = argv.npc.split('@');
     execa('docker', ['run', '--rm', 'ffdfgdfg/npc:v0.26.9', `-server=${server}`, `-vkey=${vkey}`, '-type=tcp'], {
@@ -35,10 +33,10 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
       stdio: 'inherit'
     });
   }
-
   await TemplateUtil.init(process.cwd());
   const watcher = chokidar.watch(['src', '.env', '.env.*'], {
-    cwd: process.cwd()
+    cwd: process.cwd(),
+    ignored: '**/*.test.*'
   });
   watcher.on('all', debounce(async () => {
     await EnvUtil.importFile({
@@ -58,7 +56,6 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
         console.log(`✔️ 索引文件已更新: ${filePath}`);
       }
     });
-
     if (lastRun) {
       console.log('==== 重启服务中 ====');
       lastRun.kill();
@@ -124,15 +121,14 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
   await EnvUtil.importFile({
     cwd: process.cwd(),
     file: '.env'
-  }); // 之所以能成功是因为 Prisma 用的 dotenv 默认不会覆盖已经设置的环境变量
+  });
+  // 之所以能成功是因为 Prisma 用的 dotenv 默认不会覆盖已经设置的环境变量
   // https://github.com/motdotla/dotenv#override
-
   process.env.DATABASE_URL = process.env.DATABASE_ACTION_URL || process.env.DATABASE_URL;
   await execa('tnpx', ['prisma', ...argv._.slice(1), '--schema', 'src/db/schema.prisma'], {
     cwd: process.cwd(),
     stdio: 'inherit'
   });
-
   if (!argv.production) {
     await TemplateUtil.initModels(process.cwd());
   }
@@ -151,14 +147,13 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
     file: '.env'
   });
   process.env.DATABASE_URL = process.env.DATABASE_ACTION_URL || process.env.DATABASE_URL;
-
   if (!argv.script) {
     await execa('tnpx', ['select-run'], {
       cwd: process.cwd(),
       stdio: 'inherit'
     });
   } else {
-    await execa('node', ['-r', require.resolve("./register"), argv.script], {
+    await execa('tsx', [argv.script], {
       cwd: process.cwd(),
       stdio: 'inherit'
     });
@@ -172,7 +167,6 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
     cwd: process.cwd(),
     file: '.env.deploy'
   });
-
   if (argv.type === 'env') {
     const appEnv = await EnvUtil.parseFileAsMap({
       cwd: process.cwd(),

package/lib/cli/deploy_util.js

@@ -6,11 +6,9 @@ export class DeployUtil {
   static async deploy(options) {
     const pkgContent = await fs.readJson(path.join(options.cwd, 'package.json'));
     const appFile = path.join(options.cwd, `temp/app.${pkgContent.version}.tgz`);
-
     if (!(await fs.pathExists(appFile))) {
       throw new Error('请先构建');
     }
-
     const ssh = new NodeSSH();
     await ssh.connect({
       host: options.host,
@@ -44,7 +42,6 @@ export class DeployUtil {
     });
     ssh.dispose();
   }
-
   static async deployEnv(options) {
     const ssh = new NodeSSH();
     await ssh.connect({
@@ -68,5 +65,4 @@ export class DeployUtil {
     });
     ssh.dispose();
   }
-
 }

package/lib/cli/env_util.js

@@ -9,27 +9,21 @@ export class EnvUtil {
         const [devValue, prodValue] = value.split(/\s+\|\|\s+/);
         return devOrProd(() => EnvUtil.normalizeValue(devValue), () => EnvUtil.normalizeValue(prodValue));
       }
-
       return value === 'true' ? true : value === 'false' ? false : value.startsWith('[') && value.endsWith(']') || value.startsWith('{') && value.endsWith('}') ? JSON.parse(value) : isNumeric(value) ? Number(value) : value;
     } else if (value && typeof value === 'object') {
       if (value.dev != null && value.prod != null) {
         return devOrProd(() => value.dev, () => value.prod);
       }
-
       return value;
     }
-
     return value;
   }
-
   static parseContent(src, isYaml = false) {
     const envs = [];
-
     if (isYaml) {
       const envObj = yamlParse(src);
       Object.keys(envObj).forEach(key => {
         var _src$match;
-
         envs.push({
           key: key,
           value: this.normalizeValue(envObj[key]),
@@ -38,56 +32,54 @@ export class EnvUtil {
       });
     } else {
       // https://github.com/andreialecu/dotenv/blob/feat-multiline/lib/main.js
-      const multilineLineBreaks = true; // convert Buffers before splitting into lines and processing
+      const multilineLineBreaks = true;
 
+      // convert Buffers before splitting into lines and processing
       const lines = src.split(EnvUtil.NEWLINES_MATCH);
       let lastComment = '';
-
       for (let idx = 0; idx < lines.length; idx++) {
-        let line = lines[idx]; // matching "KEY' and 'VAL' in 'KEY=VAL'
-
-        const keyValueArr = line.match(EnvUtil.RE_INI_KEY_VAL); // matched?
+        let line = lines[idx];
 
+        // matching "KEY' and 'VAL' in 'KEY=VAL'
+        const keyValueArr = line.match(EnvUtil.RE_INI_KEY_VAL);
+        // matched?
         if (keyValueArr != null) {
-          const key = keyValueArr[1]; // default undefined or missing values to empty string
-
+          const key = keyValueArr[1];
+          // default undefined or missing values to empty string
           let val = keyValueArr[2] || '';
           let end = val.length - 1;
           const isDoubleQuoted = val[0] === '"' && val[end] === '"';
           const isSingleQuoted = val[0] === "'" && val[end] === "'";
           const isMultilineDoubleQuoted = val[0] === '"' && (val.length === 1 || val[end] !== '"');
-          const isMultilineSingleQuoted = val[0] === "'" && (val.length === 1 || val[end] !== "'"); // if parsing line breaks and the value starts with a quote
+          const isMultilineSingleQuoted = val[0] === "'" && (val.length === 1 || val[end] !== "'");
 
+          // if parsing line breaks and the value starts with a quote
           if (multilineLineBreaks && (isMultilineDoubleQuoted || isMultilineSingleQuoted)) {
             const quoteChar = isMultilineDoubleQuoted ? '"' : "'";
             val = val.substring(1);
-
             while (idx++ < lines.length - 1) {
               line = lines[idx];
               end = line.length - 1;
-
               if (line[end] === quoteChar) {
                 val += EnvUtil.NEWLINE + line.substring(0, end);
                 break;
               }
-
               val += EnvUtil.NEWLINE + line;
             }
-
-            val = dedent(val); // if single or double quoted, remove quotes
+            val = dedent(val);
+            // if single or double quoted, remove quotes
           } else if (isSingleQuoted || isDoubleQuoted) {
-            val = val.substring(1, end); // if double quoted, expand newlines
+            val = val.substring(1, end);
 
+            // if double quoted, expand newlines
             if (isDoubleQuoted) {
               val = val.replace(EnvUtil.RE_NEWLINES, EnvUtil.NEWLINE);
             }
-
             val = dedent(val);
           } else {
             // remove surrounding whitespace
             val = dedent(val).trim();
           }
-
           envs.push({
             key: key,
             value: EnvUtil.normalizeValue(val),
@@ -96,58 +88,47 @@ export class EnvUtil {
           lastComment = '';
         } else {
           const commentArr = line.match(EnvUtil.COMMENT_MATCH);
-
           if (commentArr) {
             lastComment = commentArr[1];
           }
         }
       }
     }
-
     return envs;
   }
-
   static async parseFile(options) {
     const envFile = path.join(options.cwd, options.file);
     const envYmlFile = path.join(options.cwd, `${options.file}.yml`);
     const envYamlFile = path.join(options.cwd, `${options.file}.yaml`);
     const file = (await fs.pathExists(envYmlFile)) ? envYmlFile : (await fs.pathExists(envYamlFile)) ? envYamlFile : (await fs.pathExists(envFile)) ? envFile : '';
-
     if (file) {
       const envContent = await fs.readFile(file, 'utf-8');
       const envs = EnvUtil.parseContent(envContent, /\.ya?ml$/i.test(file));
       return envs;
     }
-
     return [];
   }
-
   static async parseFileAsMap(options) {
     const envs = await EnvUtil.parseFile(options);
     const envsObj = {};
-
     for (const env of envs) {
       envsObj[env.key] = env.value;
     }
-
     return envsObj;
   }
-
   static async importFile(options) {
     const envs = await EnvUtil.parseFile(options);
     const envsObj = {};
-
     for (const env of envs) {
       envsObj[env.key] = env.value;
       process.env[env.key] = env.value;
     }
-
-    process.env.X_SERVER_ENVS = JSON.stringify({ // @ts-ignore
+    process.env.X_SERVER_ENVS = JSON.stringify({
+      // @ts-ignore
       ...JSON.parse(process.env.X_SERVER_ENVS || '{}'),
       ...envsObj
     });
   }
-
   static makeTypes(envs) {
     return dedent`
       declare namespace NodeJS {
@@ -168,14 +149,12 @@ export class EnvUtil {
       }
     `;
   }
-
   static async outputTypes(options) {
     const envs = await EnvUtil.parseFile(options);
     const outFile = path.join(options.cwd, options.outFile);
     const types = EnvUtil.makeTypes(envs);
     await fs.outputFile(outFile, types);
   }
-
 }
 EnvUtil.NEWLINE = '\n';
 EnvUtil.RE_INI_KEY_VAL = /^\s*([\w.-]+)\s*=\s*(.*)?\s*$/;

package/lib/cli/template_util.d.ts

@@ -15,4 +15,5 @@ export declare class TemplateUtil {
      * 初始化模型。
      */
     static initModels(cwd: string): Promise<void>;
+    static getPrismaClientTypeFile(): string;
 }