@arkxio/ark-dev-utils 0.1.6 → 0.1.9

package/src/inner-utils/index.js

@@ -1,124 +1,124 @@
-/** @typedef {import('../../typings').FileDesc} FileDesc*/
-import * as fs from 'fs';
-import cst from '../configs/consts';
-
-/**
- * 递归获得某个目录下的所有文件绝对路径
- * @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;
-}
-
-/**
- * 生成符合上传cos的文件描述对象列表
- * @return {FileDesc[]} fileDescList
- */
-export function makeFileDescList(fileFullPathList, appHomePage, splitStrForFilePathUnderBuild = 'build/') {
-  const fileDescList = [];
-  const appVersion = getAppVersionFromHomePage(appHomePage);
-  const zoneName = getZoneNameFromHomePage(appHomePage);
-
-  fileFullPathList.forEach((fileAbsolutePath) => {
-    // 获取文件处于build目录下的相对路径，形如：
-    //  /static/js/runtime-main.66c45929.js
-    //  /asset-manifest.json
-    const filePathUnderBuild = fileAbsolutePath.split(splitStrForFilePathUnderBuild)[1];
-
-    fileDescList.push({
-      fileAbsolutePath,
-      fileWebPathWithoutHost: `${zoneName}/${appVersion}/${filePathUnderBuild}`,
-      fileWebPath: `${appHomePage}/${filePathUnderBuild}`,
-    });
-  });
-
-  return fileDescList;
-}
-
-export function verbose(...args) {
-  console.log('[Ark-verbose:] ', ...args);
-}
-
-/**
- * verbose with handler
- * @param {} argHandler
- * @param  {...any} args
- */
-export function verboseH(argHandler, ...args) {
-  const handledArgs = args.map((arg, idx) => argHandler(arg, idx));
-  verbose(...handledArgs);
-}
-
-/**
- * stringify obj in args
- * @param  {...any} args
- */
-export function verboseObj(...args) {
-  verboseH((arg) => {
-    if (typeof arg === 'object') return JSON.stringify(arg);
-    return arg;
-  }, ...args);
-}
-
-/**
- * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
- * output: https://xxxxx.yy.com
- * @param {string} homePage
- */
-export function getCdnHostFromHomePage(homePage) {
-  const [protocolStr, restStr] = homePage.split('//');
-  const [hostName] = restStr.split('/');
-  return `${protocolStr}//${hostName}`;
-}
-
-/**
- * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
- * output: <relativeDirName>
- * @param {string} homePage
- * @return {string} appVersion
- */
-export function getAppVersionFromHomePage(homePage) {
-  const arr = homePage.split('/');
-  return arr[arr.length - 1];
-}
-
-/**
- * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
- * output: <zoneName>
- * @param {string} homePage
- * @return {string} appVersion
- */
-export function getZoneNameFromHomePage(homePage) {
-  const arr = homePage.split('/');
-  return arr[arr.length - 2];
-}
-
-const cdnType2host = {
-  unpkg: 'https://unpkg.com',
-  jsdelivr: 'https://cdn.jsdelivr.net/npm',
-};
-
-export function getNpmCdnHomePage(packageJson, options) {
-  const { npmCdnType = cst.DEFAULT_NPM_CDN_TYPE, distDir = cst.ARK_DIST_DIR, homePage } = options;
-  const { name, version } = packageJson;
-  // 优先考虑用户透传的 homePage，表示用户部署了 unpkg 私服
-  const unpkgHost = homePage || cdnType2host[npmCdnType] || '';
-  // TODO，未来考虑更多类型的 cdn，如：jsdelivr
-  return `${unpkgHost}/${name}@${version}/${distDir}`;
-}
+/** @typedef {import('../../typings').FileDesc} FileDesc*/
+import * as fs from 'fs';
+import cst from '../configs/consts';
+
+/**
+ * 递归获得某个目录下的所有文件绝对路径
+ * @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;
+}
+
+/**
+ * 生成符合上传cos的文件描述对象列表
+ * @return {FileDesc[]} fileDescList
+ */
+export function makeFileDescList(fileFullPathList, appHomePage, splitStrForFilePathUnderBuild = 'build/') {
+  const fileDescList = [];
+  const appVersion = getAppVersionFromHomePage(appHomePage);
+  const zoneName = getZoneNameFromHomePage(appHomePage);
+
+  fileFullPathList.forEach((fileAbsolutePath) => {
+    // 获取文件处于build目录下的相对路径，形如：
+    //  /static/js/runtime-main.66c45929.js
+    //  /asset-manifest.json
+    const filePathUnderBuild = fileAbsolutePath.split(splitStrForFilePathUnderBuild)[1];
+
+    fileDescList.push({
+      fileAbsolutePath,
+      fileWebPathWithoutHost: `${zoneName}/${appVersion}/${filePathUnderBuild}`,
+      fileWebPath: `${appHomePage}/${filePathUnderBuild}`,
+    });
+  });
+
+  return fileDescList;
+}
+
+export function verbose(...args) {
+  console.log('[Ark-verbose:] ', ...args);
+}
+
+/**
+ * verbose with handler
+ * @param {} argHandler
+ * @param  {...any} args
+ */
+export function verboseH(argHandler, ...args) {
+  const handledArgs = args.map((arg, idx) => argHandler(arg, idx));
+  verbose(...handledArgs);
+}
+
+/**
+ * stringify obj in args
+ * @param  {...any} args
+ */
+export function verboseObj(...args) {
+  verboseH((arg) => {
+    if (typeof arg === 'object') return JSON.stringify(arg);
+    return arg;
+  }, ...args);
+}
+
+/**
+ * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
+ * output: https://xxxxx.yy.com
+ * @param {string} homePage
+ */
+export function getCdnHostFromHomePage(homePage) {
+  const [protocolStr, restStr] = homePage.split('//');
+  const [hostName] = restStr.split('/');
+  return `${protocolStr}//${hostName}`;
+}
+
+/**
+ * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
+ * output: <relativeDirName>
+ * @param {string} homePage
+ * @return {string} appVersion
+ */
+export function getAppVersionFromHomePage(homePage) {
+  const arr = homePage.split('/');
+  return arr[arr.length - 1];
+}
+
+/**
+ * input : https://xxxxx.yy.com/<zoneName>/<relativeDirName>
+ * output: <zoneName>
+ * @param {string} homePage
+ * @return {string} appVersion
+ */
+export function getZoneNameFromHomePage(homePage) {
+  const arr = homePage.split('/');
+  return arr[arr.length - 2];
+}
+
+const cdnType2host = {
+  unpkg: 'https://unpkg.com',
+  jsdelivr: 'https://cdn.jsdelivr.net/npm',
+};
+
+export function getNpmCdnHomePage(packageJson, options) {
+  const { npmCdnType = cst.DEFAULT_NPM_CDN_TYPE, distDir = cst.ARK_DIST_DIR, homePage } = options;
+  const { name, version } = packageJson;
+  // 优先考虑用户透传的 homePage，表示用户部署了 unpkg 私服
+  const unpkgHost = homePage || cdnType2host[npmCdnType] || '';
+  // TODO，未来考虑更多类型的 cdn，如：jsdelivr
+  return `${unpkgHost}/${name}@${version}/${distDir}`;
+}

