mazey 4.1.0 → 4.1.1

package/lib/index.cjs.js

@@ -1,5 +1,5 @@
 /*!
- * Mazey v4.1.0 https://github.com/mazeyqian/mazey
+ * Mazey v4.1.1 https://github.com/mazeyqian/mazey
  * (c) 2018-2024 Cheng
  * Released under the MIT License.
  */

package/lib/index.esm.js

@@ -1,5 +1,5 @@
 /*!
- * Mazey v4.1.0 https://github.com/mazeyqian/mazey
+ * Mazey v4.1.1 https://github.com/mazeyqian/mazey
  * (c) 2018-2024 Cheng
  * Released under the MIT License.
  */

package/lib/mazey.min.js

@@ -1,5 +1,5 @@
 /*!
- * Mazey v4.1.0 https://github.com/mazeyqian/mazey
+ * Mazey v4.1.1 https://github.com/mazeyqian/mazey
  * (c) 2018-2024 Cheng
  * Released under the MIT License.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mazey",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "A functional library for daily front-end work.",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",

package/scripts/README.md

@@ -0,0 +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} -->

package/scripts/build-helper.js

@@ -0,0 +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,
+};

package/scripts/dev.js

@@ -0,0 +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();
+})();

package/scripts/git-helper.js

@@ -0,0 +1,163 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+// Git Helper
+const execa = require("execa");
+
+/**
+ * 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}
+ */
+async function release (ver, { canGenerateToc = false, defaultBranch = "main" } = {}) {
+  if (!ver) {
+    ver = process.env.SCRIPTS_NPM_PACKAGE_VERSION;
+  }
+  if (!ver) {
+    console.error("Fail to get the current version.");
+    return;
+  }
+  const { generateToc } = require("./build-helper");
+  const releaseVersion = `v${ver}`;
+  const { stdout: releaseStdout } = await execa("echo", [ `Start release ${releaseVersion}...` ]);
+  console.log(releaseStdout);
+  // Generating Table of Contents
+  if (canGenerateToc) {
+    generateToc();
+  }
+  // Commit
+  await gitCommit(`${releaseVersion} stage`);
+  // Marge
+  await gitMergeMain2Release(defaultBranch);
+  // Build
+  await execa("npm", [ "run", "preview" ]);
+  await execa("npm", [ "publish" ]);
+  // Commit Again
+  await gitCommit(releaseVersion);
+  // Push
+  console.log("Pushing to the remote Git...");
+  // await execa('git', ['tag', '-a', `${releaseVersion}`, '-m', `Release ${releaseVersion}`]);
+  // await execa('git', ['push', 'origin', `refs/tags/${releaseVersion}`]);
+  await gitTagPush(releaseVersion);
+  await gitPush();
+  console.log("All done.");
+}
+
+/**
+ * Push git tag.
+ * 
+ * @example
+ * ```
+ * await gitTagPush('v1.0.0');
+ * ```
+ * 
+ * @param {string} ver Release version
+ * @returns {boolean} Is success
+ */
+async function gitTagPush (ver = "") {
+  if (!ver) {
+    console.error("Fail to get the current version.");
+    return false;
+  }
+  if (!ver.startsWith("v")) {
+    ver = `v${ver}`;
+  }
+  await execa("git", [ "tag", "-a", `${ver}`, "-m", `Release ${ver}` ]);
+  await execa("git", [ "push", "origin", `refs/tags/${ver}` ]);
+  return true;
+}
+
+/**
+ * Push code.
+ */
+async function gitPush () {
+  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(`Current Branch: ${currentBranch}`);
+    await execa("git", [ "push", "--set-upstream", "origin", currentBranch ]);
+  }
+  return true;
+}
+
+/**
+ * Merge main to current branch.
+ */
+async function gitMergeMain2Release (defaultBranch = "main") {
+  const currentBranch = await getGitCurrentBranch();
+  await execa("git", [ "checkout", defaultBranch ]);
+  await execa("git", [ "pull" ]);
+  await execa("git", [ "checkout", currentBranch ]);
+  await execa("git", [ "merge", defaultBranch ]);
+  return true;
+}
+
+/**
+ * Alias of `gitMergeMain2Release`.
+ */
+async function gitMergeMaster2Release (defaultBranch = "main") {
+  return await gitMergeMain2Release(defaultBranch);
+}
+
+/**
+ * Get git current branch.
+ */
+async function getGitCurrentBranch () {
+  let currentBranch = "";
+  try {
+    ({ stdout: currentBranch } = await execa("git", [ "branch", "--show-current" ], { stdio: "pipe" }));
+  } catch (error) {
+    ({ stdout: currentBranch } = await execa("git", [ "rev-parse", "--abbrev-ref", "HEAD" ], { stdio: "pipe" }));
+  }
+  console.log(`Current Branch: ${currentBranch}`);
+  return currentBranch;
+}
+
+/**
+ * Commit current code.
+ */
+async function gitCommit (releaseVersion = 0) {
+  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.");
+  }
+  return true;
+}
+
+module.exports = {
+  release,
+  gitPush,
+  gitMergeMaster2Release, // Deprecated
+  gitMergeMain2Release,
+  getGitCurrentBranch,
+  gitCommit,
+  gitTagPush,
+};

