feat: 重新丰富命令行提示

Author: KonghaYao

packages/subsets/src/interface.ts

@@ -31,20 +31,47 @@ export type InputTemplate = {
     FontPath: string | Buffer | Uint8Array;
     /** 切割后放置文件的文件夹，如果没有文件系统，调用 outputFile 参数 */
     destFold: string;
-    /** 替换生成后的 CSS 文件的信息 */
+    /**
+     * 可选的CSS属性配置，用于自定义字体的样式和行为。
+     */
     css?: Partial<{
+        /**
+         * 定义字体的家族名称，这将影响文本的显示风格。
+         * @default 自动解析
+         */
         fontFamily: string;
+        /**
+         * 定义字体的重量，可以是数字、字符串或false。数字范围通常为100到900，字符串可以是预定义的值，如'normal'、'bold'。
+         * @default 自动解析
+         */
         fontWeight: number | string | false;
+        /**
+         * 定义字体的风格，如'normal'、'italic'等。
+         * @default 自动解析
+         */
         fontStyle: string;
+        /**
+         * 定义字体的显示方式，用于控制字体在加载过程中的行为。
+         * @default swag
+         */
         fontDisplay: string;
+        /**
+         * 定义字体的本地名称，如果浏览器支持该字体，则会优先使用本地安装的字体。
+         * @default 同 fontFamily
+         */
         /** 本地字体名称，优先级高于自动生成名称 */
         localFamily: string | string[] | false;
-        /** 当 fontFamily 不支持一些 format 时，动用其它 format */
+        /** 当 fontFamily 不支持一些 format 时，动用其它 format
+         * @dev
+         */
         polyfill: ({ name: string; format?: string } | string)[];
+        /**
+         * 控制 css 字体相关的注释内容，用于调试和优化。
+         */
         comment:
             | {
                   /**
-                   * cn-font-split 相关的数据
+                   * 基本的构建信息
                    * @default true
                    */
                   base?: false;
@@ -54,15 +81,21 @@ export type InputTemplate = {
                    */
                   nameTable?: false;
                   /**
-                   * 显示每个字体包含有的 unicode range 的字符, debug 专用
+                   * 显示每个字体包含有的 unicode range 的字符, debug 用
                    * @default false
                    */
                   unicodes?: true;
               }
             | false;
+        /**
+         * 控制是否对 CSS 文件进行压缩，以减小文件大小。
+         * @default true
+         */
         compress: boolean;
     }>;
-    /** 输出的字体类型，默认 woff2 */
+    /** 输出的字体类型，
+     * @default woff2
+     */
     targetType?: FontType;
 
     /**
@@ -74,37 +107,70 @@ export type InputTemplate = {
     autoChunk?: boolean;
     /*  自动分包时使用，优先分包这些字符 */
     unicodeRank?: number[][];
-    /** 配合 autoChunk 使用，预计每个包的大小，插件会尽量打包到这个大小  */
+    /** 配合 autoChunk 使用，预计每个包的大小，插件会尽量打包到这个大小
+     * @default 71680 (70 * 1024)
+     */
     chunkSize?: number;
-    /** 分包字符的容忍度，这个数值是基础值的倍数 */
+    /**
+     * 分包字符的容忍度，这个数值是基础值的倍数
+     * @default  1.7
+     */
     chunkSizeTolerance?: number;
-    /** 最大允许的分包数目，超过这个数目，程序报错退出 */
+    /**
+     * 最大允许的分包输出字体文件数目，超过这个数目，程序报错退出
+     * @default 600
+     */
     maxAllowSubsetsCount?: number;
-    /** 输出的 css 文件的名称 ，默认为 result.css */
+    /**
+     * 输出的 css 文件的名称
+     * @default result.css
+     */
     cssFileName?: string;
 
-    /** 是否输出 HTML 测试文件  */
+    /** 是否输出 HTML 测试文件
+     * @default: true
+     */
     testHTML?: boolean;
-    /** 是否输出报告文件  */
+    /** 是否输出报告文件
+     * @default true
+     */
     reporter?: boolean;
-    /** 是否输出预览图 */
+    /**
+     * 是否输出预览图
+     */
     previewImage?: {
-        /** 图中需要显示的文本 */
+        /**
+         * 图中需要显示的文本
+         * @default 中文网字计划\nThe Project For Web
+         */
         text?: string;
-        /** 预览图的文件名，不用带后缀名 */
+        /**
+         * 预览图的文件名，不用带后缀名
+         * @default preview.svg
+         */
         name?: string;
     };
     /**
      * 日志输出<副作用>
      */
     log?: (...args: any[]) => void;
 
+    /**
+     * tslog 的日志配置
+     * @debugger
+     */
     logger?: {
         settings?: ISettingsParam<unknown>;
     };
-    /** 自定义输出字体名称，优先于 outputFile，用于缩短字体文件名称 */
+    /**
+     * 重命名字体名称, 可以使用 webpack 的重命名字符串
+     * @default [hash][ext]
+     */
     renameOutputFont?: string | ((replaceProps: ReplaceProps) => string);
-    /** 输出文件的方式，如果你需要在特定的平台使用，那么需要适配这个函数 */
+    /**
+     * 输出文件的函数，
+     * @description 如果你需要在特定的平台使用，那么需要适配这个函数
+     */
     outputFile?: IOutputFile;
     threads?:
         | {
@@ -113,15 +179,18 @@ export type InputTemplate = {
                * @protected
                */
               service?: ConvertManager;
-              /* 是否进行多线程切割 */
+              /*
+               * 是否进行多线程切割
+               * @default true
+               */
               split?: boolean;
               /* workerpool 允许的配置项 */
               options?: WorkerPoolOptions;
           }
         | false;
     /**
      * 字体复杂字形等特性的支持
-     * @todo
+     * @dev
      */
     fontFeature?: boolean;
 };

packages/subsets/test/node.test.mjs

@@ -16,6 +16,8 @@ fontSplit({
     // subsets: JSON.parse(await fs.readFile("./subsets/misans.json", "utf-8")),
     previewImage: {},
     chunkSize: 70 * 1024,
+    testHTML: false,
+    reporter: false,
     css: {
         // fontWeight: false
         // localFamily: false,