js-dev-tool 1.1.2 → 1.2.0

package/README.md

@@ -21,10 +21,80 @@ To see the help for a specific command:
 node tools.js -help <command_name>
 ```
 
+## Basic Types
+
+> Optional: a small bag of legacy-ish utility types.  
+> You probably don’t need this — but if you do, it’s handy.
+
+```ts
+/// <reference types="js-dev-tool/basic-types"/>
+```
+
+## Related Libraries
+
+### [`literate-regex`](https://www.npmjs.com/package/literate-regex)
+
+`literate-regex` was originally developed as part of this project, but it has now been separated into an independent library.  
+It allows you to write readable, commented regular expressions and provides powerful type-level normalization.
+
 ## Commands
 
 Here is a list of available commands registered in `ToolFunctions`:
 
+---
+
+### `rws`
+Records the size of webpack bundles or other files. The name stands for (r)ecord(W)ebpack(S)ize.
+*   **Usage:** `jstool -cmd rws -webpack lib/webpack.js -dest "./dev-extras/webpack-size.json"`
+
+---
+
+### `cjbm`
+Converts JavaScript files to browser-compatible modules. The name stands for (C)onvert (J)S to (B)rowser (M)odule.
+*   **Usage:** `jstool -cmd cjbm -basePath <source_dir> -targets "['file1.js', 'file2.js']"`
+
+---
+
+### `cmtTrick`
+Toggles "comment tricks" in the code, useful for conditional code execution during development.
+*   **Usage:** `jstool -cmd cmtTrick -basePath <source_dir> -targets "['file1.js', 'file2.js']"`
+
+---
+
+### `replace`
+Performs generic string replacement on a set of target files using a regular expression.
+*   **Usage:** `jstool -cmd replace [-after <replacement>] -regex "<regex>" [-targets "<path1>,<path2>" | <file1> <file2> ...]`
+*   **Note:** It's often better to pass target files as direct arguments instead of using the `-targets` option.
+
+---
+
+### `version`
+Bumps the version number in `package.json` and optionally in other files.
+*   **Usage:** `jstool -cmd version [-major | -minor] [-pkgJsons "./package.json,../other/package.json"] [-extras "file.html"]`
+*   **Note:** Bumps the patch version by default. Use `-major` or `-minor` to bump those instead.
+
+---
+
+### `minify`
+Minifies JavaScript files using Terser.
+*   **Usage:** `jstool -cmd minify -basePath <source_dir> [-test "<regex>"] [-suffix ".min"]`
+*   **Note:** `basePath` can be a comma-separated list. The default suffix is `.mini`.
+
+---
+
+### `rmc`
+Removes C-style comments from files.
+*   **Usage:** `jstool -cmd rmc -basePath "./dist/cjs,./dist/other" -test "/\\.(js|d\\.ts)$/"`
+*   **Note:** Use the `-rmc4ts` flag for special handling of TypeScript comments (e.g., `/// <reference>`).
+
+---
+
+### `zip`
+Creates a zip archive of specified files.
+*   **Usage:** `jstool -cmd zip [-comment "the comment"] file1.js file2.js ...`
+
+---
+
 ```bash
 zip help: jstool -cmd zip [-comment "the comment"] lib/webpack.js lib/type-ids.js
 rws help: (R)ecord(W)ebpack(S)ize
@@ -42,7 +112,7 @@ cjbm help: (C)onvert (J)S to (B)rowser (M)odule
     root     - Recursively searches for files.
                This option is useful, but if there are directories that need to be avoided, use the 'basePath' option
     basePath - can be "<path>,<path>,..." (array type arg)
-    ext      - specifies the module extension for import clauses. default is "js"
+    ext      - specifies the module extension for import/export clauses. default is "js"
     test     - Any file extension can be specified. (The default is /\.js$/)
     targets  - specify this if you want to apply it only to a specific file.
                the file specified here should be directly under `basePath`!
@@ -87,61 +157,6 @@ rmc help: $ jstool -cmd rmc [-rmc4ts[:keepBangLine]] -basePath "./dist/cjs,./dis
 
 ```
 
