@arkxio/ark-dev-utils 0.1.5 → 0.1.8

package/src/meta-extractor/index.js

@@ -1,84 +1,84 @@
-import fs from 'fs';
-import { verbose } from '../inner-utils/index';
-import { fillAssetListByDist } from './fillAssetList';
-import { parseIndexHtml } from './parse';
-import { getIndexHtmlFileName, makeArkMetaJson } from './utils';
-import path from "path";
-import {noDupPush} from "../inner-utils/arr";
-
-/**
- * 从 index.html 提取资源的描述数据，包含 htmlContent、srcMap
- * @param {import('../../typings').IUserExtractOptions} userExtractOptions
- */
-export default async function extractArkMetaJson(userExtractOptions) {
-  const { buildDirFullPath, writeMetaJsonToDist = true } = userExtractOptions;
-  const appInfo = userExtractOptions.appInfo || userExtractOptions.subApp;
-  const indexHtmlName = userExtractOptions.indexHtmlName || 'index.html';// getIndexHtmlFileName(buildDirFullPath);
-
-  if (!appInfo) {
-    throw new Error('appInfo should be supplied in ver 3.0+ ark-dev-utils: extractArkMetaJson({appInfo, ...})');
-  }
-
-  const { homePage } = appInfo;
-  const options = { ...userExtractOptions, appInfo, subApp: appInfo, indexHtmlName };
-
-  verbose(`start extractArkMetaJson, appHomePage is [${homePage}]`);
-  // 分析 html 入口，提取 sdk 加载需要的资源清单
-  const parsedRet = await parseIndexHtml(options);
-  // 分析构建产物目录，提取剩余的资源清单补充到 chunkJsSrcList chunkCssSrcList 下，以便描述出应用的所有构建产物的资源路径
-  // fillAssetListByDist({ ...userExtractOptions, srcMap: parsedRet.srcMap, homePage, buildDirFullPath });
-  if (userExtractOptions.chunkJsFiles) {
-    for (const chunkJsFile of userExtractOptions.chunkJsFiles) {
-      noDupPush(parsedRet.srcMap.chunkJsSrcList, chunkJsFile);
-
-      noDupPush(parsedRet.srcMap.bodyAssetList, {
-        tag: 'script',
-        append: true,
-        attrs: {
-          src: chunkJsFile,
-          type: 'text/javascript',
-        },
-      });
-    }
-  }
-
-  // 有替换内容生成，则将 index.html 内容重写，让后续上传 cdn 步骤上传的是替换后的文件内容
-  if (parsedRet.hasReplacedContent) {
-    const htmlFilePath = `${buildDirFullPath}/${indexHtmlName}`;
-    fs.writeFileSync(htmlFilePath, parsedRet.htmlContent, { encoding: 'utf-8' });
-  }
-
-  const arkMeta = makeArkMetaJson(options, parsedRet);
-  verbose('userExtractOptions.isDev', userExtractOptions.isDev)
-  if(userExtractOptions.isDev) {
-    // 开发模式：写入内存文件系统
-    const metaFilename = 'ark-meta.json';
-    verbose('[begin] write memory ark meta ' + metaFilename)
-
-    const metaContent = JSON.stringify(arkMeta, null, 2);
-    const compilation = userExtractOptions.compilation;
-
-    // Webpack 5 正确的 API：使用 emitAsset
-    if (compilation.emitAsset) {
-      const { sources } = compilation.compiler.webpack;
-      compilation.emitAsset(
-        metaFilename,
-        new sources.RawSource(metaContent)
-      );
-    } else {
-      // Webpack 4 兼容
-      compilation.assets[metaFilename] = {
-        source: () => metaContent,
-        size: () => metaContent.length
-      };
-    }
-    verbose('[finish] write memory ark meta ' + metaFilename)
-  }else if (writeMetaJsonToDist) {
-    // 生产模式：写入物理文件
-    const arkMetaJsonFile = `${buildDirFullPath}/ark-meta.json`;
-    verbose('finish write ark meta')
-    fs.writeFileSync(arkMetaJsonFile, JSON.stringify(arkMeta, null, 2));
-  }
-
-  return arkMeta;
-}
+import fs from 'fs';
+import { verbose } from '../inner-utils/index';
+import { fillAssetListByDist } from './fillAssetList';
+import { parseIndexHtml } from './parse';
+import { getIndexHtmlFileName, makeArkMetaJson } from './utils';
+import path from "path";
+import {noDupPush} from "../inner-utils/arr";
+
+/**
+ * 从 index.html 提取资源的描述数据，包含 htmlContent、srcMap
+ * @param {import('../../typings').IUserExtractOptions} userExtractOptions
+ */
+export default async function extractArkMetaJson(userExtractOptions) {
+  const { buildDirFullPath, writeMetaJsonToDist = true } = userExtractOptions;
+  const appInfo = userExtractOptions.appInfo || userExtractOptions.subApp;
+  const indexHtmlName = userExtractOptions.indexHtmlName || 'index.html';// getIndexHtmlFileName(buildDirFullPath);
+
+  if (!appInfo) {
+    throw new Error('appInfo should be supplied in ver 3.0+ ark-dev-utils: extractArkMetaJson({appInfo, ...})');
+  }
+
+  const { homePage } = appInfo;
+  const options = { ...userExtractOptions, appInfo, subApp: appInfo, indexHtmlName };
+
+  verbose(`start extractArkMetaJson, appHomePage is [${homePage}]`);
+  // 分析 html 入口，提取 sdk 加载需要的资源清单
+  const parsedRet = await parseIndexHtml(options);
+  // 分析构建产物目录，提取剩余的资源清单补充到 chunkJsSrcList chunkCssSrcList 下，以便描述出应用的所有构建产物的资源路径
+  // fillAssetListByDist({ ...userExtractOptions, srcMap: parsedRet.srcMap, homePage, buildDirFullPath });
+  if (userExtractOptions.chunkJsFiles) {
+    for (const chunkJsFile of userExtractOptions.chunkJsFiles) {
+      noDupPush(parsedRet.srcMap.chunkJsSrcList, chunkJsFile);
+
+      noDupPush(parsedRet.srcMap.bodyAssetList, {
+        tag: 'script',
+        append: true,
+        attrs: {
+          src: chunkJsFile,
+          type: 'text/javascript',
+        },
+      });
+    }
+  }
+
+  // 有替换内容生成，则将 index.html 内容重写，让后续上传 cdn 步骤上传的是替换后的文件内容
+  if (parsedRet.hasReplacedContent) {
+    const htmlFilePath = `${buildDirFullPath}/${indexHtmlName}`;
+    fs.writeFileSync(htmlFilePath, parsedRet.htmlContent, { encoding: 'utf-8' });
+  }
+
+  const arkMeta = makeArkMetaJson(options, parsedRet);
+  verbose('userExtractOptions.isDev', userExtractOptions.isDev)
+  if(userExtractOptions.isDev) {
+    // 开发模式：写入内存文件系统
+    const metaFilename = 'ark-meta.json';
+    verbose('[begin] write memory ark meta ' + metaFilename)
+
+    const metaContent = JSON.stringify(arkMeta, null, 2);
+    const compilation = userExtractOptions.compilation;
+
+    // Webpack 5 正确的 API：使用 emitAsset
+    if (compilation.emitAsset) {
+      const { sources } = compilation.compiler.webpack;
+      compilation.emitAsset(
+        metaFilename,
+        new sources.RawSource(metaContent)
+      );
+    } else {
+      // Webpack 4 兼容
+      compilation.assets[metaFilename] = {
+        source: () => metaContent,
+        size: () => metaContent.length
+      };
+    }
+    verbose('[finish] write memory ark meta ' + metaFilename)
+  }else if (writeMetaJsonToDist) {
+    // 生产模式：写入物理文件
+    const arkMetaJsonFile = `${buildDirFullPath}/ark-meta.json`;
+    verbose('finish write ark meta')
+    fs.writeFileSync(arkMetaJsonFile, JSON.stringify(arkMeta, null, 2));
+  }
+
+  return arkMeta;
+}

