mazey 3.3.12 → 3.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "3.3.12",
+  "version": "3.4.1",
   "description": "Mazey's library for front-end.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
@@ -11,10 +11,11 @@
   },
   "scripts": {
     "dev": "webpack-dev-server --config ./scripts/webpack.config.dev.js --open",
-    "build": "rollup --config ./scripts/rollup.config.js",
+    "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",
-    "lint-and-fix": "eslint ./src/index.ts --ext 'ts,tsx' --fix",
+    "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"
   },
@@ -64,12 +65,15 @@
     "@babel/plugin-transform-runtime": "^7.11.0",
     "@babel/preset-env": "^7.5.5",
     "@babel/preset-typescript": "^7.10.4",
+    "@babel/runtime": "^7.20.7",
+    "@babel/runtime-corejs3": "^7.11.2",
     "@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",
     "cross-env": "^7.0.3",
+    "core-js": "^3.6.5",
     "date-fns": "^2.29.3",
     "eslint": "^6.8.0",
     "eslint-config-standard": "^14.1.0",
@@ -104,9 +108,5 @@
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
       "pre-commit": "lint-staged"
     }
-  },
-  "dependencies": {
-    "@babel/runtime-corejs3": "^7.11.2",
-    "core-js": "^3.6.5"
   }
 }

package/scripts/README.md

@@ -0,0 +1,28 @@
+# scripts
+
+## release
+
+Release this project with version by `process.env.VERSION` or `package.json`.
+
+Usage:
+
+```
+const pkgVersion = process.env.VERSION || require('../package.json').version;
+release(pkgVersion);
+```
+
+It will be more straightforward if you use the development dependence CrossEnv.
+
+```
+# Install
+npm i cross-env -D
+
+# scripts
+cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js
+
+# release.js
+release();
+```
+
+<!-- @param {string} ver Version
+@returns {void} -->

package/scripts/build-helper.js

@@ -38,15 +38,13 @@ const generateToc = () => {
     bullets: ['-', '*'],
   }).content;
   tocContent = tocContent.replace(/[ ]{4}/gm, '');
-  tocContent = '<!-- toc - begin -->\n' + '- Generate with ❤️\n' + tocContent;
+  tocContent = '<!-- toc - begin -->\n' + '- Generated with ❤️\n' + tocContent;
   tocContent = tocContent + '\n<!-- toc - end -->';
-  // console.log(tocContent);
   // 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(newFileContent);
   console.log('running...');
   fs.writeFileSync(RMFilePath, newFileContent);
   console.log('Generating Table of Contents is done.');

package/scripts/github-helper.js

@@ -5,16 +5,32 @@ const execa = require('execa');
 const { generateToc } = require('./build-helper');
 
 /**
- * Release code.
- *
- * Example: Release code with version by `process.env.VERSION` or `package.json`.
+ * Release this project with version by `process.env.VERSION` or `package.json`.
+ * 
+ * Usage:
  * 
  * ```
  * const pkgVersion = process.env.VERSION || require('../package.json').version;
  * release(pkgVersion);
  * ```
+ * 
+ * It will be more straightforward if you use the development dependence CrossEnv.
+ * 
+ * ```
+ * # Install
+ * npm i cross-env -D
+ * 
+ * # scripts
+ * cross-env SCRIPTS_NPM_PACKAGE_VERSION=$npm_package_version node ./scripts/release.js
+ * 
+ * # release.js
+ * release();
+ * ```
+ * 
+ * @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;
   }
@@ -26,32 +42,23 @@ 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 getCommit('stage');
+  await gitCommit('stage');
   // Marge
   await gitMergeMaster2Release();
   // Build
   await execa('npm', ['run', 'preview']);
   await execa('npm', ['publish']);
-  // git branch --show-current
-  // console.log('git push --set-upstream origin <branch>');
-  // 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.');
-  // }
   // Commit Again
-  await getCommit(releaseVersion);
+  await gitCommit(releaseVersion);
   // Push
   console.log('Pushing to GitHub...');
   await execa('git', ['tag', '-a', `${releaseVersion}`, '-m', `Release ${releaseVersion}`]);
   await execa('git', ['push', 'origin', `refs/tags/${releaseVersion}`]);
-  await gitPush(); // execa('git', ['push']);
+  await gitPush();
   console.log('All done.');
 }
 
@@ -62,9 +69,9 @@ async function gitPush () {
   try {
     await execa('git', ['push'], { stdio: 'pipe' });
   } catch (error) {
-    console.log('error:', error.message);
+    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
+    console.log(`Current Branch: ${currentBranch}`);
     await execa('git', ['push', '--set-upstream', 'origin', currentBranch]);
   }
   return true;
@@ -90,17 +97,16 @@ async function getGitCurrentBranch () {
   try {
     ({ stdout: currentBranch } = await execa('git', ['branch', '--show-current'], { stdio: 'pipe' }));
   } catch (error) {
-    // console.log('error:', error.message);
     ({ stdout: currentBranch } = await execa('git', ['rev-parse', '--abbrev-ref', 'HEAD'], { stdio: 'pipe' }));
   }
-  console.log('currentBranch:', currentBranch);
+  console.log(`Current Branch: ${currentBranch}`);
   return currentBranch;
 }
 
 /**
  * Commit current code.
  */
-async function getCommit (releaseVersion = 0) {
+async function gitCommit (releaseVersion = 0) {
   const { stdout: diffStdout } = await execa('git', ['diff'], { stdio: 'pipe' });
   if (diffStdout) {
     console.log('Committing changes...');
@@ -117,5 +123,5 @@ module.exports = {
   gitPush,
   gitMergeMaster2Release,
   getGitCurrentBranch,
-  getCommit,
+  gitCommit,
 };

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

@@ -590,7 +590,7 @@ export function debounce(func: any, wait: number, immediate?: any): any {
  * @param {number/Date} start 开始时间戳 1585325367122
  * @param {number/Date} end 结束时间戳 1585325367122
  * @param {string} options.type 返回类型 d: 2(天) text: 2 天 4 时...
- * @returns {String/number} 取决于 type
+ * @returns {string/number} 取决于 type
  */
 export function friendlyInterval(
   start = 0,