----
-
-### `zip`
-Creates a zip archive of specified files.
-*   **Usage:** `jstool -cmd zip [-comment "the comment"] file1.js file2.js ...`
-
----
-
-### `rws`
-Records the size of webpack bundles or other files. The name stands for (r)ecord(W)ebpack(S)ize.
-*   **Usage:** `jstool -cmd rws -webpack lib/webpack.js -dest "./dev-extras/webpack-size.json"`
-
----
-
-### `cjbm`
-Converts JavaScript files to browser-compatible modules. The name stands for (C)onvert (J)S to (B)rowser (M)odule.
-*   **Usage:** `jstool -cmd cjbm -basePath <source_dir> -targets "['file1.js', 'file2.js']"`
-
----
-
-### `cmtTrick`
-Toggles "comment tricks" in the code, useful for conditional code execution during development.
-*   **Usage:** `jstool -cmd cmtTrick -basePath <source_dir> -targets "['file1.js', 'file2.js']"`
-
----
-
-### `replace`
-Performs generic string replacement on a set of target files using a regular expression.
-*   **Usage:** `jstool -cmd replace [-after <replacement>] -regex "<regex>" [-targets "<path1>,<path2>" | <file1> <file2> ...]`
-*   **Note:** It's often better to pass target files as direct arguments instead of using the `-targets` option.
-
----
-
-### `version`
-Bumps the version number in `package.json` and optionally in other files.
-*   **Usage:** `jstool -cmd version [-major | -minor] [-pkgJsons "./package.json,../other/package.json"] [-extras "file.html"]`
-*   **Note:** Bumps the patch version by default. Use `-major` or `-minor` to bump those instead.
-
----
-
-### `minify`
-Minifies JavaScript files using Terser.
-*   **Usage:** `jstool -cmd minify -basePath <source_dir> [-test "<regex>"] [-suffix ".min"]`
-*   **Note:** `basePath` can be a comma-separated list. The default suffix is `.mini`.
-
----
-
-### `rmc`
-Removes C-style comments from files.
-*   **Usage:** `jstool -cmd rmc -basePath "./dist/cjs,./dist/other" -test "/\\.(js|d\\.ts)$/"`
-*   **Note:** Use the `-rmc4ts` flag for special handling of TypeScript comments (e.g., `/// <reference>`).
-
----
-
-
 ## 📜 License
 
 Released under the MIT License.  

package/basic-types.d.ts

@@ -22,7 +22,7 @@ type TBD<T> = T | undefined;
  *   + 2 character shorten
  */
 type TBC<T> = T | null;
-type DecideType<T> = T extends infer P? P : T;
+type Maybe<T> = T | null | undefined;
 /**
  * T is falsy then return A, trusy then B
  * 
@@ -50,14 +50,12 @@ type DecideType<T> = T extends infer P? P : T;
  * @date 20/03/31
  */
 type Conditional<T, A, B> = void extends T ? A : T extends (void | false | undefined) ? A : B;
-type BasicIterator<T> = Iterator<T, T, T>;
 /**
  * Remove readonly
  */
 type Writable<T> = {
   -readonly [P in keyof T]: T[P];
 };
-type JsonValueTypes = string | number | boolean | object | Array<number | string | boolean | object>;
 /**
  * pickup public fields and methods from `typescript` class.
  *
@@ -75,84 +73,13 @@ type JsonValueTypes = string | number | boolean | object | Array<number | string
 type InterfaceType<T> = {
   [P in keyof T]: T[P];
 };
-type TStdFunction<R = any> = (...args: any[]) => R;
-/**
- * mark a specific property as `required`
- */
-type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
-/**
- * pick any `property` as excludes
- */
-type ExcludePick<T, K extends keyof T> = Exclude<Pick<T, K>, T>;
-/**
- * pick any `property` as required
- */
-type RequiredPick<T, K extends keyof T> = Required<Pick<T, K>>;
-/**
- * pick any `property` as partial
- */
-type PartialPick<T, K extends keyof T> = Partial<Pick<T, K>>;
-/**
- * NOTE: can use ts builtin `Omit` instead
- */
-type Flip<T, K extends keyof T> = {
-  [P in Exclude<keyof T, K>]: T[P];
-};
-/**
- *
- * @date 2019/8/19
- * @see Parameters
- */
-type RequiredParameters<TFunction extends (...args: any) => any> = Required<
-  Parameters<TFunction>
->;
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+type Constructor<T> = new (...args: any[]) => T;
 type PickProperties<P, T> = { [K in keyof T]-?: T[K] extends P ? K : never }[keyof T];
 type PickNumberProperties<T> = PickProperties<number, T>;
 type PickStringProperties<T> = PickProperties<string, T>;
 type NonFunctionPropertyNames<T> = { [K in keyof T]-?: T[K] extends Function ? never : K }[keyof T];
 type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;