package/scripts/release.js

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+// release
+const { release } = require("./git-helper");
+const pkgVersion = process.env.SCRIPTS_NPM_PACKAGE_VERSION || process.env.VERSION || require("../package.json").version;
+
+console.log("release: SCRIPTS_NPM_PACKAGE_VERSION", process.env.SCRIPTS_NPM_PACKAGE_VERSION);
+
+release(pkgVersion, { canGenerateToc: true });

package/scripts/rollup.config.mjs

@@ -0,0 +1,121 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+import { babel } from "@rollup/plugin-babel";
+import commonjs from "@rollup/plugin-commonjs";
+import rollupTypescript from "rollup-plugin-typescript2";
+import { DEFAULT_EXTENSIONS } from "@babel/core";
+import cleaner from "rollup-plugin-cleaner";
+import terser from "@rollup/plugin-terser";
+import { dts } from "rollup-plugin-dts";
+import path from "path";
+import { fileURLToPath } from "url";
+import { dirname } from "path";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const _resolve = (_path) => path.resolve(__dirname, _path);
+const pkgVersion = process.env.SCRIPTS_NPM_PACKAGE_VERSION || process.env.VERSION || "unknown";
+const debugMode = process.env.SCRIPTS_NPM_PACKAGE_DEBUG;
+const banner =
+  "/*!\n" +
+  ` * Mazey v${pkgVersion} https://github.com/mazeyqian/mazey\n` +
+  ` * (c) 2018-${new Date().getFullYear()} Cheng\n` +
+  " * Released under the MIT License.\n" +
+  " */";
+const plugins = [
+  rollupTypescript(),
+  commonjs({
+    include: /node_modules/,
+  }),
+  babel({
+    babelHelpers: "runtime",
+    // Just convert the source code, don't run external dependencies.
+    exclude: "**/node_modules/**",
+    // Babel does not support TypeScript by default; it needs to be manually added.
+    extensions: [
+      ...DEFAULT_EXTENSIONS,
+      ".ts",
+    ],
+  }),
+];
+const iifePlugins = [];
+const dTsConf = {
+  input: _resolve("../src/typing.d.ts"),
+  // https://rollupjs.org/guide/en/#outputformat
+  output: [
+    {
+      file: _resolve("../lib/typing.d.ts"),
+      format: "es",
+    },
+  ],
+  plugins: [
+    dts(),
+  ],
+  external: [],
+};
+const gTsConf = {
+  input: _resolve("../global.d.ts"),
+  output: [
+    {
+      file: _resolve("../lib/global.d.ts"),
+      format: "es",
+    },
+  ],
+  plugins: [
+    dts(),
+  ],
+  external: [],
+};
+
+if (debugMode !== "open") {
+  iifePlugins.push(
+    // Add minification.
+    // https://github.com/TrySound/rollup-plugin-terser
+    terser({ // https://github.com/terser/terser
+      format: {
+        // https://github.com/terser/terser#format-options
+        comments: /^!\n\s\*\sMazey/,
+      },
+    }),
+  );
+}
+
+// https://rollupjs.org/guide/en/
+export default [
+  {
+    input: _resolve("../src/index.ts"),
+    // https://rollupjs.org/guide/en/#outputformat
+    output: [
+      {
+        file: _resolve("../lib/index.cjs.js"),
+        format: "cjs",
+        banner,
+        plugins: iifePlugins,
+      },
+      {
+        file: _resolve("../lib/index.esm.js"),
+        format: "esm",
+        banner,
+        plugins: iifePlugins,
+      },
+      {
+        file: _resolve("../lib/mazey.min.js"),
+        format: "iife",
+        name: "mazey",
+        banner,
+        plugins: iifePlugins,
+      },
+    ],
+    plugins: [
+      ...plugins,
+      cleaner({
+        targets: [
+          _resolve("../lib/"),
+        ],
+      }),
+    ],
+    external: [],
+  },
+  dTsConf,
+  gTsConf,
+];