mazey 4.1.3 → 4.1.4

package/package.json

@@ -1,124 +1,124 @@
-{
-  "name": "mazey",
-  "version": "4.1.3",
-  "description": "A functional library for daily front-end work.",
-  "main": "lib/index.cjs.js",
-  "module": "lib/index.esm.js",
-  "typings": "lib/index.d.ts",
-  "types": "lib/index.d.ts",
-  "mainEntryPointFilePath": "lib/index.d.ts",
-  "directories": {
-    "lib": "./lib"
-  },
-  "unpkg": "lib/mazey.min.js",
-  "jsdelivr": "lib/mazey.min.js",
-  "scripts": {
-    "dev": "webpack serve --config ./scripts/webpack.config.dev.js --open",
-    "build": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=close SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
-    "build:debug": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=open SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
-    "test": "jest",
-    "test:debug": "npm run build:debug && npm run test",
-    "test:coverage": "npm run build:debug && npx jest --coverage",
-    "lint:fix": "eslint --ext 'js,ts,tsx' --fix ./src ./test ./scripts",
-    "docs": "typedoc --readme ./README.md --excludeProtected --excludePrivate --excludeInternal --hideGenerator",
-    "preview": "npm run build && npm run test",
-    "release": "npm run preview && cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js",
-    "release:win": "bash scripts/shell/env-win.sh && npm i --registry=https://registry.npmmirror.com && npm run release"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mazeyqian/mazey.git"
-  },
-  "keywords": [
-    "front-end",
-    "load",
-    "math",
-    "url",
-    "style",
-    "css",
-    "debounce",
-    "throttle",
-    "trim",
-    "clone",
-    "json",
-    "random",
-    "dom",
-    "hash",
-    "storage",
-    "cookie",
-    "calculate",
-    "formula",
-    "browser",
-    "performance",
-    "pwa",
-    "console",
-    "function",
-    "typescript"
-  ],
-  "author": {
-    "name": "Cheng",
-    "email": "mazeyqian@gmail.com",
-    "url": "https://github.com/mazeyqian"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/mazeyqian/mazey/issues"
-  },
-  "homepage": "https://github.com/mazeyqian/mazey#readme",
-  "devDependencies": {
-    "@babel/core": "^7.23.2",
-    "@babel/plugin-transform-class-properties": "^7.22.5",
-    "@babel/plugin-transform-object-rest-spread": "^7.22.15",
-    "@babel/plugin-transform-runtime": "^7.23.2",
-    "@babel/preset-env": "^7.23.2",
-    "@babel/preset-typescript": "^7.23.2",
-    "@babel/runtime": "^7.23.2",
-    "@babel/runtime-corejs3": "^7.23.2",
-    "@commitlint/cli": "^17.8.1",
-    "@commitlint/config-conventional": "^17.8.1",
-    "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@types/jquery": "^3.5.29",
-    "@typescript-eslint/eslint-plugin": "^6.12.0",
-    "@typescript-eslint/parser": "^6.12.0",
-    "clean-webpack-plugin": "^4.0.0",
-    "core-js": "^3.33.2",
-    "cross-env": "^7.0.3",
-    "date-fns": "^2.30.0",
-    "eslint": "^8.54.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-standard": "^4.1.0",
-    "execa": "^7.2.0",
-    "html-webpack-plugin": "^5.5.3",
-    "husky": "^8.0.3",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jquery": "^3.7.1",
-    "lint-staged": "^14.0.1",
-    "markdown-toc": "^1.2.0",
-    "prettier": "^2.8.8",
-    "prettier-eslint-cli": "^8.0.1",
-    "rollup": "^3.29.4",
-    "rollup-plugin-cleaner": "^1.0.0",
-    "rollup-plugin-copy": "^3.4.0",
-    "rollup-plugin-dts": "^6.1.0",
-    "rollup-plugin-typescript2": "^0.34.1",
-    "ts-loader": "^9.4.4",
-    "tslib": "^2.6.2",
-    "typedoc": "^0.25.4",
-    "typescript": "5.3.2",
-    "webpack": "^5.89.0",
-    "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^4.15.1"
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged"
-    }
-  }
-}
+{
+  "name": "mazey",
+  "version": "4.1.4",
+  "description": "A functional library for daily front-end work.",
+  "main": "lib/index.cjs.js",
+  "module": "lib/index.esm.js",
+  "typings": "lib/index.d.ts",
+  "types": "lib/index.d.ts",
+  "mainEntryPointFilePath": "lib/index.d.ts",
+  "directories": {
+    "lib": "./lib"
+  },
+  "unpkg": "lib/mazey.min.js",
+  "jsdelivr": "lib/mazey.min.js",
+  "scripts": {
+    "dev": "webpack serve --config ./scripts/webpack.config.dev.js --open",
+    "build": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=close SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
+    "build:debug": "cross-env SCRIPTS_NPM_PACKAGE_DEBUG=open SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version rollup --config ./scripts/rollup.config.mjs",
+    "test": "jest",
+    "test:debug": "npm run build:debug && npm run test",
+    "test:coverage": "npm run build:debug && npx jest --coverage",
+    "lint:fix": "eslint --ext 'js,ts,tsx' --fix ./src ./test ./scripts",
+    "docs": "typedoc --readme ./README.md --excludeProtected --excludePrivate --excludeInternal --hideGenerator",
+    "preview": "npm run build && npm run test",
+    "release": "npm run preview && cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js",
+    "release:win": "bash scripts/shell/env-win.sh && npm i --registry=https://registry.npmmirror.com && npm run release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mazeyqian/mazey.git"
+  },
+  "keywords": [
+    "front-end",
+    "load",
+    "math",
+    "url",
+    "style",
+    "css",
+    "debounce",
+    "throttle",
+    "trim",
+    "clone",
+    "json",
+    "random",
+    "dom",
+    "hash",
+    "storage",
+    "cookie",
+    "calculate",
+    "formula",
+    "browser",
+    "performance",
+    "pwa",
+    "console",
+    "function",
+    "typescript"
+  ],
+  "author": {
+    "name": "Cheng",
+    "email": "mazeyqian@gmail.com",
+    "url": "https://github.com/mazeyqian"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mazeyqian/mazey/issues"
+  },
+  "homepage": "https://github.com/mazeyqian/mazey#readme",
+  "devDependencies": {
+    "@babel/core": "^7.23.2",
+    "@babel/plugin-transform-class-properties": "^7.22.5",
+    "@babel/plugin-transform-object-rest-spread": "^7.22.15",
+    "@babel/plugin-transform-runtime": "^7.23.2",
+    "@babel/preset-env": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
+    "@babel/runtime": "^7.23.2",
+    "@babel/runtime-corejs3": "^7.23.2",
+    "@commitlint/cli": "^17.8.1",
+    "@commitlint/config-conventional": "^17.8.1",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@types/jquery": "^3.5.29",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "clean-webpack-plugin": "^4.0.0",
+    "core-js": "^3.33.2",
+    "cross-env": "^7.0.3",
+    "date-fns": "^2.30.0",
+    "eslint": "^8.54.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-standard": "^4.1.0",
+    "execa": "^7.2.0",
+    "html-webpack-plugin": "^5.5.3",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jquery": "^3.7.1",
+    "lint-staged": "^14.0.1",
+    "markdown-toc": "^1.2.0",
+    "prettier": "^2.8.8",
+    "prettier-eslint-cli": "^8.0.1",
+    "rollup": "^3.29.4",
+    "rollup-plugin-cleaner": "^1.0.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "ts-loader": "^9.4.4",
+    "tslib": "^2.6.2",
+    "typedoc": "^0.25.4",
+    "typescript": "5.3.2",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.15.1"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "lint-staged"
+    }
+  }
+}

