js-dev-tool 1.0.0

package/tool-lib/tools.d.ts

@@ -0,0 +1,245 @@
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2023 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference path="../regex.d.ts"/>
+
+declare const ImportExportDetectRegex = `(?<!\\/\\/+\\s*)(?:import|export)\\s*(?:"(?!https?:)(?=[.\\/]+)\
+(?:(?<globalName>(?:[.\\/]+)?[^"]+?)(?:\\.(?<globalExt>(?:c|m)?jsx?))?)"|\
+\\(\\s*"(?!https?:)(?=[.\\/]+)(?<dynamicName>(?:[.\\/]+)?[^"]+?)(?:\\.(?<dynamicExt>(?:c|m)?jsx?))?"\\s*\\)|\
+(?:(?<clause>.+?|(?:\\w+\\s*,)?\\s*\\{[^}]+\\})\\s*from)\\s*"(?!https?:)(?=[.\\/]+)(?:(?<moduleName>(?:[.\\/]+)?[^"]+?)\
+(?:\\.(?<moduleExt>(?:c|m)?jsx?))?)")(?=\\s*;)?`;
+declare const reOk: ReturnType<typeof XRegex.createRegExp<typeof ImportExportDetectRegex>>;
+type TRegexDetectRet = XRegex.ReGroups<typeof reOk>;
+/* ctt
+// DONE: 2025/3/18 17:49:31 ok, result is 1, works
+type OKK = TRegexDetectRet extends TImportExportRegexGroup ? 1: 0;
+/*/
+//*/
+
+/**
+ * @date 2023-10-25
+ */
+declare global {
+
+    // DEVNOTE: 2025/3/18 17:51:42 - Retained for a while as a product of the past
+    // type TRegexImportExportDetectorGroupNames =
+    //     | "clause"
+    //     | "dynamicExt"
+    //     | "dynamicName"
+    //     | "globalExt"
+    //     | "globalName"
+    //     | "moduleExt"
+    //     | "moduleName";
+    // type TImportExportRegexGroup = {
+    //     [K in TRegexImportExportDetectorGroupNames]?: string;
+    // };
+    type TRegexImportExportDetectorReplacer = function(
+        string, string, string, string, string, string, string, string, number, string,
+        TRegexDetectRet
+    ): string;
+
+    declare function processSources(
+        taskName: string,
+        process: (source: string) => Promise<string> | string,
+        options?: TProcessSourcesOpt
+    ): void;
+
+    /** regex replace sig */
+    declare type TStringReplacer = (matchs: string, ...args: any[]) => string;
+
+    /** use `(R)ecord(W)ebpack(S)ize` */
+    declare type TRwsTags = "webpack" | "umd" | "bin";
+
+
+    declare var params: ReturnType<typeof import("tin-args")<TToolArgs>>;
+
+    /**
+     * @date 2025/2/18 0:46:03
+     */
+    declare function getBasePaths(): string[] | undefined;
+
+    /**
+     * + tool option `verb`
+     */
+    declare var verbose: TBD<true>;
+    /**
+     * tools command arg types
+     */
+    declare type TToolArgs = {
+
+        /**
+         * parameter is used to specify the root directory of the source code scan.
+         * 
+         * This is used in the `processSources` function to determine the base path for scanning.
+         * 
+         * @since 1.4.35
+         */
+        root?: string;
+        /**
+         * @since 1.4.28
+         */
+        shell?: string;
+
+        /**
+         * print jstool version
+         * @date 2025/1/23 11:37:58
+         */
+        v?: true;
+
+        /** task command shortten name */
+        cmd: string;
+
+        /**
+         * processSources
+         * cjbm, minify, rmc
+         */
+        basePath: string | string[];
+        /** processSources, cmtTrick, stripSome, rmc */
+        targets: string[];
+        /** minify, rmc */
+        suffix: string;
+
+        // version
+        major?: true;
+        minor?: true;
+        patch?: true;
+        extras: string[];
+
+        /** rws, backup */
+        dest: string;
+        /** backup */
+        projectName: string;
+
+        /** for `cjbm` replace extension. default is `js` */
+        ext: string;
+
+        /** shared, minify, rmc */
+        test: RegExp;
+
+        /** stripWebpack, stripSome */
+        regex: RegExp;
+
+        /** rmc */
+        rmc4ts: boolean;
+
+        // rws
+        /**
+         * webpacked source path. 
+         * @default `./dist/webpack/index.js`
+         */
+        webpack: string;
+        /**
+         * webpacked source path. 
+         * @default `./dist/umd/index.js`
+         */
+        umd: string;
+        /**
+         * webpacked source path. 
+         * @default `./dist/bin/index.js`
+         */
+        bin: string;
+        /**
+         * if need other name then use this option.
+         * ```js
+         * `./dist/${tag}/index.js`
+         * ```
+         */
+        "rws-tags": `${string}:${string}` | `${string}:${string}`[];
+
+        /** zip comment */
+        comment: string;
+        /** specify target package.json(s) [version] */
+        pkgJsons: string[];
+
+        /** want help? form - "-help <cmd name>" */
+        help: string;
+
+        /**
+         * for stripSome
+         * @date 2024-01-05
+         */
+        after: string;
+        /** want print written file name? */
+        verb: true;
+
+        /**
+         * @date 2025/4/6 17:09:40
+         */
+        debug?: true;
+    }
+
+    // /**
+    //  * @typedef {
+    //     (path: string, handler: (dirent: import("fs").Dirent) => void) => void
+    // } TWalkDirSyncFunction
+    // */
+    declare type TWalkDirSyncFunction = (path: string, handler: (dirent: import("fs").Dirent) => void) => void;
+
+    // /**
+    //  * @typedef TProcessSourcesOpt
+    //  * @prop {string} [base]
+    //  * @prop {string[]} [bases] Array of search directory paths, overriding "base"
+    //  * @prop {RegExp} [test] default: `/\.js$/`
+    //  * @prop {string[]} [targets]
+    //  * @prop {string} [suffix]
+    //  */
+    declare type TProcessSourcesOpt = {
+        root?: string;
+        base?: string;
+        /** Array of search directory paths, overriding "base" */
+        bases?: string[];
+        /** @default `/\.js$/` */
+        test?: RegExp;
+        targets?: string[];
+        suffix?: string;
+    }
+
+    // /**
+    //  * @typedef {{
+    // *    fn: () => void;
+    // *    help: string;
+    // *    taskName: string;
+    // * }} TJSToolEntry
+    // */
+    declare type TJSToolEntry = {
+        fn: (mode?: string) => void;
+        help: string;
+        taskName: string;
+    }
+
+    /**
+     * version command type
+     */
+    declare type TVersionString = `${number}.${number}.${number}`;
+    // unused
+    // type TNVersion = [number, number, number];
+    declare type TVersionRecords = Record<TVersionString, Partial<Record<TRwsTags, number>>>;
+    declare type TSizeRecordEntry = TVersionRecords["0.0.0"];
+
+    // /**
+    // * @typedef TRecordWebpackSizeArgs
+    // * @prop {string} dest - record path
+    // * @prop {string} webpack - webpacked source path. default `./dist/webpack/index.js`
+    // * @prop {string} umd - webpacked umd source path. default `./dist/umd/index.js`
+    // * @prop {string} bin - webpacked bin source path. default `./dist/bin/index.js`
+    // * 
+    // * @typedef TCJBMArgs currentlly support `js` only
+    // * @prop {string | string[]} basePath - source scan path
+    // */
+    // type TRecordWebpackSizeArgs = {
+    //     /** record path */
+    //     dest: string;
+    //     /** {@link TToolArgs.webpack webpack} */
+    //     webpack: string;
+    //     /** {@link TToolArgs.umd umd} */
+    //     umd: string;
+    //     /** {@link TToolArgs.bin bin} */
+    //     bin: string;
+    // }
+}
+
+export = {};

package/tool-lib/zip-task.js

@@ -0,0 +1,34 @@
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2023 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference path="./tools.d.ts"/>
+// @ts-check
+
+/**
+ * @file zip compression task
+ */
+module.exports =
+  /**
+   * @param {import("../utils")} utils
+   * @returns {TJSToolEntry}
+   */
+  (utils) => {
+    return {
+      taskName: "zip",
+      fn() {
+        const comment = params.comment;
+        const paths = params.args;
+        if (Array.isArray(paths)) {
+          for (let i = 0, end = paths.length; i < end; ) {
+            const path = paths[i++];
+            utils.compressScript(path, comment);
+          }
+        }
+      },
+      help: `jstool -cmd zip [-comment "the comment"] lib/webpack.js lib/type-ids.js`,
+    };
+  };

package/tools.d.ts

@@ -0,0 +1,7 @@
+export type {
+    TToolArgs,
+    TJSToolEntry,
+    TZipArgs,
+    TRecordWebpackSizeArgs,
+    TCJBMArgs
+} from "./tools.js";