@tmsfe/tmskit 0.0.5 → 0.0.8

package/src/compile/plugins/mpWxmlDep.js

@@ -0,0 +1,194 @@
+/* eslint-disable no-param-reassign */
+const through = require('through2');
+const htmlparser2 = require('htmlparser2');
+const fs = require('fs');
+const path = require('path');
+const { diffContentCopyFile, ext, fileInDir } = require('../../utils/io');
+const { resolve } = require('../../utils/widgets');
+const { dfsFindCommonDep } = require('./mpCommonDep');
+const { pluginError } = require('./utils/pluginError');
+
+// 处理后缀(源码引入依赖时，不带后缀的情况)
+const extFile = function (name, file) {
+  const extMap = {
+    import: '.wxml',
+    include: '.wxml',
+    wxs: '.wxs',
+  };
+  let extObj = {};
+
+  if (Object.keys(extMap).indexOf(name) > -1 && !file.endsWith(extMap[name])) {
+    extObj = ext(file, [extMap[name]]);
+  }
+  return {
+    extPath: extObj.extPath || '',
+    ext: extObj.ext || '',
+    file: extObj.file || file,
+  };
+};
+
+const dfsFindWxmlDep = function (anaFileOriginFile, anaFileDestFile, isWatch = true) {
+  const resDep = {
+    image: new Map(),
+    wxml: new Map(),
+    wxs: new Map(),
+  };
+  function dfs(anaFileOriginFile, anaFileDestFile) {
+    let contents = '';
+    try {
+      contents = fs.readFileSync(anaFileOriginFile, 'utf8');
+    } catch (e) {
+      pluginError(e, isWatch);
+    }
+    const parser = new htmlparser2.Parser({
+      onopentag(name, attributes) {
+        if (attributes?.src?.startsWith('.')) {
+          const depOriginPath = path.join(path.dirname(anaFileOriginFile), attributes.src);
+          // 被依赖文件加上后缀
+          const { ext, file: depOriginFile, extPath } = extFile(name, depOriginPath);
+
+          if (!fs.existsSync(depOriginFile)) {
+            pluginError(
+              new Error(`${anaFileOriginFile}引用的路径${depOriginFile}找不到应用文件，请检查引用路径`),
+              isWatch,
+            );
+            return;
+          }
+
+          const depDestPath = path.join(path.dirname(anaFileDestFile), attributes.src);
+          const depDestFile = depDestPath.endsWith(ext) ? depDestPath : depDestPath + extPath;
+
+          // 收集wxml依赖
+          if (['import', 'include'].indexOf(name) > -1) {
+            resDep.wxml.set(depDestFile, {
+              anaFileOriginFile,
+              anaFileDestFile,
+              depDestFile,
+              depOriginFile,
+            });
+            dfs(depOriginFile, depDestFile);
+          }
+          // 收集image依赖
+          // if (name === 'image') {
+          //   resDep.image.set(attributes.src, {
+          //     anaFileOriginFile,
+          //     anaFileDestFile,
+          //     depDestFile,
+          //     depOriginFile,
+          //   });
+          //   dfs(depOriginFile, depDestFile);
+          // }
+          // 收集wxs依赖
+          if (name === 'wxs') {
+            resDep.wxs.set(depDestFile, {
+              anaFileOriginFile,
+              anaFileDestFile,
+              depDestFile,
+              depOriginFile,
+            });
+            const defs = dfsFindCommonDep(depOriginFile, depDestFile, ['.wxs']);
+            defs.forEach((item, key) => {
+              resDep.wxs.set(key, item);
+            });
+          }
+        }
+      },
+    });
+    parser.write(contents);
+    parser.end();
+  }
+  dfs(anaFileOriginFile, anaFileDestFile);
+
+  return resDep;
+};
+
+function mpWxmlDep(tmsConfig, module, isWatch) {
+  const stream = through.obj(function (file, enc, cb) {
+    // 依赖分析的文件
+    const anaFileOriginFile = file.history[0];
+    const anaFileRelativeModule = path.relative(resolve(module.from), anaFileOriginFile);
+    const anaFileDestFile = resolve(tmsConfig.outputDir, module.to, anaFileRelativeModule);
+
+    if (file.isBuffer()) {
+      let contents = String(file.contents);
+      const copyModules = new Map();
+      const parser = new htmlparser2.Parser({
+        onopentag(name, attributes) {
+          const nameFilter = ['import', 'include', 'wxs'];
+          if (nameFilter.indexOf(name) > -1 && attributes.src) {
+            const depOriginPath = path.join(path.dirname(anaFileOriginFile), attributes.src);
+            // 处理后缀(源码引入依赖时，后缀不全的情况)
+            const { ext, file: depOriginFile, extPath } = extFile(name, depOriginPath);
+
+            Object.keys(tmsConfig.dependencies).forEach((includeName) => {
+              if (attributes.src.indexOf(includeName) > -1) {
+                const includePath = tmsConfig.dependencies[includeName];
+
+                if (!fileInDir(includePath, depOriginFile)) {
+                  pluginError(
+                    new Error(`${anaFileOriginFile}引用路径${depOriginFile}不在${includePath}不在文件夹内, 请检查应用路径`),
+                    isWatch,
+                  );
+                  return;
+                }
+
+                // eslint-disable-next-line
+                const reg = new RegExp(`^(\./\.\.\/)+.*\/${includeName}\/(.*)`);
+                const regRes = attributes.src.match(reg) || [];
+                if (regRes[2]) {
+                  const depDestPath = resolve(tmsConfig.outputDir, module.to, includeName, regRes[2]);
+                  const depDestFile = depDestPath.endsWith(ext) ? depDestPath : depDestPath + extPath;
+                  if (!copyModules.has(depDestFile)) {
+                    copyModules.set(depDestFile, {
+                      depOriginFile,
+                      depDestFile,
+                      beforeDepPath: attributes.src,
+                      afterDepPath: path.relative(path.dirname(anaFileDestFile), depDestFile).replace(/\\/g, '/'),
+                    });
+                  }
+                }
+              }
+            });
+          }
+        },
+      });
+      parser.write(contents);
+      parser.end();
+
+      // console.log('wxml copyModules', copyModules);
+      copyModules.forEach(({ depOriginFile, depDestFile, beforeDepPath, afterDepPath }) => {
+        if (fs.existsSync(depOriginFile)) {
+          diffContentCopyFile(depOriginFile, depDestFile);
+          const reg = new RegExp(`['"]${beforeDepPath}["']`, 'g');
+          contents = contents.replace(reg, `"${afterDepPath}"`);
+        }
+        if (depOriginFile.endsWith('.wxml')) {
+          const defs = dfsFindWxmlDep(depOriginFile, depDestFile, isWatch);
+          // console.log('wxml defs', defs);
+          [...defs.wxml, ...defs.wxs].forEach(([, item]) => {
+            diffContentCopyFile(item.depOriginFile, item.depDestFile);
+          });
+        }
+        if (depOriginFile.endsWith('.wxs')) {
+          const defs = dfsFindCommonDep(depOriginFile, depDestFile, ['.wxs'], isWatch);
+          // console.log('wxs defs', defs);
+          defs.forEach((item) => {
+            diffContentCopyFile(item.depOriginFile, item.depDestFile);
+          });
+        }
+      });
+
+      file.contents = Buffer.from(contents);
+    }
+
+    this.push(file);
+    cb();
+  });
+
+  return stream;
+}
+
+module.exports = {
+  mpWxmlDep,
+  dfsFindWxmlDep,
+};