package/scripts/README.md

@@ -1,38 +1,38 @@
-# scripts
-
-## release
-
-Release this project with version by `process.env.VERSION` or `package.json`.
-
-Usage:
-
-```javascript
-const pkgVersion = process.env.VERSION || require('../package.json').version;
-release(pkgVersion);
-```
-
-It will be more straightforward if you use the development dependence CrossEnv.
-
-```shell
-# Install
-npm i cross-env -D
-
-# scripts
-cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js
-```
-
-```javascript
-// release.js
-release();
-```
-
-<!-- @param {string} ver Version
-@returns {void} -->
-
-## generateToc
-
-Generate table of contents for the markdown file.
-
-<!-- @param {string} path Path of markdown file.
-@param {array} options.hiddenHeadings Hidden headings.
-@returns {void} -->
+# scripts
+
+## release
+
+Release this project with version by `process.env.VERSION` or `package.json`.
+
+Usage:
+
+```javascript
+const pkgVersion = process.env.VERSION || require('../package.json').version;
+release(pkgVersion);
+```
+
+It will be more straightforward if you use the development dependence CrossEnv.
+
+```shell
+# Install
+npm i cross-env -D
+
+# scripts
+cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js
+```
+
+```javascript
+// release.js
+release();
+```
+
+<!-- @param {string} ver Version
+@returns {void} -->
+
+## generateToc
+
+Generate table of contents for the markdown file.
+
+<!-- @param {string} path Path of markdown file.
+@param {array} options.hiddenHeadings Hidden headings.
+@returns {void} -->