package/src/inner-utils/obj.js

@@ -1,45 +1,45 @@
-export function okeys(obj) {
-  return Object.keys(obj);
-}
-
-/**
- *
- * @param value
- * @param {{nullValues: any[], isEmptyObjNull: boolean, isEmptyArrNull: boolean}} nullDef - 空定义
- */
-export function isNull(value, nullDef = {}) {
-  const { nullValues = [null, undefined, ''], isEmptyObjNull = true, isEmptyArrNull = true } = nullDef;
-
-  const inNullValues = nullValues.includes(value);
-  if (inNullValues) {
-    return true;
-  }
-
-  if (Array.isArray(value)) {
-    if (isEmptyArrNull) return value.length === 0;
-    return false;
-  }
-
-  if (typeof value === 'object') {
-    if (isEmptyObjNull) return okeys(value).length === 0;
-    return false;
-  }
-
-  return false;
-}
-
-/**
- *
- * @param {{[key:string]: any}} obj
- * @param {(value:any, key:string)=>boolean} judgeValueValid - 判断value有效的函数
- */
-export function purify(obj, judgeValueValid) {
-  // isValidVal or isNull
-  const isValid = judgeValueValid || ((value) => !isNull(value));
-  const pureObj = {};
-  okeys(obj).forEach((key) => {
-    const value = obj[key];
-    if (isValid(value, key)) pureObj[key] = value;
-  });
-  return pureObj;
-}
+export function okeys(obj) {
+  return Object.keys(obj);
+}
+
+/**
+ *
+ * @param value
+ * @param {{nullValues: any[], isEmptyObjNull: boolean, isEmptyArrNull: boolean}} nullDef - 空定义
+ */
+export function isNull(value, nullDef = {}) {
+  const { nullValues = [null, undefined, ''], isEmptyObjNull = true, isEmptyArrNull = true } = nullDef;
+
+  const inNullValues = nullValues.includes(value);
+  if (inNullValues) {
+    return true;
+  }
+
+  if (Array.isArray(value)) {
+    if (isEmptyArrNull) return value.length === 0;
+    return false;
+  }
+
+  if (typeof value === 'object') {
+    if (isEmptyObjNull) return okeys(value).length === 0;
+    return false;
+  }
+
+  return false;
+}
+
+/**
+ *
+ * @param {{[key:string]: any}} obj
+ * @param {(value:any, key:string)=>boolean} judgeValueValid - 判断value有效的函数
+ */
+export function purify(obj, judgeValueValid) {
+  // isValidVal or isNull
+  const isValid = judgeValueValid || ((value) => !isNull(value));
+  const pureObj = {};
+  okeys(obj).forEach((key) => {
+    const value = obj[key];
+    if (isValid(value, key)) pureObj[key] = value;
+  });
+  return pureObj;
+}

