js-dev-tool 1.2.7 → 1.2.9

package/basic-types.d.ts

@@ -24,12 +24,12 @@ type TBD<T> = T | undefined;
 type TBC<T> = T | null;
 type Maybe<T> = T | null | undefined;
 /**
- * T is falsy then return A, trusy then B
- * 
+ * T is falsy then return A, truthy then B
+ *
  * ```ts
  * type ConditionalX<T, A, B> = T extends (void | false | undefined) ? A : B // <- maybe not works
  * type Conditional<T, A, B> = void extends T ? A : T extends (void | false | undefined) ? A : B;
- * 
+ *
  * function x<T extends true | void, R extends ConditionalX<T, string, string[]>>(need?: T): R {
  *   return (need? "": [""]) as R;
  * }
@@ -80,15 +80,18 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
 type Constructor<T> = new (...args: any[]) => T;
 /**
  * mark a specific property as `required`
- * 
- * + About `Merge` parameter - Accepts values ​​of `1` or `0`.
+ *
+ * + About `Flatten` parameter - Accepts values ​​of `1` or `0`.
  *   - If it is **1**, the types are displayed concatenated.
  *   - If it is **0**, the types are displayed separated by "&".
+ *
+ * @date Renamed due to reasons. (`RequireThese` to `RequireKeys`)
  */
-type RequireThese<
-  T, K extends keyof T, Merge extends 1 | 0 = 0,
-  Intersected = T & Required<Pick<T, K>>
-> = Merge extends 1 ? Prettify<Intersected> : Intersected;
+type RequireKeys<
+  T, K extends keyof T = keyof T,
+  Flatten extends 1 | 0 = 0,
+  Intersected = T & { [P in K]-?: T[P] }
+> = Flatten extends 1 ? Prettify<Intersected> : Intersected;
 /**
  * pick any `property` as excludes
  */
@@ -118,8 +121,9 @@ type TypedCtor<T> = {
 interface ITypedCtor<T> extends TypedCtor<T> {}
 /**
  * Array.sort etc...
+ * @date 2026/03/03 - Improved to allow comparison of different types
  */
-declare type TComparator<T> = (a: T, b: T) => number;
+declare type TComparator<T, T2 = T> = (a: T, b: T2) => number;
 /**
  * Generates all combinations of the string S. The order of characters does not matter.
  * @template S - The target string type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dev-tool",
-  "version": "1.2.7",
+  "version": "1.2.9",
   "bin": {
     "jstool": "tools.js"
   },

package/tools.js

@@ -9,16 +9,14 @@
 */
 // @ts-check
 "use strict";
+require("colors.ts");
 const fs = require("fs");
 const path = require("path");
 const rmc = require("rm-cstyle-cmts");
 /* utilities module by own. */
 const utils = require("./utils");
-// @ts-expect- error
 global.params = require("tin-args")();
-// @ts-expect- error
 global.verbose = params.verb;
-// @ts-expect- error
 global.isArray = Array.isArray;
 require("./tool-lib/ps").globalize(fs, utils);
 utils.log(params);
@@ -83,21 +81,28 @@ const ToolFunctions = {
     fn() {
       const re = params.regex;
       const after = params.after || "";
+      let targets = params.args || params.targets
+      if (typeof targets === "string") targets = [targets];
+      params.targets = targets;
       if (re) {
         processSources(this.taskName, (data) => data.replace(re, after), {
           base: "",
-          targets: params.args || params.targets,
         });
       }
     },
-    help: `jstool -cmd replace [-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 replace -after ".." -regex "re/(?<=reference path=\")(\\.)(?=\\/index.d.ts\")/" build/**/*.js
-                                                                                                         ^^^^^^^^^^^^^
-`,
+    get help() {
+      return `jstool -cmd replace [-after <replacement>] -regex \"/^\\s+<!--[\\s\\S]+?-->(?:\\r?\\n)?/gm\" [-targets "<path>,<path>,..." | <args: file, file file...>]
+
+${"Options:".red}
+  ${"after".cyan}  ${`: If omitted, "" (empty string) is used, meaning that the matched string is deleted.`.gray(16)}
+  ${"targets".cyan}${`: Single path string or Array type arg, "['<path>', '<path>',...]" or "<path>,<path>,..."`.gray(16)}
+
+${"remarks".magenta}${": targets - can use args parameter instead".gray(16)}${`
+  It is better to use the <args: file, file file...>
+  e.g - ${"jstool".yellow} ${"-cmd".green} ${"replace".cyan} ${"-after".green} ${`".."`.red} ${"-regex".green} ${String.raw`'re/(?<=reference path=")(\.)(?=\/index.d.ts")/'`.magenta} ${"build/**/*.js".gray(16)}
+                                                                                                ^^^^^^^^^^^^^
+`.gray(16)}`;
+    },
   },
   version: {
     taskName: "version",
@@ -287,19 +292,11 @@ 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)}`);
 }
@@ -318,7 +315,6 @@ if (params.cmd) {
     process.cwd(),
   );
 } else if (params.v) {
-  enableColors();
   const thisVersion = require("./package.json").version;
   console.log(
     `${"jstool".magenta} in "js-dev-scripts", version: ${thisVersion.green}