-/**
- * extract () => number | string functoin names from T
- */
-type NorSFunctions<T> = { [K in keyof T]: T[K] extends (() => number | string) ? K : never }[keyof T];
-type Unpacked<T> =
-  T extends Array<infer U> ? U :
-  T extends (...args: any[]) => infer U ? U :
-  T extends Promise<infer U> ? U :
-  T;
-/**
- * cannot apply to parameter required function. (?)
- */
-type SimpleUnpack<T> = T extends (...args: any[]) => infer U ? U :
-  T extends Promise<infer U> ? U :
-  T;
-/**
- * usage:
- * ```
- * async function some(): Promise<string> {
- *   return "OK";
- * };
- * type RT = UnpackReturnType<typeof some>;
- *
- * ```
- */
-type UnpackReturnType<T extends (...args: any[]) => any> = Unpacked<ReturnType<T>>;
-/**
- * http query parameter types. (maybe not enough.
- */
-type QueryValueTypes = string | number | boolean | Date;
-/**
- * means can convert to Date object.
- */
-type DateString = string;
-/**
- * document.querySelector etc
- */
-type TQuerySelector = string;
-type NumberMap<T> = {
-  [index: number]: T;
-};
-type UndefableStringMap<T> = TBD<Record<string, T>>;
 /**
  * for lazy assign class.
  */
@@ -165,27 +92,6 @@ interface ITypedCtor<T> extends TypedCtor<T> {}
  * Array.sort etc...
  */
 declare type TComparator<T> = (a: T, b: T) => number;
-declare const enum ETypeOf {
-  VBigInt = "bigint",
-  VBool = "boolean",
-  VFn = "function",
-  VNum = "number",
-  VO = "object",
-  VS = "string",
-  VSym = "symbol",
-  VUndef = "undefined"
-}
-declare namespace ETypeOf {
-  export type Values = "bigint" | "boolean" | "function" | "number" | "object" | "string" | "symbol" | "undefined";
-  export type Bi = bigint;
-  export type B = boolean;
-  export type F = Function;
-  export type N = number;
-  export type O = object;
-  export type S = string;
-  export type Sym = symbol;
-  export type U = undefined;
-}
 /**
  * Generates all combinations of the string S. The order of characters does not matter.
  * @template S - The target string type

package/lib/zlibjs.d.ts

@@ -18,17 +18,32 @@
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 */
 declare interface IUnzip {
-    new(data: Uint8Array): this;
-    getFilenames(): string[];
-    decompress(entry: string): Uint8Array;
+  new(data: Uint8Array): this;
+  getFilenames(): string[];
+  decompress(entry: string): Uint8Array;
+  getCommentAsString(): string;
+  getFileHeader(index: number): {
     getCommentAsString(): string;
-    getFileHeader(index: number): {
-        getCommentAsString(): string;
-    };
+  };
 }
