js-dev-tool 1.2.25 → 1.2.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-dev-tool",
-  "version": "1.2.25",
+  "version": "1.2.27",
   "type": "commonjs",
   "bin": {
     "jstool": "tools.js",
@@ -40,9 +40,11 @@
       "require": "./progress/*.js"
     },
     "./scripts/wp/*": {
+      "types": "./scripts/wp/*.d.mts",
       "import": "./scripts/wp/*.mjs"
     },
     "./scripts/vitest/*": {
+      "types": "./scripts/vitest/*.d.mts",
       "import": "./scripts/vitest/*.mjs"
     },
     "./basic-types": {

package/scripts/vitest/ts-const-enum-transform.d.mts

@@ -0,0 +1,17 @@
+import type ts from "typescript";
+/**
+ * + when could refers `vite` types
+ *
+ * @import * as NsVite from "vite";
+ *
+ * ```
+ * import * as NsVite from "vite";
+ * // @ returns {NsVite.Plugin}
+ * ```
+ *
+ * @template {unknown} R
+ * @param {string=} cwd
+ * @param {ts.CompilerOptions=} compilerOpt
+ * @param {(tsEmitFileName: string) => boolean=} validateFileName
+ */
+export declare function tsConstEnumPlugin<R>(cwd?: string, compilerOpt?: ts.CompilerOptions, validateFileName?: (fileName: string) => boolean): R;

package/scripts/wp/webpack.config.util.d.mts

@@ -0,0 +1,52 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  Copyright (C) 2020 jeffy-g <hirotom1107@gmail.com>
+//  Released under the MIT license
+//  https://opensource.org/licenses/mit-license.php
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference path="../../basic-types.d.ts" preserve="true"/>
+import type webpack from "webpack";
+export type TWpConfigRequiredKeys = "name" | "mode" | "target" | "entry" | "output" | "module" | "externalsPresets" | "resolve" | "devtool" | "plugins" | "profile" | "cache" | "recordsPath" | "externals" | "experiments";
+export type WpConfig = RequireKeys<webpack.Configuration, TWpConfigRequiredKeys>;
+export type TExtraOptions = { beautify?: true; forceSourceMap?: true, altEntry?: WpConfig["entry"]; tsconfig?: string; logsSubDir?: string };
+export type TModuleIdMaker = (originId: string, module: webpack.Module) => string | number;
+export declare const CWD: string;
+/**
+ * __reduce webpack size by shorten modId__
+ *
+ * @param {TModuleIdMaker} maker
+ */
+export declare const mapModuleIds: (maker: TModuleIdMaker) => (compiler: webpack.Compiler) => void;
+export declare const numberMaker: TModuleIdMaker;
+/**
+ * + About `entry` shape
+ * 
+ * ```
+ * // "index.js"
+ * getIndexName("./src/index.js");
+ * getIndexName({ index: "./src/index.js" });
+ * getIndexName(["./src/index.js"]);
+ *
+ * // "hoge"
+ * getIndexName({ hoge: "./src/index.js" });
+ *
+ * // undefined
+ * getIndexName({});
+ * ```
+ * @param entry
+ */
+export declare function getIndexName(entry: NonNullable<WpConfig["entry"]>): string | undefined;
+/**
+ * CAVEAT: `resolve`, `entry`, `externals`, `module`, `optimization` property is __empty object__
+ *
+ * @param target
+ * @param output NOTE: On config name creation refers of `library.type`. if not specified use `commonjs2`
+ * @param [mode] default is __`"production"`__
+ * @param {TExtraOptions=} extraOpt see {@link TExtraOptions}
+ * @return {WpConfig}
+ * @version 2.0
+ */
+export declare const createWebpackConfig: (target: WpConfig["target"], output: WpConfig["output"], mode?: WpConfig["mode"], extraOpt?: TExtraOptions) => WpConfig;
+export type TCreateWebpackConfigParameters = Parameters<typeof createWebpackConfig>;
+export type TWebpackConfigParameters = [TCreateWebpackConfigParameters[0], TCreateWebpackConfigParameters[1], altEntry?: webpack.EntryObject, tsconfig?: string];

package/scripts/wp/webpack.config.util.mjs

@@ -51,14 +51,35 @@ export const numberMaker = ((cache) => {
   };
 })(/** @type {Map<string, number>} */(new Map()));
 /**
+ * + About `entry` shape
+ * 
+ * ```
+ * // "index.js"
+ * getIndexName("./src/index.js");
+ * getIndexName({ index: "./src/index.js" });
+ * getIndexName(["./src/index.js"]);
+ *
+ * // "hoge"
+ * getIndexName({ hoge: "./src/index.js" });
+ *
+ * // undefined
+ * getIndexName({});
+ * ```
  * @param {NonNullable<WpConfig["entry"]>} entry 
  */
 export function getIndexName(entry) {
-  const index = /** @type {webpack.EntryObject} */(entry).index || /** @type {webpack.EntryObject} */(entry).main;
-  if (typeof index === "string") {
-    return path.basename(index);
+  /** @type {string=} */
+  let indexPath;
+  if (typeof entry === "string") indexPath = entry;
+  else {
+    const path = /** @type {webpack.EntryObject} */(entry).index || /** @type {webpack.EntryObject} */(entry).main;
+    if (typeof path === "string") indexPath = path;
+    else {
+      if (Array.isArray(entry)) indexPath = entry[0];
+      else if (typeof entry === "object") return Object.keys(entry)[0];
+    }
   }
-  return Object.keys(entry)[0];
+  if (typeof indexPath === "string") return path.basename(indexPath);
 }
 /**
  * @typedef {"name" | "mode" | "target" | "entry" | "output" | "module" | "externalsPresets" | "resolve" | "devtool" | "plugins" | "profile" | "cache" | "recordsPath" | "externals" | "experiments"} TWpConfigRequiredKeys
@@ -76,7 +97,7 @@ const wpProgressType = /** @type {TWPProgressType} */(process.env.WP_PROGRESS_TY
  * CAVEAT: `resolve`, `entry`, `externals`, `module`, `optimization` property is __empty object__
  * 
  * @param {WpConfig["target"]} target 
- * @param {WpConfig["output"]} output
+ * @param {WpConfig["output"]} output NOTE: On config name creation refers of `library.type`. if not specified use `commonjs2`
  * @param {WpConfig["mode"]=} mode default is __`"production"`__
  * @param {TExtraOptions=} extraOpt see {@link TExtraOptions}
  * @return {WpConfig}
@@ -93,8 +114,8 @@ export const createWebpackConfig = (target, output, mode = "production", extraOp
    * @type {WpConfig["entry"]}
    */
   const entry = altEntry ?? {};
-  const mtype = /** @type {webpack.LibraryOptions} */(output.library).type;
-  const mainName = `${target}@${mtype}_${getIndexName(entry)}`;
+  const mtype = /** @type {webpack.LibraryOptions} */(output.library)?.type ?? "commonjs2";
+  const mainName = `${target}@${mtype}_${getIndexName(entry) ?? "anonymous"}`;
   const outputModule = mtype === "module";
   /** @type {WpConfig} */
   const configObject = {

package/scripts/wp/wp-progress.d.mts

@@ -0,0 +1,3 @@
+export type TWebpackProgressHandler = (percentage: number, message: string, ...args: string[]) => void;
+declare const getWebpackProgressPluginHandler: (bunner: string) => TWebpackProgressHandler;
+export { getWebpackProgressPluginHandler };

package/scripts/wp/wp-progress.mjs

@@ -13,7 +13,7 @@ import * as extras from "../../progress/progress-extras.js";
 import * as lib from "../../common/index.js";
 /**
  * @typedef {(percentage: number, message: string, ...args: string[]) => void} TWebpackProgressHandler
- * @typedef {(percentage: number, message: string, ...args: string[]) => Promise<void>} TWebpackProgressHandlerPromise
+ * @typedef {(percentage: number, message: string, ...args: string[]) => Promise<void>} TWebpackProgressHandlerPromise unused
  */
 const PROGRESS_ROW_START = 4;
 let rowStart = PROGRESS_ROW_START;

package/utils.d.ts

@@ -222,4 +222,20 @@ export declare function indexByCol<
   Entry extends Partial<Record<TProp, string | number>>,
   R extends Record<TKey, Entry>
 >(tsvSource: string, opt?: TCSVParseOpt): R;
-export const parseDelimitedToIndex: typeof indexByCol;
+export const parseDelimitedToIndex: typeof indexByCol;
+/**
+ * Type guard to check if a value is an object.
+ * @template {unknown} [T=Record<string, unknown>]
+ * @param {unknown} value Value to check.
+ * @returns {value is T} True if the value is an object.
+ * @date 2025/8/22 10:52:32 from `lmt`
+ */
+export declare const isObject: <T extends unknown = Record<string, unknown>>(value: unknown) => value is T;
+export type TTypeOfToken = "string" | "number" | "boolean" | "bigint" | "symbol" | "undefined" | "function" | "object";
+/**
+ * @template {unknown} T
+ * @param {unknown} data
+ * @param {Array<[property: string, type: TTypeOfToken]>} verifier
+ * @returns {data is T}
+ */
+export declare const isTypeOf: <T>(data: unknown, ...verifier: Array<[property: string, type: TTypeOfToken]>) => data is T;

package/utils.js

@@ -314,7 +314,7 @@ function execWithOutputResult(command, doneCallbackWithArgs, cwd) {
   });
 }
 /**
- * @import { TCSVParseOpt } from "./utils";
+ * @import { TCSVParseOpt, TTypeOfToken } from "./utils";
  */
 /**
  * Builds a key -> row index from a delimited text source (TSV by default).
@@ -473,6 +473,28 @@ function prependStringTo(str_array, content, suffix = "") {
     str_array[i++] = `${content}${suffix}${target}`;
   }
 }
+/**
+ * Type guard to check if a value is an object.
+ * @template {unknown} [T=Record<string, unknown>]
+ * @param {unknown} value Value to check.
+ * @returns {value is T} True if the value is an object.
+ * @date 2025/8/22 10:52:32 from `lmt`
+ */
+const isObject = (value) => typeof value === "object" && value !== null;
+/**
+ * @template {unknown} T
+ * @param {unknown} data
+ * @param {Array<[property: string, type: TTypeOfToken]>} verifier
+ * @returns {data is T}
+ */
+const isTypeOf = (data, ...verifier) => {
+  if (!isObject(data)) return false;
+  for (const [prop, type] of verifier) {
+    if (!(prop in data && typeof data[prop] === type))
+      return false;
+  }
+  return true;
+};
 module.exports = {
   prependStringTo,
   extractVersion,
@@ -500,5 +522,7 @@ module.exports = {
   log,
   listDependenciesOf,
   indexByCol,
-  parseDelimitedToIndex: indexByCol
+  parseDelimitedToIndex: indexByCol,
+  isObject,
+  isTypeOf,
 };