mazey 3.3.0 → 3.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "3.3.0",
+  "version": "3.3.4",
   "description": "Mazey's library for front-end.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
@@ -11,10 +11,9 @@
   },
   "scripts": {
     "dev": "webpack-dev-server --config webpack.config.dev.js --open",
-    "build": "npx rollup -c",
+    "build": "rollup -c",
     "test": "jest",
-    "[Give Up]docs": "npx typedoc --out docs/ src/",
-    "docs": "npx typedoc",
+    "docs": "typedoc",
     "lint-and-fix": "eslint ./src/index.ts --ext 'ts,tsx' --fix",
     "preview": "npm run build && npm run test && npm run docs",
     "release": "npm run preview && npm publish && node ./scripts/release.js"
@@ -59,42 +58,42 @@
   },
   "homepage": "https://github.com/mazeyqian/mazey#readme",
   "devDependencies": {
-    "@babel/core": "7.8.4",
-    "@babel/plugin-proposal-class-properties": "7.10.4",
-    "@babel/plugin-proposal-object-rest-spread": "7.11.0",
-    "@babel/plugin-transform-runtime": "7.11.0",
-    "@babel/preset-env": "7.5.5",
-    "@babel/preset-typescript": "7.10.4",
+    "@babel/core": "^7.8.4",
+    "@babel/plugin-proposal-class-properties": "^7.10.4",
+    "@babel/plugin-proposal-object-rest-spread": "^7.11.0",
+    "@babel/plugin-transform-runtime": "^7.11.0",
+    "@babel/preset-env": "^7.5.5",
+    "@babel/preset-typescript": "^7.10.4",
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",
-    "clean-webpack-plugin": "1.0.1",
-    "eslint": "6.8.0",
-    "eslint-config-standard": "14.1.0",
-    "eslint-plugin-import": "2.20.1",
-    "eslint-plugin-node": "11.0.0",
-    "eslint-plugin-promise": "4.2.1",
-    "eslint-plugin-standard": "4.0.1",
+    "clean-webpack-plugin": "^1.0.1",
+    "eslint": "^6.8.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.20.1",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
     "execa": "^4.1.0",
-    "html-webpack-plugin": "3.2.0",
-    "husky": "4.3.8",
+    "html-webpack-plugin": "^3.2.0",
+    "husky": "^4.3.8",
     "jest": "^27.5.1",
-    "lint-staged": "10.0.8",
-    "prettier": "1.19.1",
-    "prettier-eslint-cli": "5.0.0",
+    "lint-staged": "^10.0.8",
+    "prettier": "^1.19.1",
+    "prettier-eslint-cli": "^5.0.0",
     "rollup": "^1.31.1",
     "rollup-plugin-babel": "^4.3.3",
     "rollup-plugin-cleaner": "^1.0.0",
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.27.2",
-    "ts-loader": "8.0.2",
-    "typedoc": "0.18.0",
-    "typescript": "3.9.7",
-    "webpack": "4.30.0",
-    "webpack-cli": "3.3.2",
-    "webpack-dev-server": "3.10.3"
+    "ts-loader": "^8.0.2",
+    "typedoc": "^0.18.0",
+    "typescript": "^3.9.7",
+    "webpack": "^4.30.0",
+    "webpack-cli": "^3.3.2",
+    "webpack-dev-server": "^3.10.3"
   },
   "husky": {
     "hooks": {

package/scripts/github-helper.js

@@ -0,0 +1,40 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+// Github Helper
+const execa = require('execa');
+
+/**
+ * Release code.
+ *
+ * Example: Release code with version by `process.env.VERSION` or `package.json`.
+ * 
+ * ```
+ * const pkgVersion = process.env.VERSION || require('../package.json').version;
+ * release(pkgVersion);
+ * ```
+ */
+async function release (ver) {
+  const releaseVersion = `v${ver}`;
+  const { stdout: releaseStdout } = await execa('echo', [`Start release ${releaseVersion}...`]);
+  console.log(releaseStdout);
+  // Commit Stdout
+  const { stdout: diffStdout } = await execa('git', ['diff'], { stdio: 'pipe' });
+  if (diffStdout) {
+    console.log('Committing changes...');
+    await execa('git', ['add', '-A']);
+    await execa('git', ['commit', '-m', `release: ${releaseVersion}`]);
+  } else {
+    console.log('No changes to commit.');
+  }
+  // Push
+  console.log('Pushing to GitHub...');
+  await execa('git', ['tag', '-a', `${releaseVersion}`, '-m', `Release ${releaseVersion}`]);
+  await execa('git', ['push', 'origin', `refs/tags/${releaseVersion}`]);
+  await execa('git', ['push']);
+
+  console.log('All done.');
+}
+
+module.exports = {
+  release,
+};

package/scripts/release.js

@@ -1,28 +1,7 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable no-undef */
 // release
-const execa = require('execa');
+const { release } = require('./github-helper');
 const pkgVersion = process.env.VERSION || require('../package.json').version;
 
-// Main
-(async () => {
-  const releaseVersion = `v${pkgVersion}`;
-  const { stdout: releaseStdout } = await execa('echo', [`Start release ${releaseVersion}...`]);
-  console.log(releaseStdout);
-  // Commit Stdout
-  const { stdout: diffStdout } = await execa('git', ['diff'], { stdio: 'pipe' });
-  if (diffStdout) {
-    console.log('Committing changes...');
-    await execa('git', ['add', '-A']);
-    await execa('git', ['commit', '-m', `release: ${releaseVersion}`]);
-  } else {
-    console.log('No changes to commit.');
-  }
-  // Push
-  console.log('Pushing to GitHub...');
-  await execa('git', ['tag', '-a', `${releaseVersion}`, '-m', `Release ${releaseVersion}`]);
-  await execa('git', ['push', 'origin', `refs/tags/${releaseVersion}`]);
-  await execa('git', ['push']);
-
-  console.log('All done.');
-})();
+release(pkgVersion);

package/src/index.ts

@@ -347,9 +347,10 @@ export function removeClass(obj: any, cls: string): void {
 
 /**
  * EN: Throttle
+ * 
  * ZH: 节流
  * 
- * @see https://lodash.com/docs/4.17.15#throttle
+ * Reference: [Lodash](https://lodash.com/docs/4.17.15#throttle)
  */
 export function throttle(func: any, wait: number, options: { leading?: boolean; trailing?: boolean; } = {}): any {
   options = Object.assign(
@@ -402,6 +403,14 @@ export function throttle(func: any, wait: number, options: { leading?: boolean;
  * EN: Debounce
  * 
  * ZH: 去抖
+ * 
+ * Usage:
+ * 
+ * ```
+ * const foo = debounce(() => {
+ *   console.log('The debounced function will only be invoked in 1000 milliseconds, the other invoking will disappear during the wait time.');
+ * }, 1000, true);
+ * ```
  */
 export function debounce(func: any, wait: number, immediate?: any): any {
   let context: any = null;
@@ -1501,24 +1510,28 @@ export function genCustomConsole(prefix = ''): Console {
 
 /**
  * Verify the validity of axios response.
+ * 
+ * Reference: [Handling Errors](https://axios-http.com/docs/handling_errors)
  */
 export function zAxiosIsValidRes(res: any, options: {
-  validStatus: number[];
+  validStatusRange: number[];
   validCode: number[];
 } = {
-  validStatus: [200],
+  validStatusRange: [200, 300],
   validCode: [0],
 }): boolean {
-  const { validStatus, validCode } = Object.assign(
+  const { validStatusRange, validCode } = Object.assign(
     {
-      validStatus: [200],
+      validStatusRange: [200, 300],
       validCode: [0],
     },
     options,
   );
+  if (validStatusRange.length !== 2) {
+    console.error('valid validStatusRange is required');
+  }
   let ret = false;
-  if (res && res.status && validStatus.includes(res.status)) {
-    ret = true;
+  if (res && res.status && validStatusRange.length === 2 && res.status >= validStatusRange[0] && res.status < validStatusRange[1]) {
     const resData = res.data;
     if (resData && validCode.includes(resData.code)) {
       ret = true;
@@ -1563,7 +1576,7 @@ export function getFileSize(size: number): string {
 /**
  * Detect webp support.
  *
- * @see https://davidwalsh.name/detect-webp
+ * Reference: [Detect WEBP Support with JavaScript](https://davidwalsh.name/detect-webp)
  */
 export function isSupportWebp(): Promise<boolean> {
   const fn = (resolve: (v: boolean) => void) => {
@@ -1582,7 +1595,7 @@ export function isSupportWebp(): Promise<boolean> {
 /**
  * Generate a Hash Code from a string.
  *
- * @see https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery
+ * Reference: [Generate a Hash from string in Javascript](https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery)
  */
 export function genHashCode(str: string): number {
 	let hash = 0, i, chr;