@yarn-tool/static-file 3.0.3 → 3.0.5

package/lib/root/getRootCopyStaticFiles.js

@@ -2,10 +2,57 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRootCopyStaticFilesAuto = getRootCopyStaticFilesAuto;
 const const_1 = require("../const");
+/**
+ * Get the appropriate static files map based on root data / 根據根目錄數據獲取適當的靜態檔案映射
+ *
+ * Determines which static files should be copied based on whether the current
+ * directory is the workspace root and whether it has workspaces.
+ * 根據當前目錄是否為工作區根目錄以及是否具有工作區，確定應複製哪些靜態檔案。
+ *
+ * @param rootData - Information about the project root / 關於專案根目錄的資訊
+ * @param rootData.isRoot - Whether the current directory is the workspace root / 當前目錄是否為工作區根目錄
+ * @param rootData.hasWorkspace - Whether the project has workspaces / 專案是否具有工作區
+ *
+ * @returns An array of static file entries to copy / 要複製的靜態檔案條目陣列
+ *
+ * @example
+ * ```typescript
+ * import { getRootCopyStaticFilesAuto } from '@yarn-tool/static-file';
+ *
+ * // For a workspace root with workspaces
+ * // 對於具有工作區的工作區根目錄
+ * const files1 = getRootCopyStaticFilesAuto({
+ *   isRoot: true,
+ *   hasWorkspace: true
+ * });
+ * // Returns only defaultCopyStaticFiles (not root-only files)
+ * // 僅返回 defaultCopyStaticFiles（不包含僅根目錄的檔案）
+ *
+ * // For a standalone project root
+ * // 對於獨立專案根目錄
+ * const files2 = getRootCopyStaticFilesAuto({
+ *   isRoot: true,
+ *   hasWorkspace: false
+ * });
+ * // Returns defaultCopyStaticFiles + defaultCopyStaticFilesRootOnly
+ * // 返回 defaultCopyStaticFiles + defaultCopyStaticFilesRootOnly
+ *
+ * // For a package within a workspace
+ * // 對於工作區內的套件
+ * const files3 = getRootCopyStaticFilesAuto({
+ *   isRoot: false,
+ *   hasWorkspace: true
+ * });
+ * // Returns only defaultCopyStaticFiles
+ * // 僅返回 defaultCopyStaticFiles
+ * ```
+ */
 function getRootCopyStaticFilesAuto(rootData) {
+    // Start with default package-level files / 從預設套件層級檔案開始
     let file_map = [
         ...const_1.defaultCopyStaticFiles,
     ];
+    // Add root-only files if this is the root and has no workspaces / 如果這是根目錄且沒有工作區，則添加僅根目錄的檔案
     if (rootData.isRoot) {
         if (!rootData.hasWorkspace) {
             file_map = [

package/lib/root/getRootCopyStaticFiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRootCopyStaticFiles.js","sourceRoot":"","sources":["getRootCopyStaticFiles.ts"],"names":[],"mappings":";;AAIA,gEAkBC;AApBD,oCAAkF;AAElF,SAAgB,0BAA0B,CAAC,QAA6D;IAEvG,IAAI,QAAQ,GAAiC;QAC5C,GAAG,8BAAsB;KACzB,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,EACnB,CAAC;QACA,IAAI,CAAC,QAAQ,CAAC,YAAY,EAC1B,CAAC;YACA,QAAQ,GAAG;gBACV,GAAG,QAAQ;gBACX,GAAG,sCAA8B;aACjC,CAAC;QACH,CAAC;IACF,CAAC;IAED,OAAO,QAAQ,CAAA;AAChB,CAAC","sourcesContent":["import { IFindRootReturnType } from '@yarn-tool/find-root';\nimport { IStaticFilesMapArray } from '../types';\nimport { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from '../const';\n\nexport function getRootCopyStaticFilesAuto(rootData: Pick<IFindRootReturnType, 'isRoot'| 'hasWorkspace'>)\n{\n\tlet file_map: IStaticFilesMapArray<string> = [\n\t\t...defaultCopyStaticFiles,\n\t];\n\n\tif (rootData.isRoot)\n\t{\n\t\tif (!rootData.hasWorkspace)\n\t\t{\n\t\t\tfile_map = [\n\t\t\t\t...file_map,\n\t\t\t\t...defaultCopyStaticFilesRootOnly,\n\t\t\t];\n\t\t}\n\t}\n\n\treturn file_map\n}\n"]}
+{"version":3,"file":"getRootCopyStaticFiles.js","sourceRoot":"","sources":["getRootCopyStaticFiles.ts"],"names":[],"mappings":";;AA0DA,gEAoBC;AAnED,oCAAkF;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,SAAgB,0BAA0B,CAAC,QAA6D;IAEvG,uDAAuD;IACvD,IAAI,QAAQ,GAAiC;QAC5C,GAAG,8BAAsB;KACzB,CAAC;IAEF,2FAA2F;IAC3F,IAAI,QAAQ,CAAC,MAAM,EACnB,CAAC;QACA,IAAI,CAAC,QAAQ,CAAC,YAAY,EAC1B,CAAC;YACA,QAAQ,GAAG;gBACV,GAAG,QAAQ;gBACX,GAAG,sCAA8B;aACjC,CAAC;QACH,CAAC;IACF,CAAC;IAED,OAAO,QAAQ,CAAA;AAChB,CAAC","sourcesContent":["/**\n * Get root copy static files configuration / 獲取根目錄複製靜態檔案配置\n *\n * This module provides a function to determine the appropriate static files\n * to copy based on the project root structure.\n * 此模組提供根據專案根目錄結構確定要複製的適當靜態檔案的函數。\n *\n * @module getRootCopyStaticFiles\n */\nimport { IFindRootReturnType } from '@yarn-tool/find-root';\nimport { IStaticFilesMapArray } from '../types';\nimport { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from '../const';\n\n/**\n * Get the appropriate static files map based on root data / 根據根目錄數據獲取適當的靜態檔案映射\n *\n * Determines which static files should be copied based on whether the current\n * directory is the workspace root and whether it has workspaces.\n * 根據當前目錄是否為工作區根目錄以及是否具有工作區，確定應複製哪些靜態檔案。\n *\n * @param rootData - Information about the project root / 關於專案根目錄的資訊\n * @param rootData.isRoot - Whether the current directory is the workspace root / 當前目錄是否為工作區根目錄\n * @param rootData.hasWorkspace - Whether the project has workspaces / 專案是否具有工作區\n *\n * @returns An array of static file entries to copy / 要複製的靜態檔案條目陣列\n *\n * @example\n * ```typescript\n * import { getRootCopyStaticFilesAuto } from '@yarn-tool/static-file';\n *\n * // For a workspace root with workspaces\n * // 對於具有工作區的工作區根目錄\n * const files1 = getRootCopyStaticFilesAuto({\n *   isRoot: true,\n *   hasWorkspace: true\n * });\n * // Returns only defaultCopyStaticFiles (not root-only files)\n * // 僅返回 defaultCopyStaticFiles（不包含僅根目錄的檔案）\n *\n * // For a standalone project root\n * // 對於獨立專案根目錄\n * const files2 = getRootCopyStaticFilesAuto({\n *   isRoot: true,\n *   hasWorkspace: false\n * });\n * // Returns defaultCopyStaticFiles + defaultCopyStaticFilesRootOnly\n * // 返回 defaultCopyStaticFiles + defaultCopyStaticFilesRootOnly\n *\n * // For a package within a workspace\n * // 對於工作區內的套件\n * const files3 = getRootCopyStaticFilesAuto({\n *   isRoot: false,\n *   hasWorkspace: true\n * });\n * // Returns only defaultCopyStaticFiles\n * // 僅返回 defaultCopyStaticFiles\n * ```\n */\nexport function getRootCopyStaticFilesAuto(rootData: Pick<IFindRootReturnType, 'isRoot'| 'hasWorkspace'>)\n{\n\t// Start with default package-level files / 從預設套件層級檔案開始\n\tlet file_map: IStaticFilesMapArray<string> = [\n\t\t...defaultCopyStaticFiles,\n\t];\n\n\t// Add root-only files if this is the root and has no workspaces / 如果這是根目錄且沒有工作區，則添加僅根目錄的檔案\n\tif (rootData.isRoot)\n\t{\n\t\tif (!rootData.hasWorkspace)\n\t\t{\n\t\t\tfile_map = [\n\t\t\t\t...file_map,\n\t\t\t\t...defaultCopyStaticFilesRootOnly,\n\t\t\t];\n\t\t}\n\t}\n\n\treturn file_map\n}\n"]}

package/lib/types.d.ts

@@ -1,26 +1,99 @@
+/**
+ * Static file ID type / 靜態檔案 ID 類型
+ *
+ * Extracts the union type of all possible file IDs from the static files map array.
+ * 從靜態檔案映射陣列中提取所有可能的檔案 ID 聯合類型。
+ */
 import { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from './const';
 export type IStaticFilesID<T = typeof defaultCopyStaticFiles & typeof defaultCopyStaticFilesRootOnly> = T extends ({
     [n: number]: IStaticFilesMapArrayEntry<infer U>;
 } | {
     readonly [n: number]: IStaticFilesMapArrayEntry<infer U>;
 }) ? U : never;
+/**
+ * Static files map array entry type / 靜態檔案映射陣列條目類型
+ *
+ * Represents a single entry in the static files map array.
+ * 表示靜態檔案映射陣列中的單個條目。
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ *
+ * @param targetFile - Target file path to copy to / 要複製到的目標檔案路徑
+ * @param staticFile - Source static file path / 來源靜態檔案路徑
+ * @param detectFile - Optional file path to detect if target already exists / 可選的檢測檔案路徑，用於判斷目標是否已存在
+ */
 export type IStaticFilesMapArrayEntry<K extends string> = [
     targetFile: K,
     staticFile: string,
     detectFile?: string
 ];
+/**
+ * Static files map record type / 靜態檔案映射記錄類型
+ *
+ * A record mapping target file paths to source file paths.
+ * 將目標檔案路徑映射到來源檔案路徑的記錄類型。
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ */
 export type IStaticFilesMapRecord<K extends string> = {
     [P in K]: string;
 };
+/**
+ * Static files map array type / 靜態檔案映射陣列類型
+ *
+ * An array of static file mapping entries.
+ * 靜態檔案映射條目的陣列。
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ */
 export type IStaticFilesMapArray<K extends string> = IStaticFilesMapArrayEntry<K>[];
+/**
+ * Static files map type / 靜態檔案映射類型
+ *
+ * Can be either an array of entries or a record mapping.
+ * 可以是條目陣列或記錄映射。
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ */
 export type IStaticFiles<K extends string> = IStaticFilesMapArray<K> | IStaticFilesMapRecord<K>;
+/**
+ * Base options for copying static files / 複製靜態檔案的基本選項
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ *
+ * @property cwd - Current working directory / 當前工作目錄
+ * @property staticRoot - Root directory of static files / 靜態檔案的根目錄
+ * @property overwrite - Whether to overwrite existing files / 是否覆蓋已存在的檔案
+ */
 export interface ICopyStaticFilesOptionsBase<K extends string = string> {
     cwd: string;
     staticRoot?: string;
     overwrite?: boolean;
 }
+/**
+ * Options for copying static files / 複製靜態檔案的選項
+ *
+ * Extends the base options with file map configuration.
+ * 擴展基本選項，加入檔案映射配置。
+ *
+ * @template K - The target file path type / 目標檔案路徑類型
+ *
+ * @property file_map - Custom file mapping configuration / 自訂檔案映射配置
+ */
 export interface ICopyStaticFilesOptions<K extends string = string> extends ICopyStaticFilesOptionsBase<K> {
     file_map?: IStaticFiles<K>;
 }
+/**
+ * Extracts the key type from static files map / 從靜態檔案映射中提取鍵類型
+ *
+ * Utility type to extract the union type of target file paths from various static file map formats.
+ * 工具類型，用於從各種靜態檔案映射格式中提取目標檔案路徑的聯合類型。
+ *
+ * @template T - The static files map type / 靜態檔案映射類型
+ */
 export type IStaticFilesKey<T extends IStaticFiles<string> | readonly any[]> = T extends IStaticFilesMapArray<infer K> ? K : T extends readonly IStaticFilesMapArrayEntry<infer K>[] ? K : T extends IStaticFilesMapRecord<infer K> ? K : _Key<T>;
+/**
+ * Internal key extraction type / 內部鍵提取類型
+ * @internal
+ */
 export type _Key<T> = T extends readonly (infer U)[] | (infer U)[] ? (U extends [infer K, string, string] | readonly [infer K, string, string] ? K : never) : never;

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"","sourcesContent":["import { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from './const';\n\nexport type IStaticFilesID<T = typeof defaultCopyStaticFiles & typeof defaultCopyStaticFilesRootOnly> =\n\tT extends ({\n\t\t\t[n: number]: IStaticFilesMapArrayEntry<infer U>\n\t\t} | {\n\t\t\treadonly [n: number]: IStaticFilesMapArrayEntry<infer U>;\n\t\t})\n\t\t? U\n\t\t: never\n\t;\n\nexport type IStaticFilesMapArrayEntry<K extends string> =\n\t[targetFile: K, staticFile: string, detectFile?: string]\n\ntype IStaticFilesMap01<K extends string> = {\n\t[P in K]: IStaticFilesMapArrayEntry<P>\n}\n\nexport type IStaticFilesMapRecord<K extends string> = {\n\t[P in K]: string\n}\n\nexport type IStaticFilesMapArray<K extends string> =\n\tIStaticFilesMapArrayEntry<K>[]\n\nexport type IStaticFiles<K extends string> = IStaticFilesMapArray<K> | IStaticFilesMapRecord<K>\n\nexport interface ICopyStaticFilesOptionsBase<K extends string = string>\n{\n\tcwd: string,\n\tstaticRoot?: string,\n\toverwrite?: boolean,\n}\n\nexport interface ICopyStaticFilesOptions<K extends string = string> extends ICopyStaticFilesOptionsBase<K>\n{\n\tfile_map?: IStaticFiles<K>,\n}\n\nexport type IStaticFilesKey<T extends IStaticFiles<string> | readonly any[]> = T extends IStaticFilesMapArray<infer K>\n\t? K\n\t: T extends readonly IStaticFilesMapArrayEntry<infer K>[]\n\t\t? K\n\t\t: T extends IStaticFilesMapRecord<infer K> ? K\n\t\t\t: _Key<T>\n\t;\n\nexport type _Key<T> = T extends readonly (infer U)[] | (infer U)[]\n\t? (U extends [infer K, string, string] | readonly [infer K, string, string] ? K : never)\n\t: never\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Static file ID type / 靜態檔案 ID 類型\n *\n * Extracts the union type of all possible file IDs from the static files map array.\n * 從靜態檔案映射陣列中提取所有可能的檔案 ID 聯合類型。\n */\nimport { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from './const';\n\nexport type IStaticFilesID<T = typeof defaultCopyStaticFiles & typeof defaultCopyStaticFilesRootOnly> =\n\tT extends ({\n\t\t\t[n: number]: IStaticFilesMapArrayEntry<infer U>\n\t\t} | {\n\t\t\treadonly [n: number]: IStaticFilesMapArrayEntry<infer U>;\n\t\t})\n\t\t? U\n\t\t: never\n\t;\n\n/**\n * Static files map array entry type / 靜態檔案映射陣列條目類型\n *\n * Represents a single entry in the static files map array.\n * 表示靜態檔案映射陣列中的單個條目。\n *\n * @template K - The target file path type / 目標檔案路徑類型\n *\n * @param targetFile - Target file path to copy to / 要複製到的目標檔案路徑\n * @param staticFile - Source static file path / 來源靜態檔案路徑\n * @param detectFile - Optional file path to detect if target already exists / 可選的檢測檔案路徑，用於判斷目標是否已存在\n */\nexport type IStaticFilesMapArrayEntry<K extends string> =\n\t[targetFile: K, staticFile: string, detectFile?: string]\n\n/**\n * Static files map object type (internal) / 靜態檔案映射物件類型（內部使用）\n * @internal\n */\ntype IStaticFilesMap01<K extends string> = {\n\t[P in K]: IStaticFilesMapArrayEntry<P>\n}\n\n/**\n * Static files map record type / 靜態檔案映射記錄類型\n *\n * A record mapping target file paths to source file paths.\n * 將目標檔案路徑映射到來源檔案路徑的記錄類型。\n *\n * @template K - The target file path type / 目標檔案路徑類型\n */\nexport type IStaticFilesMapRecord<K extends string> = {\n\t[P in K]: string\n}\n\n/**\n * Static files map array type / 靜態檔案映射陣列類型\n *\n * An array of static file mapping entries.\n * 靜態檔案映射條目的陣列。\n *\n * @template K - The target file path type / 目標檔案路徑類型\n */\nexport type IStaticFilesMapArray<K extends string> =\n\tIStaticFilesMapArrayEntry<K>[]\n\n/**\n * Static files map type / 靜態檔案映射類型\n *\n * Can be either an array of entries or a record mapping.\n * 可以是條目陣列或記錄映射。\n *\n * @template K - The target file path type / 目標檔案路徑類型\n */\nexport type IStaticFiles<K extends string> = IStaticFilesMapArray<K> | IStaticFilesMapRecord<K>\n\n/**\n * Base options for copying static files / 複製靜態檔案的基本選項\n *\n * @template K - The target file path type / 目標檔案路徑類型\n *\n * @property cwd - Current working directory / 當前工作目錄\n * @property staticRoot - Root directory of static files / 靜態檔案的根目錄\n * @property overwrite - Whether to overwrite existing files / 是否覆蓋已存在的檔案\n */\nexport interface ICopyStaticFilesOptionsBase<K extends string = string>\n{\n\tcwd: string,\n\tstaticRoot?: string,\n\toverwrite?: boolean,\n}\n\n/**\n * Options for copying static files / 複製靜態檔案的選項\n *\n * Extends the base options with file map configuration.\n * 擴展基本選項，加入檔案映射配置。\n *\n * @template K - The target file path type / 目標檔案路徑類型\n *\n * @property file_map - Custom file mapping configuration / 自訂檔案映射配置\n */\nexport interface ICopyStaticFilesOptions<K extends string = string> extends ICopyStaticFilesOptionsBase<K>\n{\n\tfile_map?: IStaticFiles<K>,\n}\n\n/**\n * Extracts the key type from static files map / 從靜態檔案映射中提取鍵類型\n *\n * Utility type to extract the union type of target file paths from various static file map formats.\n * 工具類型，用於從各種靜態檔案映射格式中提取目標檔案路徑的聯合類型。\n *\n * @template T - The static files map type / 靜態檔案映射類型\n */\nexport type IStaticFilesKey<T extends IStaticFiles<string> | readonly any[]> = T extends IStaticFilesMapArray<infer K>\n\t? K\n\t: T extends readonly IStaticFilesMapArrayEntry<infer K>[]\n\t\t? K\n\t\t: T extends IStaticFilesMapRecord<infer K> ? K\n\t\t\t: _Key<T>\n\t;\n\n/**\n * Internal key extraction type / 內部鍵提取類型\n * @internal\n */\nexport type _Key<T> = T extends readonly (infer U)[] | (infer U)[]\n\t? (U extends [infer K, string, string] | readonly [infer K, string, string] ? K : never)\n\t: never\n"]}

package/lib/ws/wsCopyStaticFiles.d.ts

@@ -1,9 +1,59 @@
+/**
+ * Get workspace copy static files configuration / 獲取工作區複製靜態檔案配置
+ *
+ * This module provides a function to get the combined static files map
+ * for workspace-level operations.
+ * 此模組提供獲取工作區層級操作的合併靜態檔案映射的函數。
+ *
+ * @module wsCopyStaticFiles
+ */
 import { defaultCopyStaticFiles, defaultCopyStaticFilesRootOnly } from '../const';
 import { IStaticFiles, IStaticFilesKey } from '../types';
+/**
+ * Remapping configuration for workspace files / 工作區檔案的重新映射配置
+ *
+ * Maps target file names to their template counterparts.
+ * 將目標檔案名稱映射到其模板對應項。
+ *
+ * This allows copying template files directly to their final names.
+ * 這允許將模板檔案直接複製到其最終名稱。
+ */
 declare const remap: {
     readonly 'tsconfig.json': "tsconfig.json.tpl";
     readonly 'lerna.json': "lerna.json.tpl";
     readonly 'pnpm-workspace.yaml': "pnpm-workspace.yaml.tpl";
 };
+/**
+ * Get the combined static files map for workspace operations / 獲取工作區操作的合併靜態檔案映射
+ *
+ * Combines all static file maps (default, root-only, and workspace-root-only)
+ * and applies remapping for template files.
+ * 合併所有靜態檔案映射（預設、僅根目錄和僅工作區根目錄）並應用模板檔案的重新映射。
+ *
+ * This function is useful for setting up a complete workspace with all
+ * necessary configuration files.
+ * 此函數對於設置包含所有必要配置檔案的完整工作區非常有用。
+ *
+ * @returns A combined static files map with remapped entries / 具有重新映射條目的合併靜態檔案映射
+ *
+ * @example
+ * ```typescript
+ * import { getWsCopyStaticFiles } from '@yarn-tool/static-file';
+ *
+ * // Get all static files for workspace setup
+ * // 獲取工作區設置的所有靜態檔案
+ * const files = getWsCopyStaticFiles();
+ *
+ * // The returned map includes:
+ * // - Package-level files (.gitignore, .npmignore, etc.)
+ * // - Root-level files (lerna.json, pnpm-workspace.yaml, etc.)
+ * // - Workspace-root files (__root_ws.ts, jest-preset.js, etc.)
+ * //
+ * // 返回的映射包括：
+ * // - 套件層級檔案（.gitignore、.npmignore 等）
+ * // - 根目錄層級檔案（lerna.json、pnpm-workspace.yaml 等）
+ * // - 工作區根目錄檔案（__root_ws.ts、jest-preset.js 等）
+ * ```
+ */
 export declare function getWsCopyStaticFiles(): IStaticFiles<IStaticFilesKey<typeof defaultCopyStaticFiles | typeof defaultCopyStaticFilesRootOnly> | keyof typeof remap>;
 export default getWsCopyStaticFiles;

package/lib/ws/wsCopyStaticFiles.js

@@ -1,13 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWsCopyStaticFiles = getWsCopyStaticFiles;
+/**
+ * Get workspace copy static files configuration / 獲取工作區複製靜態檔案配置
+ *
+ * This module provides a function to get the combined static files map
+ * for workspace-level operations.
+ * 此模組提供獲取工作區層級操作的合併靜態檔案映射的函數。
+ *
+ * @module wsCopyStaticFiles
+ */
 const const_1 = require("../const");
 const reMapStaticFilesMapArray_1 = require("../reMapStaticFilesMapArray");
+/**
+ * Remapping configuration for workspace files / 工作區檔案的重新映射配置
+ *
+ * Maps target file names to their template counterparts.
+ * 將目標檔案名稱映射到其模板對應項。
+ *
+ * This allows copying template files directly to their final names.
+ * 這允許將模板檔案直接複製到其最終名稱。
+ */
 const remap = {
     'tsconfig.json': 'tsconfig.json.tpl',
     'lerna.json': 'lerna.json.tpl',
     'pnpm-workspace.yaml': 'pnpm-workspace.yaml.tpl',
 };
+/**
+ * Get the combined static files map for workspace operations / 獲取工作區操作的合併靜態檔案映射
+ *
+ * Combines all static file maps (default, root-only, and workspace-root-only)
+ * and applies remapping for template files.
+ * 合併所有靜態檔案映射（預設、僅根目錄和僅工作區根目錄）並應用模板檔案的重新映射。
+ *
+ * This function is useful for setting up a complete workspace with all
+ * necessary configuration files.
+ * 此函數對於設置包含所有必要配置檔案的完整工作區非常有用。
+ *
+ * @returns A combined static files map with remapped entries / 具有重新映射條目的合併靜態檔案映射
+ *
+ * @example
+ * ```typescript
+ * import { getWsCopyStaticFiles } from '@yarn-tool/static-file';
+ *
+ * // Get all static files for workspace setup
+ * // 獲取工作區設置的所有靜態檔案
+ * const files = getWsCopyStaticFiles();
+ *
+ * // The returned map includes:
+ * // - Package-level files (.gitignore, .npmignore, etc.)
+ * // - Root-level files (lerna.json, pnpm-workspace.yaml, etc.)
+ * // - Workspace-root files (__root_ws.ts, jest-preset.js, etc.)
+ * //
+ * // 返回的映射包括：
+ * // - 套件層級檔案（.gitignore、.npmignore 等）
+ * // - 根目錄層級檔案（lerna.json、pnpm-workspace.yaml 等）
+ * // - 工作區根目錄檔案（__root_ws.ts、jest-preset.js 等）
+ * ```
+ */
 function getWsCopyStaticFiles() {
     return (0, reMapStaticFilesMapArray_1.reMapStaticFilesMapArray)([
         ...const_1.defaultCopyStaticFiles,

package/lib/ws/wsCopyStaticFiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"wsCopyStaticFiles.js","sourceRoot":"","sources":["wsCopyStaticFiles.ts"],"names":[],"mappings":";;AAcA,oDAOC;AArBD,oCAIkB;AAElB,0EAAuE;AAEvE,MAAM,KAAK,GAAG;IACb,eAAe,EAAE,mBAAmB;IACpC,YAAY,EAAE,gBAAgB;IAC9B,qBAAqB,EAAE,yBAAyB;CACvC,CAAA;AAEV,SAAgB,oBAAoB;IAEnC,OAAO,IAAA,mDAAwB,EAAC;QAC/B,GAAG,8BAAsB;QACzB,GAAG,sCAA8B;QACjC,GAAG,wCAAgC;KACnC,EAAE,KAAK,CAAC,CAAC;AACX,CAAC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["import {\n\tdefaultCopyStaticFiles,\n\tdefaultCopyStaticFilesRootOnly,\n\tdefaultCopyStaticFilesWsRootOnly,\n} from '../const';\nimport { IStaticFiles, IStaticFilesKey, IStaticFilesMapArray } from '../types';\nimport { reMapStaticFilesMapArray } from '../reMapStaticFilesMapArray';\n\nconst remap = {\n\t'tsconfig.json': 'tsconfig.json.tpl',\n\t'lerna.json': 'lerna.json.tpl',\n\t'pnpm-workspace.yaml': 'pnpm-workspace.yaml.tpl',\n} as const\n\nexport function getWsCopyStaticFiles(): IStaticFiles<IStaticFilesKey<typeof defaultCopyStaticFiles | typeof defaultCopyStaticFilesRootOnly> | keyof typeof remap>\n{\n\treturn reMapStaticFilesMapArray([\n\t\t...defaultCopyStaticFiles,\n\t\t...defaultCopyStaticFilesRootOnly,\n\t\t...defaultCopyStaticFilesWsRootOnly,\n\t], remap);\n}\n\nexport default getWsCopyStaticFiles;\n"]}
+{"version":3,"file":"wsCopyStaticFiles.js","sourceRoot":"","sources":["wsCopyStaticFiles.ts"],"names":[],"mappings":";;AAgEA,oDAOC;AAvED;;;;;;;;GAQG;AACH,oCAIkB;AAElB,0EAAuE;AAEvE;;;;;;;;GAQG;AACH,MAAM,KAAK,GAAG;IACb,eAAe,EAAE,mBAAmB;IACpC,YAAY,EAAE,gBAAgB;IAC9B,qBAAqB,EAAE,yBAAyB;CACvC,CAAA;AAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,oBAAoB;IAEnC,OAAO,IAAA,mDAAwB,EAAC;QAC/B,GAAG,8BAAsB;QACzB,GAAG,sCAA8B;QACjC,GAAG,wCAAgC;KACnC,EAAE,KAAK,CAAC,CAAC;AACX,CAAC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["/**\n * Get workspace copy static files configuration / 獲取工作區複製靜態檔案配置\n *\n * This module provides a function to get the combined static files map\n * for workspace-level operations.\n * 此模組提供獲取工作區層級操作的合併靜態檔案映射的函數。\n *\n * @module wsCopyStaticFiles\n */\nimport {\n\tdefaultCopyStaticFiles,\n\tdefaultCopyStaticFilesRootOnly,\n\tdefaultCopyStaticFilesWsRootOnly,\n} from '../const';\nimport { IStaticFiles, IStaticFilesKey, IStaticFilesMapArray } from '../types';\nimport { reMapStaticFilesMapArray } from '../reMapStaticFilesMapArray';\n\n/**\n * Remapping configuration for workspace files / 工作區檔案的重新映射配置\n *\n * Maps target file names to their template counterparts.\n * 將目標檔案名稱映射到其模板對應項。\n *\n * This allows copying template files directly to their final names.\n * 這允許將模板檔案直接複製到其最終名稱。\n */\nconst remap = {\n\t'tsconfig.json': 'tsconfig.json.tpl',\n\t'lerna.json': 'lerna.json.tpl',\n\t'pnpm-workspace.yaml': 'pnpm-workspace.yaml.tpl',\n} as const\n\n/**\n * Get the combined static files map for workspace operations / 獲取工作區操作的合併靜態檔案映射\n *\n * Combines all static file maps (default, root-only, and workspace-root-only)\n * and applies remapping for template files.\n * 合併所有靜態檔案映射（預設、僅根目錄和僅工作區根目錄）並應用模板檔案的重新映射。\n *\n * This function is useful for setting up a complete workspace with all\n * necessary configuration files.\n * 此函數對於設置包含所有必要配置檔案的完整工作區非常有用。\n *\n * @returns A combined static files map with remapped entries / 具有重新映射條目的合併靜態檔案映射\n *\n * @example\n * ```typescript\n * import { getWsCopyStaticFiles } from '@yarn-tool/static-file';\n *\n * // Get all static files for workspace setup\n * // 獲取工作區設置的所有靜態檔案\n * const files = getWsCopyStaticFiles();\n *\n * // The returned map includes:\n * // - Package-level files (.gitignore, .npmignore, etc.)\n * // - Root-level files (lerna.json, pnpm-workspace.yaml, etc.)\n * // - Workspace-root files (__root_ws.ts, jest-preset.js, etc.)\n * //\n * // 返回的映射包括：\n * // - 套件層級檔案（.gitignore、.npmignore 等）\n * // - 根目錄層級檔案（lerna.json、pnpm-workspace.yaml 等）\n * // - 工作區根目錄檔案（__root_ws.ts、jest-preset.js 等）\n * ```\n */\nexport function getWsCopyStaticFiles(): IStaticFiles<IStaticFilesKey<typeof defaultCopyStaticFiles | typeof defaultCopyStaticFilesRootOnly> | keyof typeof remap>\n{\n\treturn reMapStaticFilesMapArray([\n\t\t...defaultCopyStaticFiles,\n\t\t...defaultCopyStaticFilesRootOnly,\n\t\t...defaultCopyStaticFilesWsRootOnly,\n\t], remap);\n}\n\nexport default getWsCopyStaticFiles;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarn-tool/static-file",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "description": "",
   "homepage": "https://github.com/bluelovers/ws-yarn-workspaces/tree/master/packages/@yarn-tool/static-file#readme",
   "bugs": {
@@ -32,11 +32,11 @@
     "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
   "dependencies": {
-    "fs-extra": "^11.2.0",
+    "fs-extra": "^11.3.3",
     "tslib": ">=2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ab9a6ddd2269cc9eb3167266928b01d42596176d"
+  "gitHead": "ae9b0817b25b1019ba68c88e541bbffc7d84047c"
 }

package/file/test/__root.d.ts

@@ -1,2 +0,0 @@
-export declare const __ROOT: string;
-export declare const isWin: boolean;

package/file/test/__root.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWin = exports.__ROOT = void 0;
-const path_1 = require("path");
-exports.__ROOT = (0, path_1.join)(__dirname, '..');
-exports.isWin = process.platform === "win32";
-//# sourceMappingURL=__root.js.map

package/file/test/__root.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"__root.js","sourceRoot":"","sources":["__root.ts"],"names":[],"mappings":";;;AAAA,+BAA4B;AAEf,QAAA,MAAM,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAE/B,QAAA,KAAK,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC","sourcesContent":["import { join } from \"path\";\n\nexport const __ROOT = join(__dirname, '..');\n\nexport const isWin = process.platform === \"win32\";\n"]}

package/file/tsdx/index.cjs

@@ -1,5 +0,0 @@
-"use strict";
-const tslib_1 = require("tslib");
-const index_1 = tslib_1.__importDefault(require("./index"));
-module.exports = index_1.default;
-//# sourceMappingURL=index.cjs.map

package/file/tsdx/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["index.cts"],"names":[],"mappings":";;AAAA,4DAAwB;AAGxB,iBAAS,eAAC,CAAA","sourcesContent":["import _ from './index';\n\n// @ts-ignore\nexport = _\n"]}

package/file/tsdx/index.d.cts

@@ -1,2 +0,0 @@
-import _ from './index';
-export = _;

package/file/ws-root/__root_ws.d.ts

@@ -1,2 +0,0 @@
-export declare const __ROOT_WS: string;
-export declare const isWin: boolean;

package/file/ws-root/__root_ws.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWin = exports.__ROOT_WS = void 0;
-const path_1 = require("path");
-exports.__ROOT_WS = (0, path_1.join)(__dirname);
-exports.isWin = process.platform === "win32";
-//# sourceMappingURL=__root_ws.js.map

package/file/ws-root/__root_ws.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"__root_ws.js","sourceRoot":"","sources":["__root_ws.ts"],"names":[],"mappings":";;;AAAA,+BAA4B;AAEf,QAAA,SAAS,GAAG,IAAA,WAAI,EAAC,SAAS,CAAC,CAAC;AAE5B,QAAA,KAAK,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC","sourcesContent":["import { join } from \"path\";\n\nexport const __ROOT_WS = join(__dirname);\n\nexport const isWin = process.platform === \"win32\";\n"]}