package/src/compile/plugins/postcss-font-base64.js

@@ -0,0 +1,72 @@
+/* eslint-disable no-param-reassign */
+const postcss = require('postcss');
+const fs = require('fs');
+const path = require('path');
+const { fail } = require('../../utils/log');
+
+module.exports = postcss.plugin('postcss-font-base64', (options) => {
+  options = {
+    ...options,
+    ...{
+      match: { Scrabble: ['fakefont'] },
+      format: ['eot', 'woff', 'woff2', 'ttf'],
+    },
+  };
+
+  return function (css, result) {
+    css.walkAtRules('font-face', (fontFace) => {
+      const fileTypeRegex = getRegexStringForFileTypes(options.format);
+
+      fontFace.replaceValues(new RegExp(`url\\(["']?.+\\.${fileTypeRegex}["']?\\)`), (attr) => {
+        const fontRePath = attr.replace(/(url|'|"|\(|\)|\?#iefix)/g, '');
+        const fontAbPath = path.join(path.dirname(result.opts.from), fontRePath);
+        const res64 = base64Encode(fontAbPath);
+        const newUrlStr = 'url(data:'.concat(getMimeType(attr)).concat(';charset=utf-8;base64,')
+          .concat(res64)
+          .concat(')');
+        return res64 ? newUrlStr : attr;
+      });
+    });
+
+    function getRegexStringForFileTypes(fileTypes) {
+      const regex = fileTypes.map(fileType => (
+        fileType === 'eot'
+          ? fileType.concat('(\\?#iefix)?')
+          : fileType)).join('|');
+      return regex ? `(${regex})` : '';
+    }
+
+    // helper functions
+    function getMimeType(attribute) {
+      const formats = {
+        '.woff': 'application/font-woff',
+        '.woff2': 'font/woff2',
+        '.ttf': 'application/font-sfnt',
+        '.eot': 'application/vnd.ms-fontobject',
+        '.otf': 'application/font-sfnt',
+      };
+
+      let match = '';
+      const extension = attribute.match(/\.[a-z]{3,4}/)[0];
+
+      if (extension in formats) {
+        match = formats[extension];
+      };
+      return match;
+    };
+
+    function base64Encode(file) {
+      if (fs.existsSync(file)) {
+        return readAndEncodeFile(file);
+      }
+
+      fail(`${file} does not exist.`);
+      return '';
+    }
+
+    function readAndEncodeFile(file) {
+      const bitmap = fs.readFileSync(file);
+      return Buffer.from(bitmap).toString('base64');
+    }
+  };
+});

package/src/compile/plugins/replaceEnv.js

@@ -0,0 +1,29 @@
+const through = require('through2');
+function replaceEnv(reg = /process\.env(\.(\w*))?/g, envData) {
+  const stream = through.obj(function (file, enc, cb) {
+    if (file.isBuffer()) {
+      let contents = String(file.contents);
+      let resReg;
+      // eslint-disable-next-line
+      while ((resReg = reg.exec(contents)) !== null) {
+        const [reg1, reg2, reg3] = resReg;
+        if (reg1 && reg2 && reg3) {
+          const value = typeof envData[reg3] === 'object' ? JSON.stringify(envData[reg3]) : envData[reg3];
+          contents = contents.replace(reg1, value);
+        } else if (reg1 && !reg2 && !reg3) {
+          contents = contents.replace(reg1, JSON.stringify(envData));
+        }
+      }
+
+      // eslint-disable-next-line
+      file.contents = Buffer.from(contents);
+    }
+
+    this.push(file);
+    cb();
+  });
+
+  return stream;
+}
+
+module.exports = replaceEnv;

package/src/compile/plugins/utils/pluginError.js

@@ -0,0 +1,25 @@
+/* eslint-disable no-param-reassign */
+const { fail } = require('../../../utils/log');
+
+function pluginError(error, isWatch) {
+  const errorOptions = { showStack: true };
+
+  errorOptions.error = error;
+  errorOptions.fileName = error.file;
+  errorOptions.lineNumber = error.line;
+  errorOptions.showProperties = false;
+  errorOptions.showStack = false;
+
+  const errMsg = error.message;
+
+  if (isWatch) {
+    fail(errMsg);
+  } else {
+    fail(errMsg);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  pluginError,
+};

package/src/config/constant.js

@@ -1,7 +1,8 @@
 const path = require('path');
+const os = require('os');
 
 // 用户目录
-const HOME_DIR =  process.env.HOME;
+const HOME_DIR = os.homedir();
 
 // 所有文件的缓存目录
 const CACHE_DIR = path.resolve(HOME_DIR, '.tmskit');
@@ -21,10 +22,14 @@ const TMS_NAME = 'tmskit';
 // 脚手架的配置名称
 const TMS_CONFIG_FILENAME = 'tms.config.js';
 
+const TMS_PRIVATE_FILENAME = 'tms.private.config.js';
 
 // 模块代码的默认在modules子目录
 const DEFAULT_MODULE_DIR = 'modules';
 
+// 模块代码的默认在modules子目录
+const DEFAULT_CLOUD_MODULE_DIR = './cloud';
+
 // 模块的配置文件的名称
 const MODULE_CONFIG_FILENAME = 'module.config.json';
 
@@ -34,14 +39,7 @@ const DEFAULT_WEBPACK_ENTRY = {
 };
 
 // 默认从源码拷贝到编译后的配置
-const DEFAULT_COPY_CONFIG = ['package.json', 'app.js', 'app.ts', 'app.less', 'app.wxss', 'sitemap.json'];
-
-// 开发模式
-const MODE = {
-  main: 'tkitmain',
-  all: 'all',
-  multi: 'multi',
-};
+const DEFAULT_COPY_CONFIG = ['package.json', 'sitemap.json'];
 
 const ENV = {
   dev: 'development',
@@ -49,6 +47,7 @@ const ENV = {
 };
 
 const  TEMPLATE_TKIT_DIR = '_tmskit';
+const MODULE_CONFIG_INVALID_KEY = ['entranceDeclare', 'entryPagePath'];
 
 export {
   HOME_DIR,
@@ -57,12 +56,14 @@ export {
   TEMPLATE_PATH,
   TMS_NAME,
   TMS_CONFIG_FILENAME,
+  TMS_PRIVATE_FILENAME,
   DEFAULT_MODULE_DIR,
   MODULE_CONFIG_FILENAME,
   DEFAULT_WEBPACK_ENTRY,
   DEFAULT_COPY_CONFIG,
   MODULE_CODE_DIR,
-  MODE,
   ENV,
   TEMPLATE_TKIT_DIR,
+  MODULE_CONFIG_INVALID_KEY,
+  DEFAULT_CLOUD_MODULE_DIR,
 };

package/src/config/defaultTmsConfig.js

@@ -4,14 +4,13 @@ module.exports = {
   envData: {},
   // 模块配置信息
   modules: [],
-  webpack: {
-    /** 编译输出文件夹位置 */
-    outputDir: 'dist',
-    /** 源码监听路径 */
-    sourceDir: './',
-    /** 源码Map */
-    sourceMap: 'none',
-    /** 别名 */
-    alias: {},
-  },
+  cloudDir: 'cloud',
+  // 第三方依赖代码需要拷贝到本项目的
+  dependencies: {},
+  /** 编译输出文件夹位置 */
+  outputDir: 'dist',
+  /** 源码监听路径 */
+  sourceDir: './',
+  /** 静态资源目录 */
+  static: [],
 };

package/src/core/buildAppJson.js

@@ -0,0 +1,166 @@
+/**
+ * 生成编译后的app.json
+ */
+const fs = require('fs');
+const { MODULE_CONFIG_FILENAME, MODULE_CONFIG_INVALID_KEY } = require('../config/constant');
+const { getModuleConfig, getValidModules } = require('./tmsMpconfig');
+const { fail } = require('../utils/log');
+const { resolve, isObject } = require('../utils/widgets');
+const { handleError } = require('./handleError');
+
+/**
+ * 更新appJson里面的主包配置
+ * @param { object } appJson appJson信息
+ * @param { array } mainPackages 小程序主包信息
+ * @returns { object } appJson小程序主页配置信息
+ */
+function updateMainPackages(appJson, mainPackages = []) {
+  let foundMainPackages = appJson.subpackages.filter(subpackage => mainPackages.includes(subpackage.name));
+  if (foundMainPackages.length === 0) {
+    // 没找到主包
+    foundMainPackages = [appJson.subpackages[0]];
+  }
+  // 拼装 app.pages
+  foundMainPackages.forEach((subpackage) => {
+    if (!subpackage.pages || !subpackage.pages.length) {
+      fail(`主包 ${subpackage} 不能没有 pages`);
+      process.exit(-1);
+    }
+    subpackage.pages.forEach((page) => {
+      appJson.pages.push(`${subpackage.root}/${page}`);
+    });
+    if (subpackage.plugins) {
+      Object.assign(appJson.plugins, subpackage.plugins);
+    }
+  });
+
+  // 去掉 subpackages 中的主包配置
+  const foundMainPackageNames = foundMainPackages.map(item => item.name);
+  // eslint-disable-next-line
+  appJson.subpackages = appJson.subpackages.filter(subpackage => !foundMainPackageNames.includes(subpackage.name));
+
+  return appJson;
+}
+/**
+ * 获取app.json内容
+ * @param {string} sourceAppJsonPath app.json存在的源码路径
+ * @returns
+ */
+const getAppJsonContent = (sourceAppJsonPath) => {
+  if (!fs.existsSync(sourceAppJsonPath)) {
+    fail(`当前路径 ${sourceAppJsonPath} 没找到app.json`);
+    process.exit(1);
+  }
+  const appJson = JSON.parse(fs.readFileSync(sourceAppJsonPath), 'utf-8');
+  // 加入默认值
+  appJson.subpackages = [];
+  appJson.pages = [];
+  // appJson.plugins = {};
+  delete appJson.entranceDeclare;
+  return appJson;
+};
+/**
+ * 更新app.json中的subpackages
+ * @param {Object} appJson
+ * @param {Object} modulesConfig
+ */
+const updateSubpackages = (appJson, modulesConfig) => {
+  // eslint-disable-next-line
+  for (const name in modulesConfig) {
+    const moduleInfo = isObject(modulesConfig[name]) ? [modulesConfig[name]] : modulesConfig[name];
+    // 过滤 pages 为空的情况
+    const validModules = getValidModules(moduleInfo);
+    // eslint-disable-next-line
+    appJson.subpackages = appJson.subpackages.concat(validModules);
+  }
+};
+
+/**
+ * 处理合并subpackages后的appjson, 整理重复不合法的地方
+ * @param {Object} appJson appjson
+ */
+const fixAppJson = (appJson) => {
+  const { subpackages } = appJson;
+  const pluginsMap = {};
+  Object.keys(appJson.plugins || {}).forEach(key => pluginsMap[key] = ['app.json']);
+  const subps = subpackages.map((subp) => {
+    const invalidKeys = [];
+    Object.keys(subp).forEach((key) => {
+      if (key === 'dependencies') {
+        // eslint-disable-next-line
+        delete subp.dependencies;
+        return;
+      }
+      if (key === 'plugins') {
+        Object.keys(subp.plugins).forEach((pk) => {
+          pluginsMap[pk] ? pluginsMap[pk].push(`分包${subp.name}`) : pluginsMap[pk] = [`分包${subp.name}`];
+        });
+        return;
+      }
+      if (MODULE_CONFIG_INVALID_KEY.indexOf(key) > -1) {
+        // 如果分包配置中有不支持的key，则错误提醒
+        invalidKeys.push(key);
+        return;
+      }
+      if (['requiredBackgroundModes', 'embeddedAppIdList'].indexOf(key) > -1) {
+        // 提到appjson最上层处理
+        const preVal = appJson[key];
+        // eslint-disable-next-line
+        preVal ? appJson[key] = Array.from(new Set(preVal
+          // eslint-disable-next-line
+          .slice(0).concat(subp[key]))) : appJson[key] = subp[key].slice(0);
+        return;
+      }
+    });
+    if (invalidKeys.length) {
+      fail(`不支持分包${subp?.name}配置${invalidKeys.join(',')}\n`);
+    }
+    // eslint-disable-next-line
+    invalidKeys.concat(['requiredBackgroundModes', 'embeddedAppIdList']).forEach(k => delete subp[k]);
+    return subp;
+  });
+  // 如果plugins重复，则错误提示
+  const pluginsErrMsg = Object.keys(pluginsMap).map((pk) => {
+    if (pluginsMap[pk].length > 1) {
+      return `${pluginsMap[pk].join(',')}重复配置plugin(${pk});`;
+    }
+    return '';
+  })
+    .reduce((pre, cur) => pre + cur, '');
+  if (pluginsErrMsg) {
+    fail(`plugins配置出现错误:${pluginsErrMsg}`);
+  }
+  // eslint-disable-next-line
+  appJson.subpackages = subps;
+};
+
+/**
+ * 动态生成编译后的app.json
+ * @param {object} tmsConfig
+ * @param {array} modules 用户要编译的模块列表
+ * @returns
+ */
+function buildOutputAppJson(tmsConfig, modules) {
+  try {
+    // 获取当前 modules 下的所有子模块的配置内容
+    const modulesConfig = getModuleConfig(modules, tmsConfig.appName, MODULE_CONFIG_FILENAME);
+    // 获取app.json的配置
+    const appJson = getAppJsonContent(resolve('./app.json'));
+    // 更新app.json中的subpackages
+    updateSubpackages(appJson, modulesConfig);
+    // 处理appJson中重复||冲突的地方
+    fixAppJson(appJson);
+    // 更新主包，需在subpackages处理完成后执行， pages/
+    updateMainPackages(appJson, tmsConfig.mainPackages);
+
+    fs.writeFileSync(resolve(`${tmsConfig.outputDir}/app.json`), JSON.stringify(appJson, null, 2), 'utf8');
+
+    return appJson;
+  } catch (e) {
+    handleError(`生成app.json出现错误: ${e}`);
+  }
+}
+
+module.exports = {
+  buildOutputAppJson,
+};

package/src/{utils → core}/checkDependencies.js

@@ -1,9 +1,9 @@
 const fs = require('fs');
 const semver = require('semver');
-const { resolve } = require('./widgets');
+const { resolve } = require('../utils/widgets');
 const path = require('path');
-const { fail } = require('./log');
 const shelljs = require('shelljs');
+const { handleError } = require('./handleError');
 
 const getLatestVersion = (npmName) => {
   const data = shelljs.exec(`npm view ${npmName} version`);
@@ -41,12 +41,12 @@ const checkDependencies = (modules, cwd, outputDir) => {
   // 步骤2. 比较package.json的依赖与node_modules依赖的版本号
   for (const item of packageArr) {
     const packageJson = fs.readFileSync(item.srcPackageDir, 'utf-8');
-    let dependencies;
+    let dependencies = {};
     try {
-      dependencies = JSON.parse(packageJson).dependencies;
+      const json = JSON.parse(packageJson);
+      dependencies = json?.dependencies ? json?.dependencies : {};
     } catch (e) {
-      fail(`解析${packageJson}报错，请检查是否是正确的json配置项`);
-      process.exit(1);
+      handleError(`解析${item.srcPackageDir}报错，请检查是否是正确的json配置项 ${e}`);
     }
     const dependenciesKeys = Object.keys(dependencies);
     for (const key of dependenciesKeys) {