mazey 3.4.0 → 3.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Mazey's library for front-end.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
@@ -14,7 +14,7 @@
     "build": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=\"close\" rollup --config ./scripts/rollup.config.js",
     "build:debug": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=\"open\" rollup --config ./scripts/rollup.config.js",
     "test": "jest",
-    "docs": "cross-env rm -f .docs/t.html && typedoc --hideGenerator && cp ./src/t.html ./docs",
+    "docs": "cross-env rm -f ./docs/t.html && typedoc --hideGenerator && cp ./src/t.html ./docs",
     "lint:fix": "eslint ./src/index.ts --ext 'ts,tsx' --fix",
     "preview": "npm run docs && npm run build && npm run test",
     "release": "npm run preview && cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js"
@@ -72,8 +72,8 @@
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",
     "clean-webpack-plugin": "^1.0.1",
-    "cross-env": "^7.0.3",
     "core-js": "^3.6.5",
+    "cross-env": "^7.0.3",
     "date-fns": "^2.29.3",
     "eslint": "^6.8.0",
     "eslint-config-standard": "^14.1.0",
@@ -95,10 +95,11 @@
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.27.2",
+    "rollup-plugin-typescript2": "^0.30.0",
     "ts-loader": "^8.0.2",
+    "tslib": "^2.4.1",
     "typedoc": "^0.18.0",
-    "typescript": "^3.9.7",
+    "typescript": "^4.4.4",
     "webpack": "^4.30.0",
     "webpack-cli": "^3.3.2",
     "webpack-dev-server": "^3.10.3"

package/scripts/github-helper.js

@@ -30,7 +30,7 @@ const { generateToc } = require('./build-helper');
  * @param {string} ver Version
  * @returns {void}
  */
-async function release (ver) {
+async function release (ver, { canGenerateToc = false } = {}) {
   if (!ver) {
     ver = process.env.SCRIPTS_NPM_PACKAGE_VERSION;
   }
@@ -42,7 +42,9 @@ async function release (ver) {
   const { stdout: releaseStdout } = await execa('echo', [`Start release ${releaseVersion}...`]);
   console.log(releaseStdout);
   // Generating Table of Contents
-  generateToc();
+  if (canGenerateToc) {
+    generateToc();
+  }
   // Commit
   await gitCommit('stage');
   // Marge

package/scripts/release.js

@@ -6,4 +6,4 @@ const pkgVersion = process.env.SCRIPTS_NPM_PACKAGE_VERSION || process.env.VERSIO
 
 console.log('release: SCRIPTS_NPM_PACKAGE_VERSION', process.env.SCRIPTS_NPM_PACKAGE_VERSION);
 
-release(pkgVersion);
+release(pkgVersion, { canGenerateToc: true });

package/src/index.ts

@@ -1,4 +1,6 @@
-/* mazey */
+/**
+ * @author: Mazey Chu
+ */
 
 /**
  * EN: Computes the longest common substring of two strings.
@@ -2065,6 +2067,64 @@ export function isNonEmptyArray(arr: any[]): boolean {
   return ret;
 }
 
+/**
+ * Determine the validity of the data.
+ *
+ * Usage:
+ *
+ * ```
+ * const validData = {
+ *   a: {
+ *     b: {
+ *       c: 413
+ *     }
+ *   }
+ * };
+ *
+ * const isValidDataResA = isValidData(validData, ['a', 'b', 'c'], 2333);
+ * const isValidDataResB = isValidData(validData, ['a', 'b', 'c'], 413);
+ * const isValidDataResC = isValidData(validData, ['d', 'd'], 413);
+ *
+ * console.log('isValidDataResA:', isValidDataResA);
+ * console.log('isValidDataResB:', isValidDataResB);
+ * console.log('isValidDataResC:', isValidDataResC);
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * isValidDataResA: false
+ * isValidDataResB: true
+ * isValidDataResC: false
+ * ```
+ *
+ * @param {any} data Original Data
+ * @param {string[]} attributes Data Attributes
+ * @param {any} validValue Given Value for verifying.
+ * @returns {boolean} Return TRUE if the data is valid.
+ */
+export function isValidData(
+  data: any,
+  attributes: string[],
+  validValue: any
+): boolean {
+  let ret = false;
+  const foundRet = attributes.reduce((foundValue, curr) => {
+    if (foundValue[curr]) {
+      foundValue = foundValue[curr];
+    } else {
+      return Object.create(null);
+    }
+    // console.log('foundValue', foundValue);
+    return foundValue;
+  }, data);
+  // console.log('foundRet', foundRet);
+  if (foundRet === validValue) {
+    ret = true;
+  }
+  return ret;
+}
+
 /**
  * 语义化文件大小, 把字节转换成正常文件大小.
  */
@@ -2123,3 +2183,66 @@ export function genHashCode(str: string): number {
   }
   return hash;
 }
+
+/**
+ * Return the formatted date string in the given format.
+ *
+ * Usage:
+ *
+ * ```
+ * console.log('Default formatDate value:', formatDate());
+ * console.log('String formatDate value:', formatDate('Tue Jan 11 2022 14:12:26 GMT+0800 (China Standard Time)', 'yyyy-MM-dd hh:mm:ss'));
+ * console.log('Number formatDate value:', formatDate(1641881235000, 'yyyy-MM-dd hh:mm:ss'));
+ * console.log('Date formatDate value:', formatDate(new Date(2014, 1, 11), 'MM/dd/yyyy'));
+ * ```
+ *
+ * Output:
+ *
+ * ```
+ * Default formatDate value: 2023-01-11
+ * String formatDate value: 2022-01-11 14:12:26
+ * Number formatDate value: 2022-01-11 14:07:15
+ * Date formatDate value: 02/11/2014
+ * ```
+ *
+ * @param {Date|number|string} dateIns Original Date
+ * @param {string} format Format String
+ * @returns {string} Return the formatted date string.
+ */
+export function formatDate(
+  dateIns?: Date | number | string,
+  format = 'yyyy-MM-dd'
+): string {
+  if (!dateIns) {
+    dateIns = new Date();
+  }
+  const tempDate = new Date(dateIns);
+  const o: {
+    [key: string]: string | number;
+  } = {
+    yyyy: tempDate.getFullYear(),
+    MM: tempDate.getMonth() + 1,
+    dd: tempDate.getDate(),
+    hh:
+      tempDate.getHours() < 10
+        ? '0' + tempDate.getHours()
+        : tempDate.getHours(),
+    mm:
+      tempDate.getMinutes() < 10
+        ? '0' + tempDate.getMinutes()
+        : tempDate.getMinutes(),
+    ss:
+      tempDate.getSeconds() < 10
+        ? '0' + tempDate.getSeconds()
+        : tempDate.getSeconds()
+  };
+  let tempFormat = format || 'yyyy-MM-dd';
+  Object.keys(o).forEach(key => {
+    let value = o[key];
+    if (key === 'MM' && Number(value) <= 9) {
+      value = `0${value}`;
+    }
+    tempFormat = tempFormat.replace(key, String(value));
+  });
+  return tempFormat;
+}