package/src/meta-extractor/parse.js

@@ -1,56 +1,56 @@
-/** @typedef {import('../../typings').SrcMap} SrcMap */
-/** @typedef {import('../../typings').IUserExtractOptions} IUserExtractOptions */
-/** @typedef {import('../../typings').IInnerFillAssetListOptions} IInnerFillAssetListOptions */
-import * as fs from 'fs';
-import jsdom from 'jsdom';
-import * as util from 'util';
-import cst from '../configs/consts';
-import { verbose } from '../inner-utils/index';
-import { fillAssetList } from './fillAssetList';
-import { makeAppVersionSrcMap } from './utils';
-
-const readFile = util.promisify(fs.readFile);
-const { JSDOM } = jsdom;
-
-/**
- * @param {IUserExtractOptions} extractOptions
- */
-export async function parseIndexHtml(extractOptions) {
-  const { appInfo, indexHtmlPath, extractMode = 'all', indexHtmlName = cst.DEFAULT_HTML_INDEX_NAME } = extractOptions;
-  const { name, homePage } = appInfo;
-  const htmlFilePath = `${indexHtmlPath}`;
-  verbose(`start to parse ${name} index.html file [${indexHtmlPath}]`);
-
-  let htmlContent = await readFile(htmlFilePath, { encoding: 'UTF-8' });
-  const srcMap = makeAppVersionSrcMap(extractOptions);
-
-  const dom = new JSDOM(htmlContent);
-  const { head, body } = dom.window.document;
-  /** @type {IInnerFillAssetListOptions} */
-  const fillAssetListOptions = { srcMap, homePage, ...extractOptions };
-  const [replaceContentListOfHead, replaceContentLisOfBody] = await Promise.all([
-    fillAssetList(head.children, { ...fillAssetListOptions, isHead: true }),
-    fillAssetList(body.children, fillAssetListOptions),
-  ]);
-
-  replaceContentListOfHead.forEach((item) => {
-    htmlContent = htmlContent.replace(item.toMatch, item.toReplace);
-  });
-  replaceContentLisOfBody.forEach((item) => {
-    htmlContent = htmlContent.replace(item.toMatch, item.toReplace);
-  });
-
-  const shouldRecordHtmlContent = extractMode === 'all' || extractMode === 'build';
-  const htmlContentVar = shouldRecordHtmlContent ? htmlContent : '';
-  if (!shouldRecordHtmlContent) {
-    verbose(`user set extractMode='${extractMode}', dev-utils will ignore write version.html_content`);
-  }
-
-  const hasReplacedContent = replaceContentListOfHead.length || replaceContentLisOfBody.length;
-  const parsedRet = { srcMap, htmlContent: htmlContentVar, hasReplacedContent };
-  verbose(`parse app [${name}] index.html file done!`);
-  verbose('replaceContentListOfHead: ', replaceContentListOfHead);
-  verbose('replaceContentLisOfBody: ', replaceContentLisOfBody);
-  verbose('parsedRet: ', parsedRet);
-  return parsedRet;
-}
+/** @typedef {import('../../typings').SrcMap} SrcMap */
+/** @typedef {import('../../typings').IUserExtractOptions} IUserExtractOptions */
+/** @typedef {import('../../typings').IInnerFillAssetListOptions} IInnerFillAssetListOptions */
+import * as fs from 'fs';
+import jsdom from 'jsdom';
+import * as util from 'util';
+import cst from '../configs/consts';
+import { verbose } from '../inner-utils/index';
+import { fillAssetList } from './fillAssetList';
+import { makeAppVersionSrcMap } from './utils';
+
+const readFile = util.promisify(fs.readFile);
+const { JSDOM } = jsdom;
+
+/**
+ * @param {IUserExtractOptions} extractOptions
+ */
+export async function parseIndexHtml(extractOptions) {
+  const { appInfo, indexHtmlPath, extractMode = 'all', indexHtmlName = cst.DEFAULT_HTML_INDEX_NAME } = extractOptions;
+  const { name, homePage } = appInfo;
+  const htmlFilePath = `${indexHtmlPath}`;
+  verbose(`start to parse ${name} index.html file [${indexHtmlPath}]`);
+
+  let htmlContent = await readFile(htmlFilePath, { encoding: 'UTF-8' });
+  const srcMap = makeAppVersionSrcMap(extractOptions);
+
+  const dom = new JSDOM(htmlContent);
+  const { head, body } = dom.window.document;
+  /** @type {IInnerFillAssetListOptions} */
+  const fillAssetListOptions = { srcMap, homePage, ...extractOptions };
+  const [replaceContentListOfHead, replaceContentLisOfBody] = await Promise.all([
+    fillAssetList(head.children, { ...fillAssetListOptions, isHead: true }),
+    fillAssetList(body.children, fillAssetListOptions),
+  ]);
+
+  replaceContentListOfHead.forEach((item) => {
+    htmlContent = htmlContent.replace(item.toMatch, item.toReplace);
+  });
+  replaceContentLisOfBody.forEach((item) => {
+    htmlContent = htmlContent.replace(item.toMatch, item.toReplace);
+  });
+
+  const shouldRecordHtmlContent = extractMode === 'all' || extractMode === 'build';
+  const htmlContentVar = shouldRecordHtmlContent ? htmlContent : '';
+  if (!shouldRecordHtmlContent) {
+    verbose(`user set extractMode='${extractMode}', dev-utils will ignore write version.html_content`);
+  }
+
+  const hasReplacedContent = replaceContentListOfHead.length || replaceContentLisOfBody.length;
+  const parsedRet = { srcMap, htmlContent: htmlContentVar, hasReplacedContent };
+  verbose(`parse app [${name}] index.html file done!`);
+  verbose('replaceContentListOfHead: ', replaceContentListOfHead);
+  verbose('replaceContentLisOfBody: ', replaceContentLisOfBody);
+  verbose('parsedRet: ', parsedRet);
+  return parsedRet;
+}

