@yannick-z/modulo 0.3.6 → 0.3.8

package/bin/modulo.js

@@ -1,15 +1,5 @@
 #! /usr/bin/env node
 
-const requiredVersion = 24;
-const currentVersion = process.version.match(/^v(\d+)/)?.[1];
-
-if (!currentVersion || parseInt(currentVersion, 10) < requiredVersion) {
-	console.error(
-		`\x1b[31mError: Node.js version ${process.version} is not supported. Please use Node.js v${requiredVersion} or higher.\x1b[0m`,
-	);
-	process.exit(1);
-}
-
 import("../src/index.ts")
 	.then((module) => {
 		// console.log("\nsupport ts, use Typescript code\n");

package/dist/131.js

@@ -27,7 +27,7 @@ const logger = {
     }
 };
 var package_namespaceObject = {
-    rE: "0.3.5"
+    rE: "0.3.8"
 };
 const cli = cac("modulo");
 cli.command("init <target>", "Initialize modulo configuration or scripts").option("-f, --force", "Force overwrite existing files").option("--path <path>", "Specify the path to initialize").option("--preset <preset>", "Specify the preset to use").action((target, options)=>{

package/package.json

@@ -2,13 +2,12 @@
 	"name": "@yannick-z/modulo",
 	"description": "",
 	"type": "module",
-	"version": "0.3.6",
+	"version": "0.3.8",
 	"main": "./dist/index.js",
 	"types": "./types/src/index.d.ts",
 	"author": "oyangxiao",
 	"scripts": {
-		"build": "rslib build && tsc",
-		"build.d.ts": "tsc --emitDeclarationOnly",
+		"build": "rslib build && tsc --emitDeclarationOnly",
 		"lint": "biome lint src bin rslib.config.ts",
 		"format": "biome format --write src bin rslib.config.ts package.json biome.json",
 		"check": "biome check --write src bin rslib.config.ts package.json biome.json"
@@ -20,6 +19,7 @@
 		"dist",
 		"bin",
 		"src",
+		"types",
 		"template",
 		"README.md",
 		"LICENSE"

package/types/rslib.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@rslib/core").RslibConfig;
+export default _default;

package/types/src/args/get-framework-name.d.ts

@@ -0,0 +1 @@
+export declare function detect_preset(): string;

package/types/src/args/index.d.ts

@@ -0,0 +1,20 @@
+import type { preset_ui_libs } from "../config/presets.ts";
+export interface ModuloArgs_Pack {
+    cmd: "build" | "dev" | "preview";
+    target: "page" | "module" | "all";
+    pack: {
+        config?: string;
+        env: "dev" | "prd";
+        watch: boolean;
+        esm: boolean;
+    };
+}
+export interface ModuloArgs_Init {
+    cmd: "init";
+    target: "config" | "script" | "project";
+    init: {
+        path: string;
+        force: boolean;
+        preset: keyof typeof preset_ui_libs;
+    };
+}

package/types/src/args/preset.d.ts

@@ -0,0 +1,2 @@
+import type minimist from "minimist";
+export declare function get_preset_for_init(argv: minimist.ParsedArgs): any;

package/types/src/bin/modulo.d.ts

@@ -0,0 +1 @@
+#! /usr/bin/env node

package/types/src/cli/init.d.ts

@@ -0,0 +1,2 @@
+import type { ModuloArgs_Init } from "../args/index.ts";
+export declare function init_tool(args: ModuloArgs_Init): void;

package/types/src/cli/pack-code.d.ts

@@ -0,0 +1,2 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+export declare function pack_code(args: ModuloArgs_Pack): Promise<void>;

package/types/src/config/example/example-config.d.ts

@@ -0,0 +1,4 @@
+import { preset_ui_libs } from "../presets.ts";
+import type { USER_CONFIG } from "../type.ts";
+export declare function get_example_config(preset?: keyof typeof preset_ui_libs | undefined): USER_CONFIG;
+export declare const default_config_file_name = "modulo.config.ts";

package/types/src/config/example/example-externals.d.ts

@@ -0,0 +1,12 @@
+import type { ExternalLibs } from "../type.ts";
+export declare const vue2_example_externals: ExternalLibs;
+export declare const react19_example_externals: ExternalLibs;
+export declare const common_example_externals: ExternalLibs;
+export declare const presets: {
+    vue2: {
+        [x: string]: string | import("../type.ts").ImportExternal | import("../type.ts").EnvExternalUrl;
+    };
+    react19: {
+        [x: string]: string | import("../type.ts").ImportExternal | import("../type.ts").EnvExternalUrl;
+    };
+};

package/types/src/config/index.d.ts

@@ -0,0 +1,25 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+import type { GLOBAL_CONFIG } from "./type.ts";
+/**
+ * 命令启动时候的目录作为根目录
+ */
+export declare const root: string;
+interface PackageJson {
+    name: string;
+    dependencies: Record<string, string>;
+    scripts: undefined | Record<string, string>;
+}
+export declare function get_packagejson(customRoot?: string): PackageJson;
+/**
+ * 获取全局配置（单例模式）
+ *
+ * 1. 读取用户配置文件
+ * 2. 处理 extends 继承逻辑
+ * 3. 与默认配置进行合并
+ * 4. 处理路径别名、环境变量、目录解析等
+ *
+ * @param args CLI 参数
+ * @returns 合并后的全局配置对象
+ */
+export declare function get_global_config(args: ModuloArgs_Pack): Promise<GLOBAL_CONFIG>;
+export {};

package/types/src/config/presets.d.ts

@@ -0,0 +1,97 @@
+import type { OutputConfig } from "@rsbuild/core";
+import type { ExternalLibs } from "./type.ts";
+export declare const preset_alias: Record<string, string>;
+export declare const preset_dev_server_config: {
+    open: false | string[];
+    port: number;
+    proxy: Record<string, string | {
+        target: string;
+        pathRewrite?: Record<string, string>;
+        changeOrigin?: boolean;
+        secure?: boolean;
+    }>;
+};
+export type DEV_SERVER_CONFIG = typeof preset_dev_server_config;
+export declare const preset_input_dirs: {
+    src: string;
+    pages: string;
+    modules: string;
+};
+export declare const preset_output_dirs: {
+    distPath: string;
+    pages: string;
+    modules: string;
+    filenameHash: boolean;
+};
+export interface Tag {
+    append?: boolean;
+    attrs?: Record<string, string>;
+    children?: string;
+    hash?: boolean | string;
+    head?: boolean;
+    publicPath?: string | boolean;
+    tag: string;
+}
+export declare const default_html_config: {
+    meta: Record<string, string>;
+    root: string;
+    tags: Tag[];
+    template: string;
+    title: string;
+};
+export type HTML_CONFIG = typeof default_html_config;
+export declare const preset_ui_libs: {
+    react19: string;
+    vue2: string;
+};
+export declare const preset_minify_config: OutputConfig["minify"];
+export declare const preset_url_config: {
+    base: string;
+    cdn: string;
+};
+export declare const preset_config: {
+    analyze: boolean;
+    define: Record<string, string | boolean | number>;
+    dev_server: {
+        open: false | string[];
+        port: number;
+        proxy: Record<string, string | {
+            target: string;
+            pathRewrite?: Record<string, string>;
+            changeOrigin?: boolean;
+            secure?: boolean;
+        }>;
+    };
+    externals: ExternalLibs;
+    html: {
+        meta: Record<string, string>;
+        root: string;
+        tags: Tag[];
+        template: string;
+        title: string;
+    };
+    input: {
+        src: string;
+        pages: string;
+        modules: string;
+    };
+    minify: OutputConfig["minify"];
+    output: {
+        distPath: string;
+        pages: string;
+        modules: string;
+        filenameHash: boolean;
+    };
+    ui_lib: {
+        react19: string;
+        vue2: string;
+    };
+    url: {
+        base: string;
+        cdn: string;
+    };
+    alias: Record<string, string>;
+    webhost: boolean | "auto";
+    autoExternal: boolean;
+    externalsType: "importmap" | "script";
+};

package/types/src/config/type.d.ts

@@ -0,0 +1,33 @@
+import type { preset_config } from "./presets.ts";
+export type GLOBAL_CONFIG = typeof preset_config;
+export interface EnvExternalUrl {
+    dev: string;
+    prd: string;
+}
+export type ConfigExternalUrl = EnvExternalUrl | string;
+export interface ImportExternal {
+    url: ConfigExternalUrl;
+    importName?: string | string[];
+    global?: string;
+    preset?: string;
+}
+export type ExternalLibs = {
+    [name: string]: ImportExternal | EnvExternalUrl | string;
+};
+export interface USER_CONFIG {
+    extends?: string;
+    analyze?: boolean;
+    define?: GLOBAL_CONFIG["define"];
+    dev_server?: Partial<GLOBAL_CONFIG["dev_server"]>;
+    externals?: GLOBAL_CONFIG["externals"];
+    html?: Partial<GLOBAL_CONFIG["html"]>;
+    input?: Partial<GLOBAL_CONFIG["input"]>;
+    minify?: Partial<GLOBAL_CONFIG["minify"]> | boolean;
+    output?: Partial<GLOBAL_CONFIG["output"]>;
+    ui_lib?: Partial<GLOBAL_CONFIG["ui_lib"]>;
+    alias?: GLOBAL_CONFIG["alias"];
+    url?: Partial<GLOBAL_CONFIG["url"]>;
+    webhost?: GLOBAL_CONFIG["webhost"];
+    autoExternal?: boolean;
+    externalsType?: "importmap" | "script";
+}

package/types/src/index.d.ts

@@ -0,0 +1,2 @@
+export type { USER_CONFIG as UserConfig } from "./config/type.ts";
+export declare function exec(): void;

package/types/src/initiator/create-config-file.d.ts

@@ -0,0 +1,2 @@
+import type { ModuloArgs_Init } from "../args/index.ts";
+export declare function create_config_file(args: ModuloArgs_Init): Promise<void>;

package/types/src/initiator/create-project.d.ts

@@ -0,0 +1,2 @@
+import type { ModuloArgs_Init } from "../args/index.ts";
+export declare function create_project(args: ModuloArgs_Init): Promise<void>;

package/types/src/initiator/modify-scripts.d.ts

@@ -0,0 +1,2 @@
+export declare const star_line = "**********************";
+export declare function modify_scripts(): Promise<void>;

package/types/src/packer/auto-external-plugin.d.ts

@@ -0,0 +1,18 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+import type { GLOBAL_CONFIG } from "../config/type.ts";
+/**
+ * 自动 External 插件
+ *
+ * 1. 扫描编译过程中使用到的 node_modules 依赖
+ * 2. 如果这些依赖在 config.externals 中定义了，则标记为已使用
+ * 3. 在 HTML 生成阶段，仅注入已使用的依赖的 importmap 或 script 标签
+ */
+export declare class AutoExternalPlugin {
+    private externalLibNames;
+    private usedExternals;
+    private args;
+    private config;
+    constructor(args: ModuloArgs_Pack, config: GLOBAL_CONFIG);
+    apply(compiler: any): void;
+    private processTags;
+}

package/types/src/packer/collect-modules.d.ts

@@ -0,0 +1,11 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+import type { GLOBAL_CONFIG } from "../config/type.ts";
+/**
+ * 收集模块入口文件
+ * 扫描指定目录下的子目录，查找符合规则的入口文件（index/main/同名文件）
+ *
+ * @param args CLI 参数
+ * @param kind 模块类型（page 或 module）
+ * @returns 模块名到入口文件路径的映射对象，如果未找到任何模块则返回 undefined
+ */
+export declare function collect_modules(args: ModuloArgs_Pack, kind: "page" | "module", global_config: GLOBAL_CONFIG): Record<string, string> | undefined;

package/types/src/packer/get-externals-and-tags.d.ts

@@ -0,0 +1,13 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+import { type ExternalLibs } from "../config/type.ts";
+/**
+ * 解析 External 配置，生成 externals 对象和 importMap
+ * @param args CLI 参数
+ * @param externalLibs 外部依赖配置
+ * @param externalsType External 类型（importmap 或 script）
+ * @returns externals 和 importMap
+ */
+export declare function getExternalsAndImportMap(args: ModuloArgs_Pack, externalLibs: ExternalLibs, externalsType?: "importmap" | "script"): {
+    externals: Record<string, string>;
+    importMap: Record<string, string>;
+};

package/types/src/packer/lib.d.ts

@@ -0,0 +1,9 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+/**
+ * 执行库（module）打包
+ *
+ * 使用 Rslib 将模块目录下的代码打包为 ESM 和 UMD 格式。
+ *
+ * @param args CLI 参数
+ */
+export declare function lib_pack(args: ModuloArgs_Pack): Promise<void>;

package/types/src/packer/page.d.ts

@@ -0,0 +1,9 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+/**
+ * 执行页面（page）打包
+ *
+ * 使用 Rsbuild 构建单页应用或多页应用。
+ *
+ * @param args CLI 参数
+ */
+export declare function page_pack(args: ModuloArgs_Pack): Promise<void>;

package/types/src/packer/prepare.d.ts

@@ -0,0 +1,7 @@
+import type { ModuloArgs_Pack } from "../args/index.ts";
+import type { GLOBAL_CONFIG } from "../config/type.ts";
+export declare function prepare_config(args: ModuloArgs_Pack, kind: "page" | "module", config: GLOBAL_CONFIG): {
+    entries: Record<string, string> | undefined;
+    externals: Record<string, string>;
+    importMapsTag: any;
+};

package/types/src/tools/cli.d.ts

@@ -0,0 +1,6 @@
+/**
+ * CLI 交互式确认
+ * @param message 提示信息
+ * @returns Promise<boolean> 用户是否确认 (Y/y 为 true)
+ */
+export declare function confirm(message: string): Promise<boolean>;

package/types/src/tools/file.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 读取文件内容
+ * @param path 文件绝对路径
+ * @param error_msg 自定义错误消息（可选）
+ * @param throwError 是否抛出错误（默认 false）
+ * @returns 文件内容字符串，如果失败则返回空字符串（除非 throwError 为 true）
+ */
+export declare function read_file(path: string, error_msg?: string, throwError?: boolean): string;
+/**
+ * 解析路径并读取文件
+ */
+export declare function resolve_and_read(root: string, name: string): string;
+/**
+ * 获取指定目录下的所有子目录名称
+ * @param path 目标目录路径
+ * @returns 子目录名称列表
+ */
+export declare function get_directories(path: string): string[];
+/**
+ * 在目录中查找入口文件
+ * @param dir 目标目录
+ * @param candidates 候选文件名（不含扩展名）列表，优先级按顺序
+ * @param extensions 支持的扩展名列表，优先级按顺序
+ * @returns 找到的入口文件绝对路径，如果未找到返回 undefined
+ */
+export declare function find_entry_file(dir: string, candidates: string[], extensions?: string[]): string | undefined;
+/**
+ * 检查文件是否存在
+ */
+export declare function exists(path: string): boolean;

package/types/src/tools/find-path-root.d.ts

@@ -0,0 +1,2 @@
+export declare function get_package_root(): string;
+export declare function find_workspace_root(cwd: string): string | undefined;

package/types/src/tools/get-framework-name.d.ts

@@ -0,0 +1 @@
+export declare function get_framework_name(): "vue" | "react";

package/types/src/tools/get-ui-plugin.d.ts

@@ -0,0 +1,4 @@
+import { type PluginReactOptions } from "@rsbuild/plugin-react";
+import { type PluginVueOptions } from "@rsbuild/plugin-vue2";
+import type { GLOBAL_CONFIG } from "../config/type.ts";
+export declare function framework_plugin(global_config: GLOBAL_CONFIG, options?: PluginVueOptions | PluginReactOptions): import("@rsbuild/core").RsbuildPlugin;

package/types/src/tools/json.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 解析 JSON 字符串
+ * @param input JSON 字符串
+ * @param defaultValue 解析失败或输入为空时的默认值（可选）
+ * @returns 解析后的对象或默认值
+ */
+export declare function jsonparse<T>(input: string, defaultValue?: T): T | undefined;
+/**
+ * 更新 JSON 文件
+ * @param path 文件路径
+ * @param updater 更新函数，接收当前数据并返回新数据
+ * @param createIfNotExist 如果文件不存在是否创建（默认 false）
+ * @returns 是否更新成功
+ */
+export declare function update_json_file<T = any>(path: string, updater: (data: T) => T, createIfNotExist?: boolean): boolean;

package/types/src/tools/log.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 调试日志函数
+ *
+ * 仅在 process.env.DEBUG 开启或 CLI 参数包含 --debug/--verbose 时输出。
+ * - --verbose: 直接输出到控制台
+ * - --debug: 输出日志文件到当前目录的 modulo.debug.log，并在控制台打印序号
+ *
+ * @param hint 日志标题或提示信息
+ * @param params 日志内容（可以是任意对象）
+ */
+export declare function debug_log(hint: string, ...params: unknown[]): void;
+export declare const logger: {
+    info: (msg: string) => void;
+    success: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+    debug: (msg: string) => void;
+};

package/types/src/tools/merge-user-config.d.ts

@@ -0,0 +1 @@
+export declare function merge_user_config(target: any, input: any): void;

package/types/src/tools/omit-root-path.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 获取相对于根目录的路径
+ * @param path 绝对路径
+ * @returns 相对路径（以 / 开头）
+ */
+export declare function omit_root_path(path: string): string;
+/**
+ * 批量处理入口文件路径
+ */
+export declare function omit_root_path_for_entries(entries: Record<string, string>): {
+    [k: string]: string;
+};

package/types/src/tools/panic.d.ts

@@ -0,0 +1 @@
+export declare function PANIC_IF(status?: boolean, msg?: string, halt?: boolean): asserts status is false;

package/types/src/tools/string.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 首字母大写，其余小写
+ * @param str 输入字符串
+ * @returns 格式化后的字符串
+ */
+export declare function capitalize(str: string): string;
+/**
+ * @deprecated Use capitalize instead
+ */
+export declare const first_letter_upper: typeof capitalize;

package/types/src/type/guard.d.ts

@@ -0,0 +1,7 @@
+import { type EnvExternalUrl, type ConfigExternalUrl, type ImportExternal } from "../config/type.ts";
+export declare function is_string(data: unknown): data is string;
+export declare function is_true_string(data: unknown): data is string;
+export declare function is_record(data: unknown): data is Record<string, unknown>;
+export declare function is_env_external(data: unknown): data is EnvExternalUrl;
+export declare function is_url_config(data: unknown): data is ConfigExternalUrl;
+export declare function is_import_external(data: unknown): data is ImportExternal;