-declare namespace Zlib {
-    const Unzip: IUnzip;
+declare type TZipOption = {
+  filename: Uint8Array;
+  comment: Uint8Array;
+  compressionMethod: number;
+  os: number;
+};
+declare interface IZip {
+  new(): this;
+  addFile(data: Uint8Array, opt: TZipOption): void;
+  compress(): Uint8Array;
+  CompressionMethod: {
+    STORE: 0; DEFLATE: 8;
+  };
+  OperatingSystem: {
+    MSDOS: 0; UNIX: 3; MACINTOSH: 7;
+  }
 }
-interface Window {
-    Zlib: typeof Zlib;
+declare namespace Zlib {
+  const Unzip: IUnzip;
+  const Zip: IZip;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dev-tool",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "bin": {
     "jstool": "tools.js"
   },
@@ -27,18 +27,18 @@
       "import": "./extras/*.js",
       "require": "./extras/*.js"
     },
+    "./progress": {
+      "types": "./progress/index.d.ts",
+      "import": "./progress/index.js",
+      "require": "./progress/index.js"
+    },
     "./progress/*": {
       "types": "./progress/*.d.ts",
       "import": "./progress/*.js",
       "require": "./progress/*.js"
     },
-    "./literate-regex": {
-      "types": "./literate-regex/dist/index.d.ts",
-      "import": "./literate-regex/dist/esm/index.mjs",
-      "require": "./literate-regex/dist/cjs/index.js"
-    },
-    "./literate-regex/global": {
-      "types": "./literate-regex/dist/global.d.ts"
+    "./basic-types": {
+      "types": "./basic-types.d.ts"
     }
   },
   "repository": {
@@ -63,10 +63,6 @@
     "lib",
     "progress",
     "scripts",
-    "literate-regex/package.json",
-    "literate-regex/README.md",
-    "literate-regex/LICENSE",
-    "literate-regex/dist",
     "tool-lib",
     "./index.js",
     "./tools.js",
@@ -76,7 +72,6 @@
     "!unzip.ts",
     "!scripts/bin",
     "!publish-version.json",
-    "!literate-regex/*.d.ts",
     "!normalize-commit-msg.mjs",
     "!regex-test.ts",
     "!extras/npm",
@@ -90,6 +85,7 @@
   "dependencies": {
     "colors.ts": "^1.0.20",
     "fflate": "^0.8.2",
+    "literate-regex": "^0.5.1",
     "mini-semaphore": "^1.4.4",
     "replace": "^1.2.2",
     "rm-cstyle-cmts": "^3.3.26",

package/tool-lib/cjbm.js

@@ -14,13 +14,8 @@ const fs = require("fs");
 const path = require("path");
 const {
   compilePCREStyleRegExpLiteral,
-} = require("../literate-regex");
+} = require("literate-regex");
 const RE_TEXT = `/
-# DEVNOTE: [.\/] において、js では "/" に escape は必要ないが、pcre の場合 pattern error になる都合上 escape している
-# NOTE: PCRE(regex101.com) での検証時は pattern error 回避のため line comment assertion を (?<!\/\/|\/\/\s)(?:(?<!@)import|export) とすること
-# line comment の import("...") を正しく除外するには: (?<!\s*\/\/+.*?)(?:(?<!@)import|export)
-# NOTE: multiline comment の import statement 誤検出を回避するため、multiline comment の検出を行うようにした. (match count 45, 内 5 は multiline comment[non capture group])
-# regex101.com　では、line comment assertion (?<!\/\/|\/\/\s) により、48 (3 つは意図しない検出)
 (?:
   (?:^\\s*?\\/\\*+?[\\s\\S]*?\\*\\/)|
   (?<!\\s*\\/\\/+.*?)(?:(?<!@)import|export)
@@ -59,7 +54,9 @@ const RE_TEXT = `/
  */
 const reImportExportDetection = compilePCREStyleRegExpLiteral(RE_TEXT);
 /**
- * @typedef {XRegex.ReplacerFunctionSignature<typeof reImportExportDetection>} TImportExportDetectRegexReplacer
+ * @typedef {typeof reImportExportDetection} TImportExportDetectorRegex
+ * @typedef {TImportExportDetectorRegex["types"]["exec"]} TImportExportDetectorRegexExecResult
+ * @typedef {XRegex.StringReplacerFunction<TImportExportDetectorRegex>} TImportExportDetectRegexReplacer
  */
 /**
  * Generates a replacer function to update import/export statements with a new file extension.

package/tool-lib/tools.d.ts

@@ -5,7 +5,7 @@
   https://opensource.org/licenses/mit-license.php
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="../literate-regex"/>
+/// <reference types="literate-regex"/>
 /**
  * @date 2023-10-25
  */

package/tool-lib/zip-task.js

@@ -28,6 +28,8 @@ module.exports =
           }
         }
       },