package/src/meta-extractor/utils.js

@@ -1,141 +1,141 @@
-/** @typedef {import('../../typings').SrcMap} SrcMap*/
-import * as fs from 'fs';
-import { slash } from '../base-utils/index';
-import cst from '../configs/consts';
-
-export function getIndexHtmlFileName(dirPath) {
-  const names = fs.readdirSync(dirPath);
-  let indexHtmlName = '';
-  let matchCount = 0;
-  names.forEach((name) => {
-    if (name.endsWith('.html')) {
-      matchCount += 1;
-      indexHtmlName = name;
-    }
-  });
-  if (!matchCount) {
-    throw new Error('no index.html found');
-  }
-  if (matchCount > 1) {
-    throw new Error(`there are more than one indexHtml file under [${dirPath}]!`);
-  }
-  return indexHtmlName;
-}
-
-/**
- * 递归获得某个目录下的所有文件绝对路径
- * @param {string} dirPath 形如:/user/zzk/log/build
- * @return {string[]} filePathList
- * 形如 ['/user/zzk/log/build/js/xx.js', '/user/zzk/log/build/img/xx.png']
- */
-export function getAllFilePath(dirPath) {
-  const _getAllFilePath = (dirPath, filePathList) => {
-    const names = fs.readdirSync(dirPath);
-    names.forEach((name) => {
-      const stats = fs.statSync(`${dirPath}/${name}`);
-      if (stats.isDirectory()) {
-        _getAllFilePath(`${dirPath}/${name}`, filePathList);
-      } else {
-        filePathList.push(`${dirPath}/${name}`);
-      }
-    });
-  };
-
-  const filePathList = [];
-  _getAllFilePath(dirPath, filePathList);
-  return filePathList;
-}
-
-/**
- * @param {import('../../typings').IUserExtractOptions} extractOptions
- */
-export function makeAppVersionSrcMap(extractOptions) {
-  const { appInfo, indexHtmlName = cst.DEFAULT_HTML_INDEX_NAME, extractMode = 'all' } = extractOptions;
-  const { homePage } = appInfo;
-  // 用于更新到数据库的app信息，通常来说在构建机器上触发
-  // 从上往下的key顺序也是在html创建的顺序
-  return {
-    webDirPath: homePage,
-    htmlIndexSrc: `${slash.end(homePage)}${indexHtmlName}`,
-    extractMode,
-    iframeSrc: '',
-    chunkCssSrcList: [], //  all build css files
-    chunkJsSrcList: [], // all build js files
-    staticCssSrcList: [], // all static css files
-    staticJsSrcList: [], // all static js files
-    relativeCssSrcList: [], // all relative js files
-    relativeJsSrcList: [], // all relative js files
-    headAssetList: [],
-    bodyAssetList: [],
-    otherSrcList: [],
-  };
-}
-
-/**
- * 从 index.html 提取资源的描述数据，包含 htmlContent、srcMap
- * @param {import('../../typings').IUserExtractOptions} userExtractOptions
- */
-export function makeArkMetaJson(userExtractOptions, parsedRet) {
-  const { packageJson, extractMode = 'build', subApp } = userExtractOptions;
-  const { homePage, groupName, name: appName, semverApi } = subApp;
-
-  /**
-   *  构建版本号，当指定了 homePage 且不想采用默认的版本号生成规则时，才需要透传 buildVer 值
-   *  默认生成规则：
-   *  内网包：裁出 homePage ${cdnHost}/${appZone}/${appName}_${dateStr} 里的 ${appName}_${dateStr} 作为版本号
-   *  外网包：pkg.version
-   */
-  let version = userExtractOptions.buildVer;
-  const packVer = packageJson.version;
-  if (!version) {
-    if (semverApi) {
-      version = packVer;
-    } else {
-      try {
-        // ${cdnHost}/${appZone}/${appName}_${dateStr}
-        const [, restStr] = homePage.split('//');
-        const [, , versionMakeOnPipeline] = restStr.split('/');
-        if (versionMakeOnPipeline) {
-          const arr = versionMakeOnPipeline.split('_');
-          const lastItem = arr[arr.length - 1];
-          // 特征符合 arkpack 的版本号
-          if (lastItem && lastItem.length === 14 && new RegExp('^[1-9]+[0-9]*$').test(lastItem)) {
-            version = versionMakeOnPipeline;
-          }
-        }
-      } catch (err) {}
-
-      if (!version) {
-        // 自定义 homePage 后，版本未必能推导出来，降级为使用 package.json 版本号
-        version = packVer;
-      }
-    }
-  }
-  const repo = packageJson.repository || {};
-
-  // 新增依赖处理逻辑
-  const { dependencies = {}, arkDependencies = {} } = packageJson;
-  const arklibDeps = Object.entries(dependencies)
-    .filter(([name]) => name.indexOf('arklib-') !== -1)
-    .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
-
-  return {
-    app: {
-      name: appName,
-      app_group_name: groupName,
-      git_repo_url: repo.url || packageJson.homepage || '',
-      online_version: version,
-      build_version: version,
-    },
-    version: {
-      plugin_ver: cst.PLUGIN_VER,
-      extract_mode: extractMode,
-      sub_app_name: appName,
-      sub_app_version: version,
-      // ... existing version fields ...
-      arkDependencies: { ...arklibDeps, ...arkDependencies },
-      src_map: parsedRet.srcMap,
-      html_content: parsedRet.htmlContent,
-    },
-  };
-}
+/** @typedef {import('../../typings').SrcMap} SrcMap*/
+import * as fs from 'fs';
+import { slash } from '../base-utils/index';
+import cst from '../configs/consts';
+
+export function getIndexHtmlFileName(dirPath) {
+  const names = fs.readdirSync(dirPath);
+  let indexHtmlName = '';
+  let matchCount = 0;
+  names.forEach((name) => {
+    if (name.endsWith('.html')) {
+      matchCount += 1;
+      indexHtmlName = name;
+    }
+  });
+  if (!matchCount) {
+    throw new Error('no index.html found');
+  }
+  if (matchCount > 1) {
+    throw new Error(`there are more than one indexHtml file under [${dirPath}]!`);
+  }
+  return indexHtmlName;
+}
+
+/**
+ * 递归获得某个目录下的所有文件绝对路径
+ * @param {string} dirPath 形如:/user/zzk/log/build
+ * @return {string[]} filePathList
+ * 形如 ['/user/zzk/log/build/js/xx.js', '/user/zzk/log/build/img/xx.png']
+ */
+export function getAllFilePath(dirPath) {
+  const _getAllFilePath = (dirPath, filePathList) => {
+    const names = fs.readdirSync(dirPath);
+    names.forEach((name) => {
+      const stats = fs.statSync(`${dirPath}/${name}`);
+      if (stats.isDirectory()) {
+        _getAllFilePath(`${dirPath}/${name}`, filePathList);
+      } else {
+        filePathList.push(`${dirPath}/${name}`);
+      }
+    });
+  };
+
+  const filePathList = [];
+  _getAllFilePath(dirPath, filePathList);
+  return filePathList;
+}
+
+/**
+ * @param {import('../../typings').IUserExtractOptions} extractOptions
+ */
+export function makeAppVersionSrcMap(extractOptions) {
+  const { appInfo, indexHtmlName = cst.DEFAULT_HTML_INDEX_NAME, extractMode = 'all' } = extractOptions;
+  const { homePage } = appInfo;
+  // 用于更新到数据库的app信息，通常来说在构建机器上触发
+  // 从上往下的key顺序也是在html创建的顺序
+  return {
+    webDirPath: homePage,
+    htmlIndexSrc: `${slash.end(homePage)}${indexHtmlName}`,
+    extractMode,
+    iframeSrc: '',
+    chunkCssSrcList: [], //  all build css files
+    chunkJsSrcList: [], // all build js files
+    staticCssSrcList: [], // all static css files
+    staticJsSrcList: [], // all static js files
+    relativeCssSrcList: [], // all relative js files
+    relativeJsSrcList: [], // all relative js files
+    headAssetList: [],
+    bodyAssetList: [],
+    otherSrcList: [],
+  };
+}
+
+/**
+ * 从 index.html 提取资源的描述数据，包含 htmlContent、srcMap
+ * @param {import('../../typings').IUserExtractOptions} userExtractOptions
+ */
+export function makeArkMetaJson(userExtractOptions, parsedRet) {
+  const { packageJson, extractMode = 'build', subApp } = userExtractOptions;
+  const { homePage, groupName, name: appName, semverApi } = subApp;
+
+  /**
+   *  构建版本号，当指定了 homePage 且不想采用默认的版本号生成规则时，才需要透传 buildVer 值
+   *  默认生成规则：
+   *  内网包：裁出 homePage ${cdnHost}/${appZone}/${appName}_${dateStr} 里的 ${appName}_${dateStr} 作为版本号
+   *  外网包：pkg.version
+   */
+  let version = userExtractOptions.buildVer;
+  const packVer = packageJson.version;
+  if (!version) {
+    if (semverApi) {
+      version = packVer;
+    } else {
+      try {
+        // ${cdnHost}/${appZone}/${appName}_${dateStr}
+        const [, restStr] = homePage.split('//');
+        const [, , versionMakeOnPipeline] = restStr.split('/');
+        if (versionMakeOnPipeline) {
+          const arr = versionMakeOnPipeline.split('_');
+          const lastItem = arr[arr.length - 1];
+          // 特征符合 arkpack 的版本号
+          if (lastItem && lastItem.length === 14 && new RegExp('^[1-9]+[0-9]*$').test(lastItem)) {
+            version = versionMakeOnPipeline;
+          }
+        }
+      } catch (err) {}
+
+      if (!version) {
+        // 自定义 homePage 后，版本未必能推导出来，降级为使用 package.json 版本号
+        version = packVer;
+      }
+    }
+  }
+  const repo = packageJson.repository || {};
+
+  // 新增依赖处理逻辑
+  const { dependencies = {}, arkDependencies = {} } = packageJson;
+  const arklibDeps = Object.entries(dependencies)
+    .filter(([name]) => name.indexOf('arklib-') !== -1)
+    .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
+
+  return {
+    app: {
+      name: appName,
+      app_group_name: groupName,
+      git_repo_url: repo.url || packageJson.homepage || '',
+      online_version: version,
+      build_version: version,
+    },
+    version: {
+      plugin_ver: cst.PLUGIN_VER,
+      extract_mode: extractMode,
+      sub_app_name: appName,
+      sub_app_version: version,
+      // ... existing version fields ...
+      arkDependencies: { ...arklibDeps, ...arkDependencies },
+      src_map: parsedRet.srcMap,
+      html_content: parsedRet.htmlContent,
+    },
+  };
+}