package/scripts/build-helper.js

@@ -1,76 +1,76 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable no-undef */
-const path = require("path");
-const _resolve = (_path) => path.resolve(__dirname, _path);
-const format = require("date-fns/format");
-const toc = require("markdown-toc");
-const fs = require("fs");
-// Generate version: 20210308.072903
-const genVersion = () => {
-  const d = new Date();
-  const version = format(d, "yyyyMMdd.HHmmss");
-  return version;
-};
-const version = genVersion();
-const defaultHiddenHeadings = [
-  "mazey",
-  "Install",
-  "Usage",
-  "Contributing",
-  "License",
-  "API Examples",
-  "Development Environment",
-  "Returns",
-  "Scripts",
-  "Node.js",
-  "TypeScript",
-  "Table of Contents",
-];
-
-/**
- * Generate table of contents for the markdown file.
- * 
- * @param {string} path Path of markdown file.
- * @param {array} options.hiddenHeadings Hidden headings.
- * @returns {void}
- */
-const generateToc = (path = "../README.md", options = {
-  hiddenHeadings: defaultHiddenHeadings,
-}) => {
-  console.log("Generating Table of Contents...");
-  options = Object.assign({
-    hiddenHeadings: defaultHiddenHeadings,
-  }, options);
-  const RMFilePath = _resolve(path);
-  // https://melvingeorge.me/blog/get-all-the-contents-from-file-as-string-nodejs
-  console.log("running...");
-  const buffer = fs.readFileSync(RMFilePath);
-  const fileContent = buffer.toString();
-  // https://github.com/jonschlinkert/markdown-toc
-  const removeUnnecessaryHeadings = (str) => {
-    return !options.hiddenHeadings.some(v => {
-      return str.includes(v);
-    });
-  };
-  let tocContent = toc(fileContent, {
-    filter: removeUnnecessaryHeadings,
-    bullets: [ "-", "-" ],
-  }).content;
-  tocContent = tocContent.replace(/[ ]{4}/gm, "");
-  tocContent = "<!-- toc - begin -->\n" + "- Generated with ❤️\n" + tocContent;
-  tocContent = tocContent + "\n<!-- toc - end -->";
-  // Insert to file.
-  // https://stackoverflow.com/questions/14177087/replace-a-string-in-a-file-with-nodejs
-  let newFileContent = fileContent;
-  // https://stackoverflow.com/questions/1979884/how-to-use-javascript-regex-over-multiple-lines
-  newFileContent = newFileContent.replace(/<!-- toc - begin -->[\s\S]*<!-- toc - end -->/gm, tocContent);
-  console.log("running...");
-  fs.writeFileSync(RMFilePath, newFileContent);
-  console.log("Generating Table of Contents is done.");
-};
-
-module.exports = {
-  _resolve,
-  version,
-  generateToc,
-};
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+const path = require("path");
+const _resolve = (_path) => path.resolve(__dirname, _path);
+const format = require("date-fns/format");
+const toc = require("markdown-toc");
+const fs = require("fs");
+// Generate version: 20210308.072903
+const genVersion = () => {
+  const d = new Date();
+  const version = format(d, "yyyyMMdd.HHmmss");
+  return version;
+};
+const version = genVersion();
+const defaultHiddenHeadings = [
+  "mazey",
+  "Install",
+  "Usage",
+  "Contributing",
+  "License",
+  "API Examples",
+  "Development Environment",
+  "Returns",
+  "Scripts",
+  "Node.js",
+  "TypeScript",
+  "Table of Contents",
+];
+
+/**
+ * Generate table of contents for the markdown file.
+ * 
+ * @param {string} path Path of markdown file.
+ * @param {array} options.hiddenHeadings Hidden headings.
+ * @returns {void}
+ */
+const generateToc = (path = "../README.md", options = {
+  hiddenHeadings: defaultHiddenHeadings,
+}) => {
+  console.log("Generating Table of Contents...");
+  options = Object.assign({
+    hiddenHeadings: defaultHiddenHeadings,
+  }, options);
+  const RMFilePath = _resolve(path);
+  // https://melvingeorge.me/blog/get-all-the-contents-from-file-as-string-nodejs
+  console.log("running...");
+  const buffer = fs.readFileSync(RMFilePath);
+  const fileContent = buffer.toString();
+  // https://github.com/jonschlinkert/markdown-toc
+  const removeUnnecessaryHeadings = (str) => {
+    return !options.hiddenHeadings.some(v => {
+      return str.includes(v);
+    });
+  };
+  let tocContent = toc(fileContent, {
+    filter: removeUnnecessaryHeadings,
+    bullets: [ "-", "-" ],
+  }).content;
+  tocContent = tocContent.replace(/[ ]{4}/gm, "");
+  tocContent = "<!-- toc - begin -->\n" + "- Generated with ❤️\n" + tocContent;
+  tocContent = tocContent + "\n<!-- toc - end -->";
+  // Insert to file.
+  // https://stackoverflow.com/questions/14177087/replace-a-string-in-a-file-with-nodejs
+  let newFileContent = fileContent;
+  // https://stackoverflow.com/questions/1979884/how-to-use-javascript-regex-over-multiple-lines
+  newFileContent = newFileContent.replace(/<!-- toc - begin -->[\s\S]*<!-- toc - end -->/gm, tocContent);
+  console.log("running...");
+  fs.writeFileSync(RMFilePath, newFileContent);
+  console.log("Generating Table of Contents is done.");
+};
+
+module.exports = {
+  _resolve,
+  version,
+  generateToc,
+};

