@tmsfe/tmskit 0.0.37 → 0.0.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tmskit",
-  "version": "0.0.37",
+  "version": "0.0.39",
   "description": "tmskit",
   "main": "dist/index.cjs",
   "bin": {
@@ -53,6 +53,8 @@
     "gulp-watch": "^5.0.1",
     "htmlparser2": "^7.2.0",
     "inquirer": "^7.3.3",
+    "json5": "^2.2.3",
+    "preprocess": "^3.2.0",
     "leven": "3.1.0",
     "lodash": "^4.17.21",
     "metalsmith": "^2.3.0",

package/src/compile/compile.js

@@ -13,13 +13,13 @@ const getTargetFile = (sourceFile, module, outputDir) => {
   return targetFile;
 };
 
-const addPlugins =  function (tmsConfig, srcPipe, pluginParams) {
+const addPlugins = function (tmsConfig, srcPipe, pluginParams) {
   const { plugins = [] } = tmsConfig;
   const newPlugins = [{
     glob: '**/project.config.json',
     action: mpProjectJson(),
   }, ...plugins];
-  return newPlugins.reduce((srcPipe, pluginItem) => srcPipe.pipe(gulpif(
+  return newPlugins.reduce((currentPipe, pluginItem) => currentPipe.pipe(gulpif(
     vinyl => minimatch(vinyl.path, pluginItem.glob),
     through.obj(function (vinyl, enc, next) {
       const sourceFile = vinyl.history[0];
@@ -55,6 +55,12 @@ module.exports = function (
         const newGlobValue = Array.isArray(sourceFile) ? sourceFile : glob;
         const newDestPath = targetPath ? targetPath : destPath;
         let srcPipe = src(newGlobValue, { ...srcOption });
+
+        // 在文件读取后，插件处理之前先加入模板渲染插件
+        const templateRender = require('./plugins/tmsTemplateRender');
+        srcPipe = srcPipe.pipe(templateRender(tmsConfig));
+
+        // 后续步骤继续执行其他插件
         const pluginParams = { module, isDev };
         srcPipe = addPlugins(tmsConfig, srcPipe, pluginParams);
         return srcPipe

package/src/compile/dev.js

@@ -72,8 +72,12 @@ module.exports = async (tmsConfig, modules, isDev = true) => {
       return `!${resolve(srcModulePath, newPath)}/**/*`;
     });
 
+    const moduleConfigPath = `${srcModulePath}/**/module.config.json`;
+
+    const moduleConfigGlob = tmsConfig.isKeepModuleConfig ? `${moduleConfigPath}` : `!${moduleConfigPath}`;
+
     mergeMap(compileTasksMap, compile(tmsConfig, {
-      glob: [`${srcModulePath}/**/*`, `!${srcModulePath}/**/module.config.json`, ...excludes],
+      glob: [`${srcModulePath}/**/*`, moduleConfigGlob, ...excludes],
       destPath: buildModulePath,
       module: { from: srcModulePath, to: buildModulePath },
       srcOption: { allowEmpty: true },

package/src/compile/plugins/tmsTemplateRender.js

@@ -0,0 +1,122 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+const through = require('through2');
+const pp = require('preprocess');
+const path = require('path');
+const chalk = require('chalk');
+/* eslint-enable @typescript-eslint/no-require-imports */
+
+// 允许渲染的文件类型列表
+const TEMPLATE_FILE_EXTENSIONS = [
+  '.json',
+  '.js',
+  '.ts',
+  '.wxml',
+  '.wxss',
+  '.wxs',
+  '.css',
+  '.less',
+  '.scss',
+];
+
+/**
+ * 获取预处理器类型
+ * @param {string} extName 文件扩展名
+ * @returns {string} 预处理器类型
+ */
+const getPreprocessType = (extName) => {
+  const type = extName.replace('.', '');
+  if (type === 'wxml') return 'html';
+  if (type === 'wxs') return 'js';
+  if (type === 'wxss') return 'css';
+  return type;
+};
+
+/**
+ * 获取错误上下文信息
+ * @param {string} content 文件内容
+ * @param {number} errorLine 错误行号
+ * @param {number} contextLines 上下文行数
+ * @returns {string} 格式化的错误上下文
+ */
+const getErrorContext = (content, errorLine, contextLines = 2) => {
+  const lines = content.split('\n');
+  const start = Math.max(1, errorLine - contextLines);
+  const end = Math.min(lines.length, errorLine + contextLines);
+
+  let context = '';
+  for (let i = start; i <= end; i++) {
+    const marker = i === errorLine ? ' >> ' : '    ';
+    context += `${marker}${i}| ${lines[i - 1]}\n`;
+  }
+  return context;
+};
+
+/**
+ * 打印错误信息
+ * @param {string} filePath 文件路径
+ * @param {string} context 错误上下文
+ * @param {Error} error 错误对象
+ */
+const printError = (filePath, context, error) => {
+  console.error(`${chalk.yellow('渲染模板出错，请检查处理:')
+  }\n${
+    chalk.yellow('文件:')
+  }\n${
+    chalk.yellow(filePath)
+  }\n${
+    chalk.yellow('错误位置:')
+  }\n${
+    chalk.gray(context)
+  }\n${
+    chalk.red('错误信息:')
+  }\n${
+    chalk.red(error.message)
+  }\n${
+    chalk.gray('--------------------------------')}`);
+};
+
+/**
+ * 模板渲染插件
+ * @param {Object} tmsConfig 配置对象
+ * @returns {Object} through2 转换流
+ */
+module.exports = function tmsTemplateRender(tmsConfig) {
+  return through.obj((file, encoding, callback) => {
+    if (!file.isBuffer()) {
+      return callback(null, file);
+    }
+
+    const extName = path.extname(file.path).toLowerCase();
+    if (!TEMPLATE_FILE_EXTENSIONS.includes(extName)) {
+      return callback(null, file);
+    }
+
+    const content = file.contents.toString(encoding);
+    try {
+      const vars = tmsConfig.templateVars || {};
+      const ppType = getPreprocessType(extName);
+      // 手动检查 @echo 引用的变量是否存在
+      const echoPattern = /\/\* @echo (\w+) \*\//g;
+      let match;
+      while ((match = echoPattern.exec(content)) !== null) {
+        const variableName = match[1];
+        // eslint-disable-next-line no-prototype-builtins
+        if (!vars.hasOwnProperty(variableName)) {
+          const error = new Error(`变量 ${variableName} 未定义`);
+          error.line = content.substring(0, match.index).split('\n').length;
+          throw error;
+        }
+      }
+      const rendered = pp.preprocess(content, vars, ppType);
+      // eslint-disable-next-line no-param-reassign
+      file.contents = Buffer.from(rendered);
+    } catch (err) {
+      const context = getErrorContext(content, err.line || 1);
+      printError(file.path, context, err);
+      // 直接抛出异常，中断编译流程
+      throw new Error(`模板渲染失败: ${file.path}\n${err.message}`);
+    }
+
+    callback(null, file);
+  });
+};

package/src/core/buildAppJson.js

@@ -3,6 +3,7 @@
  */
 /* eslint-disable no-param-reassign */
 const fs = require('fs');
+const pp = require('preprocess');
 const { getSubPackages, getModulesConfig } = require('./tmsMpconfig');
 const { fail, info } = require('../utils/log');
 const { resolve, filterField } = require('../utils/widgets');
@@ -19,7 +20,7 @@ const report = require('../core/report');
  */
 function updateMainPackages(appJson, mainPackages = []) {
   let foundMainPackages = appJson.subpackages.filter(subpackage => mainPackages.includes(subpackage.name));
-  if (foundMainPackages.length === 0) {
+  if (foundMainPackages.length === 0 && appJson.pages.length === 0) {
     // 没找到主包
     foundMainPackages = [appJson.subpackages[0]];
   }
@@ -30,7 +31,10 @@ function updateMainPackages(appJson, mainPackages = []) {
       process.exit(-1);
     }
     subpackage.pages.forEach((page) => {
-      appJson.pages.push(`${subpackage.root}/${page}`);
+      const pagePath = `${subpackage.root}/${page}`;
+      if (!appJson.pages.includes(pagePath)) {
+        appJson.pages.push(pagePath);
+      }
     });
     if (subpackage.plugins) {
       Object.assign(appJson.plugins, subpackage.plugins);
@@ -55,8 +59,8 @@ const getAppJsonContent = (sourceAppJsonPath) => {
   }
   const appJson = JSON.parse(fs.readFileSync(sourceAppJsonPath), 'utf-8');
   // 加入默认值
-  appJson.subpackages = [];
-  appJson.pages = [];
+  appJson.subpackages = appJson.subpackages || [];
+  appJson.pages = appJson.pages || [];
   return appJson;
 };
 
@@ -123,11 +127,11 @@ const fixAppJson = (appJson) => {
 async function buildOutputAppJson(tmsConfig, modules) {
   try {
     // 获取所有模块，合并模块依赖的模块
-    const modulesConfig = getModulesConfig(modules, tmsConfig.appName, false);
+    const modulesConfig = getModulesConfig(modules, tmsConfig, false);
     // 获取所有的分包
     const subPackages = getSubPackages(modulesConfig);
     // 获取app.json的配置
-    const appJson = getAppJsonContent(resolve('./app.json'));
+    let appJson = getAppJsonContent(resolve('./app.json'));
 
     // 更新app.json中的subpackages
     appJson.subpackages = subPackages;
@@ -138,7 +142,12 @@ async function buildOutputAppJson(tmsConfig, modules) {
     // 更新主包，需在subpackages处理完成后执行， pages/
     updateMainPackages(appJson, tmsConfig.mainPackages);
 
-    fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), JSON.stringify(appJson, null, 2), 'utf8');
+    // 模板渲染：先将 app.json 转为字符串，然后通过 preprocess 渲染
+    const appJsonStr = JSON.stringify(appJson, null, 2);
+    const preprocessedStr = pp.preprocess(appJsonStr, tmsConfig.templateVars || {},  'json');
+    fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), preprocessedStr, 'utf8');
+
+    appJson = JSON.parse(preprocessedStr);
 
     if (typeof tmsConfig?.hooks?.updateAppJson === 'function') {
       await tmsConfig?.hooks?.updateAppJson({

package/src/core/mpCi.js

@@ -114,8 +114,22 @@ const uploadMp = async (params = {}) => {
   });
 };
 
+const getDevSourceMap = async (params = {}) => {
+  const { appId, projectPath, privateKey, robot, sourceMapSavePath } = params;
+  const project = await getMpCi({
+    appId,
+    projectPath,
+    privateKey,
+  });
+  return await ci.getDevSourceMap({
+    project,
+    robot,
+    sourceMapSavePath,
+  });
+};
 module.exports = {
   buildMpNpm,
   previewMp,
   uploadMp,
+  getDevSourceMap,
 };

package/src/core/tmsMpconfig.js

@@ -5,6 +5,8 @@
 const loadash = require('lodash');
 const fs = require('fs');
 const path = require('path');
+const pp = require('preprocess');
+const JSON5 = require('json5');
 const { TMS_CONFIG_FILENAME, MODULE_CONFIG_FILENAME, TMS_PRIVATE_FILENAME } = require('../config/constant');
 const { resolve, isObject, isArray, getAbsolutePath } = require('../utils/widgets');
 const defaultTmsConfig = require('../config/defaultTmsConfig');
@@ -57,9 +59,15 @@ const getTmsConfig = (configPath) => {
     modules.all = tmsConfig.modules;
     tmsConfig.modules = modules;
   }
-  // 合并默认值
-  const res = loadash.mergeWith(tmsConfig, tmsPrivateCf, (objValue, srcValue) => {
-    if (loadash.isArray(objValue) && objValue[0] && loadash.isObject(objValue[0])) {
+  // 使用自定义的合并策略：
+  // 1. 对 templateVars 字段做浅合并（即把 tms.config.js 中的和 tms.private.config.js 中的对象合并，
+  //    如果存在同名字段则以 tms.private.config.js 中的为准）。
+  // 2. 对数组（并且数组元素为对象的情况）执行拼接
+  const res = loadash.mergeWith({}, tmsConfig, tmsPrivateCf, (objValue, srcValue, key) => {
+    if (key === 'templateVars') {
+      return { ...(objValue || {}), ...(srcValue || {}) };
+    }
+    if (Array.isArray(objValue) && objValue[0] && isObject(objValue[0])) {
       return objValue.concat(srcValue);
     }
   });
@@ -128,13 +136,18 @@ const adaptSubPackages = function (moduleConfig, appName) {
  * @param {array} modules 用户要编译的模块列表
  * @param { string } appName 小程序的名称
  */
-function getModulesConfig(modules = [], appName) {
+function getModulesConfig(modules = [], tmsConfig) {
+  const { appName } = tmsConfig;
   const modulesConfig = [];
   modules.forEach((moduleItem) => {
     const moduleConfigPath = resolve(moduleItem.path, MODULE_CONFIG_FILENAME);
     let moduleConfig;
     try {
-      moduleConfig = JSON.parse(fs.readFileSync(moduleConfigPath, 'utf-8'));
+      // 模板渲染：先将 module.config.json 转为字符串，然后通过 preprocess 渲染
+      const moduleConfigJsonStr = fs.readFileSync(moduleConfigPath, 'utf-8');
+      const preprocessedStr = pp.preprocess(moduleConfigJsonStr, tmsConfig.templateVars || {}, 'json');
+      // fs.writeFileSync(resolve(moduleConfigPath), moduleConfigJsonStr, 'utf8');
+      moduleConfig = JSON5.parse(preprocessedStr);
     } catch (e) {
       throw new Error(`${moduleConfigPath}json解析报错: ${e}`);
     }
@@ -241,11 +254,11 @@ const getModulesByMergeDepModules = (tmsConfig, modules, errorIsQuit = false) =>
           allModules.set(moduleItem.moduleName, moduleItem);
         }
         if (errorIsQuit) {
-          throw new Error(`${moduleItem.moduleName}模块的配置文件module.config.json在${moduleItem.path}目录下没有找到`);
+          throw new Error(`${moduleItem.moduleName}模块的配置文件module.config.json在${moduleItem.path}目录下没有找到 ${moduleConfigPath}`);
         }
         return;
       }
-      const [moduleConfig = {}] = getModulesConfig([moduleItem], tmsConfig.appName);
+      const [moduleConfig = {}] = getModulesConfig([moduleItem], tmsConfig);
 
       if (!allModules.has(moduleItem.moduleName)) {
         allModules.set(moduleItem.moduleName, checkModuleItem(tmsConfig, moduleItem, moduleConfig));

package/src/entry.js

@@ -81,6 +81,15 @@ module.exports = [
           require('./scripts/run/index')('upload', cmdOptions);
         },
       },
+      {
+        command: 'sourcemap',
+        description: '获取sourcemap',
+        options: [
+        ],
+        action: (cmdOptions) => {
+          require('./scripts/run/index')('sourcemap', cmdOptions);
+        },
+      },
       {
         command: 'cloud-dev',
         description: '云函数开发',

package/src/scripts/run/dev/index.js

@@ -2,6 +2,7 @@ const shelljs = require('shelljs');
 const compileDev = require('../../../compile/dev');
 const { resolve, filterField } = require('../../../utils/widgets');
 const init = require('../init/index');
+const { buildOutputAppJson } = require('../../../core/buildAppJson');
 const { getModulesByMergeDepModules, getSubPackages } = require('../../../core/tmsMpconfig');
 const { info } = require('../../../utils/log');
 const { global } = require('../../../utils/global');
@@ -40,6 +41,9 @@ async function dev(tmsConfig, targetModules) {
   // 初始化操作
   const { subPackages, modules: newModules } = await init(tmsConfig, targetModules);
 
+  // 在启动开发环境前主动执行生成 app.json
+  await buildOutputAppJson(tmsConfig, newModules);
+
   info('当前dev启动的有效模块', newModules.map(item => item.moduleName).sort());
   if (typeof tmsConfig?.hooks?.beforeFirstCompile === 'function') {
     await tmsConfig?.hooks?.beforeFirstCompile({

package/src/scripts/run/index.js

@@ -5,6 +5,7 @@ const build = require('./build/index');
 const install = require('./install/index');
 const preview = require('./preview/index');
 const upload = require('./upload/index');
+const sourcemap = require('./sourcemap/index');
 const cloudLink = require('./cloud/link');
 const cloudDev = require('./cloud/dev');
 const { fail, info } = require('../../utils/log');
@@ -121,6 +122,10 @@ function otherCommands(tmsConfig, commandName, cmdOptions) {
       upload(tmsConfig, cmdOptions);
       report('run:upload', { appName: tmsConfig.appName });
       return;
+    case 'sourcemap':
+      sourcemap(tmsConfig);
+      report('run:sourcemap', { appName: tmsConfig.appName });
+      return;
     default:
       return;
   }

package/src/scripts/run/sourcemap/index.js

@@ -0,0 +1,48 @@
+const mpCi = require('../../../core/mpCi');
+const { resolve, createTask } = require('../../../utils/widgets');
+const { handleError } = require('../../../core/handleError');
+const { info } = require('../../../utils/log');
+const { getDesc } = require('../preview/utils');
+const report = require('../../../core/report');
+
+const handleParams = (tmsConfig, cmdOptions) => {
+  const params = {
+    ...(tmsConfig.upload ? tmsConfig.upload : {}),
+    ...cmdOptions,
+  };
+
+  return {
+    sourceMapSavePath: './sourcemap.zip',
+    ...params,
+    appId: params.appId || tmsConfig.appId,
+    projectPath: resolve(tmsConfig.outputDir),
+    privateKey: params.privateKey || tmsConfig.privateKey,
+    robot: params.robot || 30,
+    desc: params.desc || getDesc(params.desc),
+  };
+};
+
+/**
+ * 获取sourcemap
+ * @param {object} tmsConfig
+ * @param {object} cmdOptions {version: '2022.28.5', desc: '', robot: 2, infoOutput: './a.txt' }
+ */
+async function sourcemap(tmsConfig, cmdOptions) {
+  try {
+    const params = handleParams(tmsConfig, cmdOptions);
+    report('sourcemap');
+
+    await createTask(
+      mpCi.getDevSourceMap,
+      '正在获取小程序代码sourcemap',
+      '获取小程序代码sourcemap完成',
+    )({
+      ...params,
+    });
+    info(`sourcemap文件已保存到${params.sourceMapSavePath}`);
+  } catch (e) {
+    console.log('详细错误:', e);
+    handleError(`获取sourcemap错误: ${e.message}`, true);
+  }
+}
+module.exports = sourcemap;