mazey 3.3.11 → 3.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "3.3.11",
+  "version": "3.4.0",
   "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",
+    "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",
@@ -82,6 +86,7 @@
     "husky": "^4.3.8",
     "jest": "^27.5.1",
     "lint-staged": "^10.0.8",
+    "markdown-toc": "^1.2.0",
     "prettier": "^1.19.1",
     "prettier-eslint-cli": "^5.0.0",
     "rollup": "^2.79.1",
@@ -103,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

@@ -3,6 +3,8 @@
 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();
@@ -11,7 +13,45 @@ const genVersion = () => {
 };
 const version = genVersion();
 
+const generateToc = () => {
+  console.log('Generating Table of Contents...');
+  const RMFilePath = _resolve('../README.md');
+  // 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 ![
+      'mazey',
+      'Install',
+      'Usage',
+      'Contributing',
+      'License',
+      'API Examples',
+    ].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,7 +1,7 @@
 /* eslint-disable no-undef */
 /* eslint-disable @typescript-eslint/no-var-requires */
 // const execa = require('execa');
-const { getGitCurrentBranch } = require('./github-helper');
+const { generateToc } = require('./build-helper');
 
 (async () => {
   // const { stdout: pushMsg = '' } = await execa('git', ['push'], { stdio: 'pipe' })
@@ -17,6 +17,7 @@ const { getGitCurrentBranch } = require('./github-helper');
   //   await execa('git', ['push', '--set-upstream', 'origin', currentBranch]);
   // }
   // console.log('pushMsg:', pushMsg);
-  const cb = await getGitCurrentBranch('fix returns value');
-  console.log('bbb', cb);
+  // const cb = await getGitCurrentBranch('fix returns value');
+  // console.log('bbb', cb);
+  generateToc();
 })();

package/scripts/github-helper.js

@@ -2,16 +2,33 @@
 /* eslint-disable no-undef */
 // Github Helper
 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) {
   if (!ver) {
@@ -24,30 +41,22 @@ async function release (ver) {
   const releaseVersion = `v${ver}`;
   const { stdout: releaseStdout } = await execa('echo', [`Start release ${releaseVersion}...`]);
   console.log(releaseStdout);
-  // commit
-  await getCommit('stage');
-  // marge
+  // Generating Table of Contents
+  generateToc();
+  // Commit
+  await gitCommit('stage');
+  // Marge
   await gitMergeMaster2Release();
-  // build
+  // 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 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.');
 }
 
@@ -58,9 +67,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;
@@ -86,17 +95,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...');
@@ -113,5 +121,5 @@ module.exports = {
   gitPush,
   gitMergeMaster2Release,
   getGitCurrentBranch,
-  getCommit,
+  gitCommit,
 };