package/scripts/dev.js

@@ -1,23 +1,23 @@
-/* eslint-disable no-undef */
-/* eslint-disable @typescript-eslint/no-var-requires */
-// const execa = require('execa');
-const { generateToc } = require("./build-helper");
-
-(async () => {
-  // const { stdout: pushMsg = '' } = await execa('git', ['push'], { stdio: 'pipe' })
-  //   .catch(error => {
-  //     console.log('error:', error.message);
-  //   });
-  // try {
-  //   await execa('git', ['push'], { stdio: 'pipe' });
-  // } catch (error) {
-  //   console.log('error:', error.message);
-  //   const { stdout: currentBranch } = await execa('git', ['branch', '--show-current'], { stdio: 'pipe' });
-  //   console.log('currentBranch:', currentBranch); // currentBranch: fix/rollup_dependences_mon_oct_31st_2022
-  //   await execa('git', ['push', '--set-upstream', 'origin', currentBranch]);
-  // }
-  // console.log('pushMsg:', pushMsg);
-  // const cb = await getGitCurrentBranch('fix returns value');
-  // console.log('bbb', cb);
-  generateToc();
-})();
+/* eslint-disable no-undef */
+/* eslint-disable @typescript-eslint/no-var-requires */
+// const execa = require('execa');
+const { generateToc } = require("./build-helper");
+
+(async () => {
+  // const { stdout: pushMsg = '' } = await execa('git', ['push'], { stdio: 'pipe' })
+  //   .catch(error => {
+  //     console.log('error:', error.message);
+  //   });
+  // try {
+  //   await execa('git', ['push'], { stdio: 'pipe' });
+  // } catch (error) {
+  //   console.log('error:', error.message);
+  //   const { stdout: currentBranch } = await execa('git', ['branch', '--show-current'], { stdio: 'pipe' });
+  //   console.log('currentBranch:', currentBranch); // currentBranch: fix/rollup_dependences_mon_oct_31st_2022
+  //   await execa('git', ['push', '--set-upstream', 'origin', currentBranch]);
+  // }
+  // console.log('pushMsg:', pushMsg);
+  // const cb = await getGitCurrentBranch('fix returns value');
+  // console.log('bbb', cb);
+  generateToc();
+})();