package/tsconfig.json

@@ -13,7 +13,7 @@
     "checkJs": true,
     "target": "es2019",
     "module": "nodenext",
-    "outDir": "./build",
+    "outDir": "./dts",
     // "baseUrl": ".",
     "rootDir": ".",
     "paths": {

package/utils.d.ts

@@ -84,6 +84,22 @@ export function readText<C extends TBD<TFsCallback>, R extends undefined extends
  * @param [callback]
  */
 export function readJson<T, C extends TBD<TReadJsonCallback<string>>, R extends undefined extends C ? TypedRecord<T> : void>(path: string, callback?: C): R;
+/**
+ * @template T
+ * @template {TWriteJsonCallback<T>} C description
+ * @param {TypedRecord<T>} json file path.
+ * @param {string} path file path.
+ * @param {C} [callback]
+ * @returns {void} description
+ */
+declare function writeJson<T, C extends TWriteJsonCallback<T>>(json: TypedRecord<T>, path: string, callback?: C): void;
+/**
+ * @template T
+ * @param {TypedRecord<T>} json
+ * @param {number} [indent=2]
+ * @returns
+ */
+declare function formatedStringify<T>(json: TypedRecord<T>, indent?: number): string;
 /**
  * @param path
  * @param handler

package/utils.js

@@ -103,12 +103,12 @@ function writeText(content, dest, callback) {
   lib.checkParentDirectory(dest);
   const ws = fs.createWriteStream(dest);
   ws.on("error", function (err) {
-    log("WriteStream.error evnet!", arguments);
+    log("WriteStream.error event!", err);
   }).on("close", function (/*no args*/) {
     callback && callback();
   });
   if (content instanceof Buffer) {
-    content = content.toString();
+    content = content.toString("utf8");
   }
   if (typeof content === "string") {
     const success = ws.write(content);
@@ -150,6 +150,10 @@ function readText(from, callback) {
  * @template T
  * @typedef {TBD<(err: any, data: TypedRecord<T>) => void>} TReadJsonCallback
  */
+/**
+ * @template T
+ * @typedef {TBD<() => void>} TWriteJsonCallback
+ */
 /**
  * NOTE: when callback specified, returns undefined
  *
@@ -171,6 +175,24 @@ function readJson(path, callback) {
   }
   return /** @type {R} */ (undefined);
 }
+/**
+ * @template T
+ * @template {TWriteJsonCallback<T>} C description
+ * @param {TypedRecord<T>} json file path.
+ * @param {string} path file path.
+ * @param {C} [callback]
+ * @returns {void} description
+ */
+function writeJson(json, path, callback) {
+  writeText(formatedStringify(json), path, callback);
+}
+/**
+ * @template T
+ * @param {TypedRecord<T>} json 
+ * @param {number} [indent=2] 
+ * @returns 
+ */
+const formatedStringify = (json, indent = 2) => JSON.stringify(json, null, indent);
 /**
  * use "rm-cstyle-cmts"
  *
@@ -472,6 +494,8 @@ module.exports = {
   writeText,
   readText,
   readJson,
+  writeJson,
+  formatedStringify,
   walkDirSync,
   compressScript,
   compressScript2,