-      help: `jstool -cmd zip [-comment "the comment"] lib/webpack.js lib/type-ids.js`,
+      help: `jstool -cmd zip [-comment "the comment"] lib/webpack.js lib/type-ids.js
+  It is possible to create zip files with comments
+`,
     };
   };

package/tools.js

@@ -65,7 +65,6 @@ function getVersionRegex() {
  * @type {Record<string, TJSToolEntry>}
  */
 const ToolFunctions = {
-  zip: require("./tool-lib/zip-task")(utils),
   /** (r)ecord(W)ebpack(S)ize */
   rws: require("./tool-lib/rws")(fs, utils),
   cjbm: require("./tool-lib/cjbm")(),
@@ -241,39 +240,7 @@ const ToolFunctions = {
           - In addition to the "rmc4ts" processing, it also preserves line comments that start with "//!".
 `,
   },
-  backup: {
-    taskName: "backup",
-    fn() {
-      // @ts-ignore
-      const archiver = require("archiver");
-      const archive = archiver("zip", {
-        zlib: { level: 9 },
-      });
-      const destDir = params.dest || "../tmp";
-      const projectName = params.projectName || "anonymouse";
-      const prefix = utils.dateStringForFile(true);
-      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.entries.processed);
-      });
-      archive.pipe(output);
-      archive.glob("{*,*/**/.*,*/**/*,.*,.*/**/*,.*/**/.*}", {
-        cwd: `${destDir}/${projectName}/`,
-      });
-      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',
-  },
+  zip: require("./tool-lib/zip-task")(utils),
 };
 /**
  * @param {TJSToolEntry} entry

package/tsconfig.json

@@ -28,7 +28,6 @@
     "*.d.ts",
     "./**/*.js",
     "./**/*.d.ts",
-    "./literate-regex/*.d.ts",
   ],
   "exclude": [
     "./**/npm-outdated*.js",

package/utils.js

@@ -18,6 +18,7 @@
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 */
 /// <reference types="./basic-types"/>
+/// <reference types="./lib/zlibjs.d.ts"/>
 // @ts-check
 const fs = require("fs");
 const path = require("path");
@@ -209,6 +210,12 @@ function fireReplace(regex, replacement, paths, async = false) {
     throw new Error(`invalid paths parameter: paths=[${paths}]`);
   }
 }
+/** @type {TextEncoder} */
+let _encoder;
+const getEncorder = () => {
+  if (!_encoder) _encoder = new TextEncoder();
+  return _encoder;
+};
 /**
  * create sourceName zip. (using zip.min.js
  *
@@ -216,13 +223,15 @@ function fireReplace(regex, replacement, paths, async = false) {
  * @param {string} comment the zip file comment.
  */
 function compressScript(scriptPath, comment = "") {
+  /** @type {IZip} */
   // @ts-ignore
   const zlibZip = require("./lib/zip.min").Zlib.Zip;
   const zip = new zlibZip();
+  const encoder = getEncorder();
   const scriptBin = fs.readFileSync(scriptPath);
   zip.addFile(scriptBin, {
-    filename: stringToByteArray(path.basename(scriptPath)),
-    comment: stringToByteArray(comment),
+    filename: encoder.encode(path.basename(scriptPath)),
+    comment: encoder.encode(comment),
     compressionMethod: zlibZip.CompressionMethod.DEFLATE,
     os: zlibZip.OperatingSystem.MSDOS,
   });
@@ -237,16 +246,6 @@ function compressScript(scriptPath, comment = "") {
   fs.writeFile(output, compressed, (err) => {
     console.log(`\nzip file created, error: ${err}\n => ${output}`);
   });
-  /**
-   * @param {string} str
-   */
-  function stringToByteArray(str) {
-    const array = new Uint8Array(str.length);
-    for (let i = 0, il = str.length; i < il; ++i) {
-      array[i] = str.charCodeAt(i) & 0xff;
-    }
-    return array;
-  }
 }
 /**
  * DEVNOTE: 10/21/2018, 9:15:00 PM - using "archiver" package, this is too fast!.