js-dev-tool 1.0.0

package/tools.js

@@ -0,0 +1,450 @@
+#!/usr/bin/env node
+/// <reference path="./tool-lib/tools.d.ts"/>
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2019 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+// @ts-check
+
+const fs = require("fs");
+const path = require("path");
+/* utilities module by own. */
+const utils = require("./utils");
+
+require("./tool-lib/ps").globalize(fs, utils);
+
+// /**
+//  * @type {ReturnType<typeof utils.getExtraArgs<TToolArgs>>}
+//  */
+// @ts-expect-error
+global.params = require("tin-args")();
+// @ts-expect-error
+global.verbose = params.verb;
+
+utils.log(params);
+
+/**
+ * how to config terser, see {@link https://github.com/terser/terser#minify-options-structure Minify options structure}
+ *
+ * how to fast minify, see {@link https://github.com/terser/terser#terser-fast-minify-mode Terser Fast Minify Mode}
+ *
+ * @type {import("terser").MinifyOptions}
+ */
+// DEVNOTE: 2020/3/4 - https://terser.org/docs/api-reference
+const terserOptions = {
+  ecma: 2019,
+  // sourceMap: true,
+  parse: {
+    shebang: true,
+  },
+  mangle: true,
+  // DEVNOTE: 2020/9/12 - terser latest version is "format"
+  output: {
+    comments: /@license|@preserve|^(?:!|\*)/,
+    indent_level: 1,
+    max_line_len: 1500,
+    /**
+     * @example
+     * export enum OutputQuoteStyle {
+     *   PreferDouble = 0,
+     *   AlwaysSingle = 1,
+     *   AlwaysDouble = 2,
+     *   AlwaysOriginal = 3
+     * }
+     */
+    quote_style: 3,
+  },
+};
+
+const isArray = Array.isArray;
+
+/**
+ * @type {Record<string, TJSToolEntry>}
+ */
+const ToolFunctions = {
+  // jstool -cmd zip [-comment "the comment"] lib/webpack.js lib/type-ids.js
+  zip: require("./tool-lib/zip-task")(utils),
+  /** (r)ecord(W)ebpack(S)ize */
+  // jstool -cmd rws [-webpack lib/webpack.js -dest "./dev-extras/webpack-size.json"]
+  rws: require("./tool-lib/rws")(fs, utils),
+
+  //
+  // (C)onvert (J)S to (B)rowser (M)odule
+  // basePath <js source base directory>
+  // jstool -cmd cjbm -basePath extra-tests/mini-semaphore [-targets "['core.js', 'object.js']"]
+  //
+  cjbm: require("./tool-lib/cjbm")(),
+
+  // jstool -cmd cmtTrick -targets "['core.js', 'object.js']" [-basePath extra-tests/mini-semaphore]
+  cmtTrick: require("./tool-lib/cmt-trick")(),
+
+  // // jstool -cmd stripWebpack -targets "['dist/umd/index.js', 'dist/webpack/index.js']"
+  // stripWebpack: () => {
+  //     /** @type {string[]} */
+  //     const targets = params.targets || [];
+  //     if (params.basePath) {
+  //         utils.prependStringTo(targets, params.basePath, "/");
+  //     }
+  //     // regex - https://regex101.com/r/9E6ssx/2/ [eve-oauth - strip webpack regex]
+  //     const RE_XXX = params.test || /,\s?\w\.t\s?=\s?function\(\w,\s?\w\s?\)\s?\{[\s\S]+?(?=,\s?r\.o)/;
+  //     utils.fireReplace(RE_XXX, "", targets); // old: targets.map(name => `./${OUTPUT}/${name}.js`)
+  // },
+
+  // jstool -cmd stripWebpack -regex \"%npm_package_defs_regex%\""
+  stripWebpack: {
+    taskName: "stripWebpack",
+    fn() {
+      // https://regex101.com/r/CmraG0/1 // umd only
+      const re =
+        params.regex ||
+        /!function\s*\((.+?)\)(?:(.+?=.\(\)\})|([^]+)(?=\(.\.restrictor\s*\|\|))/g;
+      if (re) {
+        processSources(this.taskName, (data) => data.replace(re, ""), {
+          base: "",
+          targets: [
+            "./dist/umd/index.js",
+            "./dist/webpack/index.js",
+            "./dist/webpack-esm/index.mjs",
+          ],
+        });
+        // processSources(
+        //     this.taskName, data => {
+        //         const result = data.replace(re, ($0, $1, $2, $3) => {
+        //             console.log("[stripWebpack] hit!");
+        //             return `((${$1})=>${$2 || $3})`;
+        //         });
+        //         return result;
+        //     }, {
+        //         base: "",
+        //         // specify default targets when user omitted
+        //         // DEVNOTE: 2023/10/23 - match `umd` only...
+        //         targets: ["./dist/umd/index.js", "./dist/webpack/index.js", "./dist/webpack-esm/index.mjs"]
+        //     }
+        // );
+      }
+    },
+    help: 'jstool -cmd stripWebpack -regex "%npm_package_defs_regex%"',
+  },
+
+  /**
+   * Performs string substitutions on various file contents
+   *
+   *  + Rquired params - `regex`, `targets` or params.args
+   *
+   * @date 2020/6/11
+   */
+  // jstool -cmd stripSome -regex \"/^\\s+<!--[\\s\\S]+?-->(?:\\r?\\n)?/gm\""
+  stripSome: {
+    taskName: "stripSome",
+    fn() {
+      const re = params.regex;
+      const after = params.after || "";
+      if (re) {
+        processSources(this.taskName, (data) => data.replace(re, after), {
+          base: "",
+          targets: params.args || params.targets,
+        });
+      }
+    },
+    help: `jstool -cmd stripSome [-after <replacement>] -regex \"/^\\s+<!--[\\s\\S]+?-->(?:\\r?\\n)?/gm\" [-targets "<path>,<path>,..." | <args: file, file file...>]
+  note:
+    targets - must be array type arg, "['<path>', '<path>',...]" or "<path>,<path>,..."
+    note: targets - can use args parameter instead
+       It is better to use the <args: file, file file...>
+       e.g - jstool -cmd stripSome -after ".." -regex "re/(?<=reference path=\")(\\.)(?=\\/index.d.ts\")/" build/**/*.js
+                                                                                                         ^^^^^^^^^^^^^
+`,
+  },
+
+  // jstool -cmd version -extras "test/web/index.html,"
+  version: {
+    taskName: "version",
+    fn() {
+      let { major, minor /*, patch*/, pkgJsons = ["./package.json"] } = params;
+      /** @type {string} */
+      let currentVersion;
+      /** @type {string} */
+      let nextVersion;
+      // DEVNOTE: 2025/02/07 - see https://regex101.com/r/xXl3eC/3
+      utils.fireReplace(
+        /"?version("\s*:\s*)?\s"?(\d+)\.(\d+)\.(\d+)(-\w+)?"?/,
+        /** @type {TStringReplacer} */($0, isJson, $major, $minor, $patch, tag) => {
+          /** @type {string | number} */
+          let _major = $major;
+          /** @type {string | number} */
+          let _minor = $minor;
+          /** @type {string | number} */
+          let _patch = $patch;
+          if (major) {
+            _minor = 0;
+            _major = +_major + 1;
+          } else if (minor) {
+            _minor = +_minor + 1;
+          }
+          if (major || minor) {
+            _patch = 0;
+          } else {
+            _patch = +_patch + 1;
+          }
+          // keep current version string, usage for replace extras
+          currentVersion = `${$major}.${$minor}.${$patch}${tag ? tag : ""}`;
+          nextVersion = `${_major}.${_minor}.${_patch}${tag ? tag : ""}`;
+          return isJson ? `"version": "${nextVersion}"` : `version ${nextVersion}`;
+        },
+        pkgJsons,
+      );
+
+      const paths = isArray(params.extras)
+        ? params.extras
+        : typeof params.extras === "string"
+          ? [params.extras]
+          : [];
+      if (paths.length) {
+        utils.fireReplace(/(v)?(\d+\.\d+\.\d+)(-\w+)?/g, /** @type {TStringReplacer} */($0, $prefix, $1, $2) => {
+            if ($1 === currentVersion && $prefix) {
+              return "v" + nextVersion; // + ($2? $2: "");
+            }
+            return $0;
+          },
+          paths,
+        );
+      }
+      // @ts-ignore
+      console.log("version updated: %s", nextVersion);
+    },
+    help: `jstool -cmd version [-major | -minor] [-pkgJsons "./package.json,../package.json"] [-extras "test/web/index.html"]
+  bump top level package.json version(can specify "package.json" paths by \`pkgJsons\` option if need), specify patch version is unnecessary.
+  note:
+    extras - can be "<path>,<path>,..." (array type arg)
+`,
+  },
+
+  // jstool -cmd minify -basePath extra-tests/web/mini-semaphore
+  minify: {
+    taskName: "minify",
+    fn() {
+      // DEVNOTE: 12:05 2020/03/04 - minify with `terser`
+      // DEVNOTE: 2020/9/12 - terser(since v5.3.1? "minify" is now returns promise
+      const Terser = require("terser");
+      const sx = params.suffix;
+      let suffix = ".mini";
+      if (typeof sx === "string") {
+        suffix = sx.length ? sx : "";
+      }
+      /** @type {TProcessSourcesOpt} */
+      const opt = {
+        test: params.test || /\.js$/,
+        suffix,
+      };
+
+      if (isArray(params.basePath)) {
+        opt.bases = params.basePath;
+      } else {
+        opt.base = params.basePath;
+      }
+      processSources(
+        // @ts- ignore
+        this.taskName,
+        async (data) => {
+          // console.log(data);
+          const p = /** @type {Promise<import("terser").MinifyOutput>} */ (
+            Terser.minify(data, terserOptions)
+          );
+          // console.log({}.toString.call(p)); // [object Promise]
+          return /** @type {string} */ ((await p).code);
+        },
+        opt,
+      );
+    },
+    help: `jstool -cmd minify -basePath extra-tests/web/mini-semaphore [-test "re/\\.js$/"] [-suffix ".mini"]
+  note:
+    basePath - can be "<path>,<path>,..." (array type arg)
+    test     - can be omit, default is \`/\\.js$/\`
+    suffix   - can be omit, default is ".mini"
+`,
+  },
+
+  // rmc version 3.x
+  /**
+   * NOTE: keep comment that start with "/&#42;" when "&#42;/" end mark appears in same line.
+   *
+   *   + if start with "/&#42;-" remove it
+   */
+  rmc: {
+    taskName: "rm-cstyle-cmts",
+    fn() {
+      const rmc = require("rm-cstyle-cmts");
+      if (params.rmc4ts) {
+        rmc.setListener(({ event, fragment }) => {
+          if (event === /*EScannerEvent.MultiLineComment*/ 1) {
+            // DEVNOTE: \b is not contained LF
+            return /^\/\*(\*|!)\s|^\/\*(?!-).+\*\/$/.test(fragment);
+          }
+          // DEVNOTE: this detection is rmc default
+          // else if (event === /*ScannerEvent.SingleLineComment*/0) {
+          //     return /(?:\/\/\/?\s+@ts-\w+|\/\/\/\s*<reference)/.test(fragment);
+          // }
+          // else if (event === /*ScannerEvent.ES6Template*/2) {
+          //     ;
+          // }
+          return false;
+        });
+      }
+      const targets = params.targets;
+      const basePaths = isArray(params.basePath)
+        ? params.basePath
+        : [params.basePath];
+      processSources(
+        /** @type {string} */ (this.taskName),
+        (data) => {
+          /*
+          const after = rmc(data);
+          return after.replace(/"use strict";\s/m, "");
+          // // purge typescript v3.9.x extra statement
+          // return after.replace(/\s(exports\.\w+\s=\s)+void 0;/m, "");
+          /*/
+          return rmc(data);
+          //*/
+        },
+        {
+          bases: basePaths,
+          targets,
+          suffix: params.suffix,
+          test: params.test || /\.js$/,
+        },
+      );
+    },
+    help: `$ jstool -cmd rmc -basePath "./dist/cjs,./dist/cjs/gulp" -test "/\\.(js|d\\.ts)$/"
+  note: basePath - can be "<path>,<path>,..." (array type arg)
+    test     - can be omit, defulat \`/\.js$/\`
+    rmc4ts   - for typescript source.
+      keep comment that start with "/*" when "*/" end mark appears in same line.
+      if start with "/*-" remove it
+`,
+  },
+
+  // 2020/2/21
+  backup: {
+    taskName: "backup",
+    fn() {
+      // @ts-ignore
+      const archiver = require("archiver");
+      const archive = archiver("zip", {
+        // comment, deplicated, unzip.min will fail decompress...
+        zlib: { level: 9 }, // Sets the compression level.
+      });
+
+      // TODO: Parameterize these settings
+      // node backup-session -dest "../tmp" -projectName cerebral-web-dev
+      const destDir = params.dest || "../tmp";
+      const projectName = params.projectName || "anonymouse";
+      const prefix = utils.dateStringForFile(true);
+
+      /* [https://nodejs.org/api/repl.html]
+       *  Accessing Core Node.js Modules#
+       *  The default evaluator will automatically load Node.js core modules into the REPL environment when used.
+       *  For instance, unless otherwise declared as a global or scoped variable, the input fs will be evaluated on-demand as global.fs = require('fs').
+       */
+      // @ts- ignore fs is already imported at node REPL
+      const output = fs.createWriteStream(`${destDir}/${prefix}-${projectName}-backup.zip`)
+        .on("close", function () {
+          console.log(archive.pointer() + " total bytes");
+          console.log(
+            "archiver has been finalized and the output file descriptor has closed.",
+          );
+        })
+        .on("end", function () {
+          console.log("Data has been drained");
+        });
+
+      archive.on("progress", (progress) => {
+        // console.log(progress); too many infos...
+        console.log(progress.entries.processed);
+      });
+      archive.pipe(output);
+      archive.glob("{*,*/**/.*,*/**/*,.*,.*/**/*,.*/**/.*}", {
+        cwd: `${destDir}/${projectName}/`,
+        // root: "../tmp/cerebral-web-dev/",
+        // dot: true,
+      });
+      archive.finalize();
+    },
+    help: 'npx cpx "./{*,*/.*,.*,.*/**/*,!(node_modules|lib)/**/!(eve.db*|etag.json)}" ../tmp/my-project -v -u && npx rimraf ../tmp/my-project/node_modules && jstool -cmd backup -projectName my-project\n\
+\ \ result zip name form: <date string>-<projectName>-backup.zip',
+  },
+};
+
+/**
+ * @param {TJSToolEntry} entry
+ * @returns {entry is TJSToolEntry}
+ */
+function isJSToolEntry(entry) {
+  if (typeof entry !== "object") return false;
+  return typeof entry.fn === "function" && typeof entry.help === "string";
+}
+
+let colorEnable = false;
+function enableColors() {
+  if (!colorEnable) {
+    require("colors.ts");
+    colorEnable = true;
+  }
+}
+/**
+ * @param {string} cmd
+ * @returns {void}
+ */
+function printHelp(cmd) {
+  enableColors();
+  const entry = ToolFunctions[cmd];
+  console.log(`${cmd.yellow + " help:".green} ${entry.help.gray(8)}`);
+}
+
+if (params.cmd) {
+  // DEVNOTE: 2023/10/27 - new feature `mode`
+  const [task, mode] = params.cmd.split(":");
+  const entry = ToolFunctions[task];
+  isJSToolEntry(entry) && entry.fn(mode);
+} else if (params.shell) {
+  // DEVNOTE: 2025/2/1 23:40:24 new feature shell
+  // const [task, mode] = params.shell.split(":");
+  const SCRIPT_DIR = path.dirname(process.argv[1]);
+  // console.log(process.cwd());
+  // console.log(process.argv);
+  // console.log(`SCRIPT_DIR: ${SCRIPT_DIR}`);
+  const arg = `${params.major ? "-major" : params.minor ? "-minor" : ""}`;
+  utils.execWithOutputResult(
+    // DEVNOTE: 2025/5/16 11:42:05 - 現在, version command の arg のみ support
+    `bash ${SCRIPT_DIR}/scripts/tool.sh ${params.shell} ${arg}`,
+    (result) => {
+      console.log(result);
+    },
+    process.cwd(),
+  );
+} else if (params.v) {
+  // show version
+  enableColors();
+  const thisVersion = require("./package.json").version;
+  console.log(
+    `${"jstool".magenta} in "js-dev-scripts", version: ${thisVersion.green}
+more details see ${"https://github.com/jeffy-g/js-dev-scripts".blue}`,
+  );
+} else {
+  if (params.help) {
+    const cmdName = params.help;
+    if (typeof cmdName === "string") {
+      printHelp(cmdName);
+    } else {
+      const commands = Object.keys(ToolFunctions);
+      console.log(`
+Usage: node jstool -cmd <command name>
+    - - - - available commands:`);
+      for (const cmd of commands) {
+        printHelp(cmd);
+      }
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "newLine": "LF",
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "removeComments": false,
+    "moduleResolution": "nodenext",
+    "resolveJsonModule": true,
+    "baseUrl": "./",
+    "allowJs": true,
+    "checkJs": true,
+    "target": "es2019",
+    "module": "node18",
+    "outDir": "./build"
+  },
+  "include": [
+    "./*.js",
+    "./**/*.js",
+    "./**/*.d.ts"
+  ],
+  "exclude": [
+    // "./extras/**/*.js",
+  ]
+}

package/utils.d.ts

@@ -0,0 +1,194 @@
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2022 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference types="node"/>
+/// <reference path="./basic-types.d.ts"/>
+
+import type {
+    Dirent
+} from "fs";
+
+export const getExtraArgs: typeof import("tin-args");
+
+export type TFsCallback = (err: any, data: string) => void;
+/**
+ * <T>
+ */
+export type TypedRecord<T> = {
+    [x: string]: T;
+};
+export type TReadJsonCallback<T> = (err: any, data: Record<string, T>) => void;
+export type TExtraArgsValue = string | boolean | RegExp | string[];
+/**
+ * prepend `content` to the beginning of each element of `str_array`
+ * 
+ * form:
+ * ```js
+ * `${content}${suffix}${<str_array element>}`
+ * ```
+ *
+ * @param {string[]} str_array the string array
+ * @param {string} content prepend content
+ * @param {string} [suffix]
+ * @date 2020/2/16
+ * @version 2.0 rename `appendStringTo` -> `prependStringTo`
+ */
+export function prependStringTo(str_array: string[], content: string, suffix?: string): void;
+/**
+ * get node version at runtime.
+ *
+ * format must be `v\d+.\d+.\d+`
+ *
+ * ex:
+ * ```
+ * const utils = require("./utils");
+ * const nv = utils.extractVersion();
+ * console.log(nv); // => {major: 10, minor: 9, patch: 0}
+ * ```
+ *
+ * @param {string} versionString default is process.version
+ */
+export function extractVersion(versionString?: string): {
+    major: number;
+    minor: number;
+    patch: number;
+};
+/**
+ * use toLocaleString
+ * @param {any} ymd use simple year month day formant? default `false`
+ *  + should be truthy/falsy value
+ */
+export function dateStringForFile(ymd?: any): string;
+
+/**
+ * use "rm-cstyle-cmts"
+ * 
+ * @param {string} source
+ */
+export function removeJsonComments(source: string): string;
+/**
+ * write text content to dest path.
+ * when not exists parent directory, creat it.
+ *
+ * @param {string|NodeJS.ReadableStream|Buffer} content text? content.
+ * @param {string} dest content output path
+ * @param {() => void} [callback] the callback function
+ */
+export function writeTextUTF8(content: string | NodeJS.ReadableStream | Buffer, dest: string, callback?: () => void): void;
+/**
+ * @typedef {(err: any, data: string) => void} TFsCallback
+ */
+/**
+ * @param {string} from file path.
+ * @param [callback]
+ */
+export function readTextUTF8<C extends TBD<TFsCallback>, R extends undefined extends C ? string : void>(from: string, callback?: C): R;
+/**
+ * @template T
+ * @typedef {Record<string, T>} TypedRecord<T>
+ */
+/**
+ * @template T
+ * @typedef {(err: any, data: TypedRecord<T>) => void} TReadJsonCallback
+ */
+/**
+ * NOTE: when callback specified, returns undefined
+ *
+ * @param {string} path
+ * @param [callback]
+ */
+export function readJson<T, C extends TBD<TReadJsonCallback<string>>, R extends undefined extends C ? TypedRecord<T> : void>(path: string, callback?: C): R;
+/**
+ *
+ * @param {string} path
+ * @param {(dirent: Dirent) => void} handler
+ */
+export function walkDirSync(path: string, handler: (dirent: Dirent) => void): void;
+/**
+ * create sourceName zip. (using zip.min.js
+ *
+ * @param {string} scriptPath simple script file name. e.g - webpack (original path are "./lib/webpack.js")
+ * @param {string} comment the zip file comment.
+ */
+export function compressScript(scriptPath: string, comment?: string): void;
+/**
+ * DEVNOTE: 10/21/2018, 9:15:00 PM - using "archiver" package, this is too fast!.
+ *
+ * @param {string} scriptPath
+ * @param {string} comment
+ */
+export function compressScript2(scriptPath: string, comment?: string): void;
+/**
+ * it is bundled in webpack.js, other code becomes unnecessary.(at webpack
+ *
+ *   + 📝 using "exec" internally
+ *     * 🆗️ can use pipe command
+ *
+ * @param {string} command
+ * @param {(result: string) => void} doneCallbackWithArgs gulp callback function.
+ * @param {string=} cwd 2025/2/1 current working directory
+ */
+export function execWithOutputResult(command: string, doneCallbackWithArgs: (result: string) => void, cwd?: string): any;
+/**
+ * ### generate npm global package update script (windows command)
+ *
+ * ```js
+ * const utils = require("./utils");
+ * // ...
+ * // execute normally
+ * utils.genGlobalNpmUpdateScript("electron", "workbox-cli");
+ * // debug
+ * utils.genGlobalNpmUpdateScript("--debug", "electron", "workbox-cli");
+ * ```
+ *
+ * @param  {string[]} excludes
+ */
+export function genGlobalNpmUpdateScript(...excludes: string[]): void;
+/**
+ * use for gulp.dest(...)
+ *
+ * **useful when glob pattern can not be used (when path must be explicitly specified).**
+ *
+ * ```js
+ *  gulp.src([
+ *      "./src/app-config.ts",
+ *      "./src/auth/{eve-sso,eve-sso-v2e}.php"
+ *  ]).pipe(
+ *      ...
+ *  ).pipe(gulp.dest((vinyl) => {
+ *      return convertRelativeDir(vinyl);
+ *  })).on("end", () => {
+ *      console.log("done");
+ *  });
+ * ```
+ * @param {import("vinyl")} vinyl
+ * @param {string} dest default is "." -> node launched directory. (cwd?)
+ */
+export function convertRelativeDir(vinyl: any, dest?: string): string;
+/**
+ * ### command:
+ *
+ *   + windows - chcp 65001 && clip
+ *   + others  - xclip
+ *
+ * @param {string} content the copy terget content as string.
+ * @param {string} [message] default: "text copied!"
+ * @param {boolean} [chcp65001] default `true`
+ */
+export function copyText(content: string, message?: string, chcp65001?: boolean): void;
+/**
+ * @param {RegExp} regex
+ * @param {string | Function} replacement
+ * @param {string[]} paths Paths that do not exist are ignored
+ * @param {boolean} [async]
+ *
+ * @date 2019-4-26
+ */
+export function fireReplace(regex: RegExp, replacement: string | Function, paths: string[], async?: boolean): void;
+
+export const CI: boolean;
+export const log: typeof console.log;