package/src/inner-utils/str.js

@@ -1,75 +1,75 @@
-/**
- * for getting pretty format multi line string when use \`...\`
- * this function will remove indent of every line automatically
- * @param {string} mayLineBreakStr
- * @param {'MULTI' | 'ONE'} [mode='MULTI']
- * @returns
- * ```
- * // usage 1, process multi lines with mode='MULTI' by default
- * pfstr(`
- *   line1 line1 line1,
- *   line2 line2 line2.
- * `);
- * // pass to console.log will print:
- * line1 line1 line1,
- * line2 line2 line2.
- * // attention: end <br/> will be removed automatically in MULTI mode
- * pfstr(`
- *   line1 line1 line1,<br/>
- *   line2 line2 line2.
- * `);
- * // pass to console.log will print:
- * line1 line1 line1,
- * line2 line2 line2.
- *
- * // usage 2, set mode='ONE' to get no line break string
- * pfstr(`
- *   line1 line1 line1,
- *   line2 line2 line2.
- * `, 'ONE');
- * // pass to console.log will print:
- * line1 line1 line1, line2 line2 line2.
- *
- * // usage 3, add <br/> to control line break
- * pfstr(`
- *   line1 line1 line1,
- *   line2 line2 line2,<br/>
- *   line3 line3 line3.
- * `, 'ONE');
- * // pass to console.log will print:
- * line1 line1 line1, line2 line2 line2,
- * line3 line3 line3.
- * ```
- */
-export function pfstr(/** @type string */ mayLineBreakStr, mode = 'MULTI') {
-  // MULTI ONE
-  const lines = mayLineBreakStr.split('\n');
-  const lastIdx = lines.length - 1;
-
-  const formatLine = lines
-    .map((line, idx) => {
-      if (!line && (idx === 0 || idx === lastIdx)) {
-        return '';
-      }
-      const replaceBr = (/** @type string */ line, hasBrStr, noBrStr = '') => {
-        let result = line;
-        if (line.endsWith('<br/>')) {
-          result = line.substring(0, result.length - 5);
-          return `${result}${hasBrStr}`;
-        }
-        return `${result}${noBrStr}`;
-      };
-
-      // 此处暂时规避可选链写法，因 rollup 对此未处理，编译后上层使用会报错
-      // SyntaxError: Unexpected token '.'
-      const { trimStart } = line;
-      let result = trimStart ? line.trimStart() : line; // 去头部所有空格
-      if (mode === 'MULTI') {
-        return `${replaceBr(result, '')}\n`;
-      }
-      result = replaceBr(result, '\n', ' ');
-      return result;
-    })
-    .join('');
-  return formatLine;
-}
+/**
+ * for getting pretty format multi line string when use \`...\`
+ * this function will remove indent of every line automatically
+ * @param {string} mayLineBreakStr
+ * @param {'MULTI' | 'ONE'} [mode='MULTI']
+ * @returns
+ * ```
+ * // usage 1, process multi lines with mode='MULTI' by default
+ * pfstr(`
+ *   line1 line1 line1,
+ *   line2 line2 line2.
+ * `);
+ * // pass to console.log will print:
+ * line1 line1 line1,
+ * line2 line2 line2.
+ * // attention: end <br/> will be removed automatically in MULTI mode
+ * pfstr(`
+ *   line1 line1 line1,<br/>
+ *   line2 line2 line2.
+ * `);
+ * // pass to console.log will print:
+ * line1 line1 line1,
+ * line2 line2 line2.
+ *
+ * // usage 2, set mode='ONE' to get no line break string
+ * pfstr(`
+ *   line1 line1 line1,
+ *   line2 line2 line2.
+ * `, 'ONE');
+ * // pass to console.log will print:
+ * line1 line1 line1, line2 line2 line2.
+ *
+ * // usage 3, add <br/> to control line break
+ * pfstr(`
+ *   line1 line1 line1,
+ *   line2 line2 line2,<br/>
+ *   line3 line3 line3.
+ * `, 'ONE');
+ * // pass to console.log will print:
+ * line1 line1 line1, line2 line2 line2,
+ * line3 line3 line3.
+ * ```
+ */
+export function pfstr(/** @type string */ mayLineBreakStr, mode = 'MULTI') {
+  // MULTI ONE
+  const lines = mayLineBreakStr.split('\n');
+  const lastIdx = lines.length - 1;
+
+  const formatLine = lines
+    .map((line, idx) => {
+      if (!line && (idx === 0 || idx === lastIdx)) {
+        return '';
+      }
+      const replaceBr = (/** @type string */ line, hasBrStr, noBrStr = '') => {
+        let result = line;
+        if (line.endsWith('<br/>')) {
+          result = line.substring(0, result.length - 5);
+          return `${result}${hasBrStr}`;
+        }
+        return `${result}${noBrStr}`;
+      };
+
+      // 此处暂时规避可选链写法，因 rollup 对此未处理，编译后上层使用会报错
+      // SyntaxError: Unexpected token '.'
+      const { trimStart } = line;
+      let result = trimStart ? line.trimStart() : line; // 去头部所有空格
+      if (mode === 'MULTI') {
+        return `${replaceBr(result, '')}\n`;
+      }
+      result = replaceBr(result, '\n', ' ');
+      return result;
+    })
+    .join('');
+  return formatLine;
+}