electron-forge-maker-innosetup 0.3.3 → 1.0.0

package/README.md

@@ -13,26 +13,17 @@ npm install --save-dev electron-forge-maker-innosetup
 ### 导入方式
 
 ```typescript
-// 命名导入（推荐）
+// 命名导入
 import { MakerInnosetup } from "electron-forge-maker-innosetup";
 
 // 默认导入
 import MakerInnosetup from "electron-forge-maker-innosetup";
 
 // 导入解析器
-import {
-  MakerInnosetup,
-  InnoScriptParser,
-} from "electron-forge-maker-innosetup";
+import { MakerInnosetup, InnoScriptParser } from "electron-forge-maker-innosetup";
 ```
 
-### 🎉 方式一：使用相对路径
-
-**为什么推荐？**
-
-- **可移植** - 配置可在不同机器间共享
-- **团队协作** - 每个开发者的路径可以不同
-- **CI/CD 友好** - 自动化构建无需修改配置
+### 方式一：使用相对路径
 
 在 `forge.config.ts` 中：
 
@@ -105,9 +96,11 @@ export default config;
 
 #### 支持的路径占位符
 
-- `{project}` - 项目根目录
-- `{build}` - Electron Forge 打包输出目录
-- `{assets}` - 资源文件目录（默认为 `assets`）
+| 占位符      | 说明                        | 示例                           |
+| ----------- | --------------------------- | ------------------------------ |
+| `{project}` | 项目根目录                  | `{project}/resources/icon.ico` |
+| `{build}`   | Electron Forge 打包输出目录 | `{build}\\*`                   |
+| `{assets}`  | 资源目录（默认为 `assets`） | `{assets}/icons/icon.ico`      |
 
 示例：
 
@@ -134,11 +127,11 @@ new MakerInnosetup({
 });
 ```
 
-> 📖 **详细文档：**[docs/path-resolution.md](docs/path-resolution.md) - 查看完整的路径解析指南，包括更多示例和最佳实践
+详细文档：[docs/path-resolution.md](docs/path-resolution.md)
 
 ### 方式二：使用绝对路径
 
-如果您坚持使用绝对路径，可以禁用自动解析：
+如果需要使用绝对路径，可以禁用自动解析：
 
 ```typescript
 import type { ForgeConfig } from "@electron-forge/shared-types";
@@ -285,7 +278,7 @@ const config: MakerInnosetupConfig = {
 
 ### 使用自定义 Innosetup 脚本
 
-如果您已有现成的 `.iss` 脚本文件：
+如果已有现成的 `.iss` 脚本文件：
 
 #### 方法 1: 直接使用 ISS 文件
 
@@ -296,7 +289,6 @@ const config: MakerInnosetupConfig = {
     scriptPath: './installer.iss'
   }
 }
-
 ```
 
 #### 方法 2: 解析 ISS 文件为配置
@@ -323,30 +315,30 @@ const forgeConfig: ForgeConfig = {
 };
 ```
 
-> 📝 **详细文档**: 查看 [iss-parser.md](./docs/iss-parser.md) 了解 ISS 解析器的完整使用方法
+详细文档：[iss-parser.md](./docs/iss-parser.md)
 
-> ⚠️ **重要**: 如果你的 ISS 脚本中定义了 `OutputDir`，Maker 会自动解析并在正确的目录中查找安装包。详见 [custom-script-output.md](./docs/custom-script-output.md)
+注意：如果 ISS 脚本中定义了 `OutputDir`，Maker 会自动解析并在正确的目录中查找安装包。详见 [custom-script-output.md](./docs/custom-script-output.md)
 
 ## 配置选项
 
 ### MakerInnosetupConfig
 
-| 选项                    | 类型              | 默认值                    | 说明                                    |
-| ----------------------- | ----------------- | ------------------------- | --------------------------------------- |
-| `config`                | `InnoSetupConfig` | -                         | 完整的 Innosetup 配置对象               |
-| `scriptPath`            | `string`          | -                         | 自定义脚本路径（如果提供则忽略 config） |
-| `innosetupPath`         | `string`          | 自动查找                  | Innosetup 编译器路径                    |
-| `outputDir`             | `string`          | `./out/innosetup.windows` | 输出目录                                |
-| `appName`               | `string`          | -                         | 应用程序名称                            |
-| `appVersion`            | `string`          | -                         | 应用程序版本                            |
-| `appPublisher`          | `string`          | -                         | 应用程序发布者                          |
-| `appId`                 | `string`          | -                         | 应用程序唯一 ID                         |
-| `licenseFile`           | `string`          | -                         | 许可证文件路径                          |
-| `setupIconFile`         | `string`          | -                         | 安装图标文件路径                        |
-| `createDesktopIcon`     | `boolean`         | `false`                   | 是否创建桌面图标                        |
-| `createQuickLaunchIcon` | `boolean`         | `false`                   | 是否创建快速启动图标                    |
-| `gui`                   | `boolean`         | `false`                   | 是否使用 GUI 模式编译                   |
-| `isccOptions`           | `string[]`        | -                         | 额外的 ISCC 命令行参数                  |
+| 选项                    | 类型              | 默认值                               | 说明                                    |
+| ----------------------- | ----------------- | ------------------------------------ | --------------------------------------- |
+| `config`                | `InnoSetupConfig` | -                                    | 完整的 Innosetup 配置对象               |
+| `scriptPath`            | `string`          | -                                    | 自定义脚本路径（如果提供则忽略 config） |
+| `innosetupPath`         | `string`          | 自动查找                             | Innosetup 编译器路径                    |
+| `outputDir`             | `string`          | `{makeDir}/innosetup.windows/{arch}` | 输出目录（可选）                        |
+| `appName`               | `string`          | -                                    | 应用程序名称                            |
+| `appVersion`            | `string`          | -                                    | 应用程序版本                            |
+| `appPublisher`          | `string`          | -                                    | 应用程序发布者                          |
+| `appId`                 | `string`          | -                                    | 应用程序唯一 ID                         |
+| `licenseFile`           | `string`          | -                                    | 许可证文件路径                          |
+| `setupIconFile`         | `string`          | -                                    | 安装图标文件路径                        |
+| `createDesktopIcon`     | `boolean`         | `false`                              | 是否创建桌面图标                        |
+| `createQuickLaunchIcon` | `boolean`         | `false`                              | 是否创建快速启动图标                    |
+| `gui`                   | `boolean`         | `false`                              | 是否使用 GUI 模式编译                   |
+| `isccOptions`           | `string[]`        | -                                    | 额外的 ISCC 命令行参数                  |
 
 ### InnoSetupConfig
 
@@ -434,12 +426,6 @@ AppVersion={#MyAppVersion}
 AppPublisher={#MyAppPublisher}
 ```
 
-**优势：**
-
-- 🔄 更易维护：集中管理常量，修改一处即可
-- 📖 更清晰：生成的 ISS 脚本更具可读性
-- 🔧 更灵活：支持 Inno Setup 原生的预处理器功能
-
 ### 添加自定义 Pascal 代码
 
 ```typescript

package/dist/MakerInnosetup.d.ts

@@ -1,95 +1,164 @@
-import MakerBase, { MakerOptions } from "@electron-forge/maker-base";
-import { ForgePlatform } from "@electron-forge/shared-types";
-import { MakerInnosetupConfig } from "./types";
+import MakerBase, { type MakerOptions } from "@electron-forge/maker-base";
+import type { ForgePlatform } from "@electron-forge/shared-types";
+import type { MakerInnosetupConfig } from "./types";
 /**
- * Electron Forge Maker for Innosetup
+ * Electron Forge 的 Inno Setup Maker
+ *
+ * 使用 Inno Setup 编译器（ISCC.exe）创建 Windows 安装程序
+ *
+ * @example
+ * ```typescript
+ * import { MakerInnosetup } from 'electron-forge-maker-innosetup';
+ *
+ * // 在 forge.config.ts 中
+ * const config: ForgeConfig = {
+ *   makers: [
+ *     new MakerInnosetup({
+ *       appName: 'My App',
+ *       appVersion: '1.0.0',
+ *       setupIconFile: './assets/icon.ico',
+ *       config: {
+ *         Setup: {
+ *           AppName: 'My App',
+ *           AppVersion: '1.0.0',
+ *           DefaultDirName: '{autopf}\\MyApp',
+ *           OutputDir: './out/installer',
+ *         },
+ *       },
+ *     }),
+ *   ],
+ * };
+ * ```
  */
 export default class MakerInnosetup extends MakerBase<MakerInnosetupConfig> {
-    name: string;
-    defaultPlatforms: ForgePlatform[];
+    readonly name = "innosetup";
+    readonly defaultPlatforms: ForgePlatform[];
     private scriptGenerator;
     /**
-     * 获取项目根目录
+     * 从配置获取项目目录，若未配置则使用当前工作目录
      */
     private getProjectDir;
     /**
-     * 获取构建目录
+     * 从配置获取构建目录
      */
     private getBuildDir;
     /**
-     * 获取资源目录
+     * 从配置获取资源目录，若未配置则使用默认值 "assets"
      */
     private getAssetsDir;
     constructor(config?: MakerInnosetupConfig, platforms?: ForgePlatform[]);
     /**
-     * 解析路径 - 支持相对路径转换为绝对路径
-     * @param pathStr 输入路径
-     * @param baseDir 基础目录（默认为 projectDir）
-     * @returns 解析后的绝对路径
-     */
-    private resolvePath;
-    /**
-     * 解析配置中的路径占位符
-     * 支持：{project}, {assets}, {build}, {app}
-     * @param pathStr 包含占位符的路径字符串
-     * @returns 解析后的路径
-     */
-    private resolvePathPlaceholders;
-    /**
-     * 处理配置对象中的所有路径
-     * @param config Innosetup 配置对象
-     * @param appDir 应用目录
-     */
-    private resolveConfigPaths;
-    /**
-     * 从 ISS 文件解析配置
-     * @param issFilePath ISS 文件路径
-     * @returns MakerInnosetupConfig 配置对象
+     * 从 ISS 文件创建 MakerInnosetupConfig
+     *
+     * @param issFilePath - ISS 文件路径
+     * @returns 解析后的配置对象
      */
     static fromIssFile(issFilePath: string): MakerInnosetupConfig;
     /**
-     * 从 ISS 脚本内容解析配置
-     * @param issContent ISS 脚本内容
-     * @returns MakerInnosetupConfig 配置对象
+     * 从 ISS 内容字符串创建 MakerInnosetupConfig
+     *
+     * @param issContent - ISS 文件内容
+     * @returns 解析后的配置对象
      */
     static fromIssContent(issContent: string): MakerInnosetupConfig;
     /**
-     * 检查是否支持当前平台
+     * 检查当前平台是否支持
+     *
+     * @returns 当前平台是否为 Windows
      */
     isSupportedOnCurrentPlatform(): boolean;
     /**
-     * 查找 Innosetup 编译器路径
+     * 创建安装程序
+     *
+     * @param options - Electron Forge Maker 选项
+     * @returns 生成的安装程序文件路径数组
+     */
+    make(options: MakerOptions): Promise<string[]>;
+    /**
+     * 查找 Inno Setup 编译器
+     *
+     * 按以下顺序查找：
+     * 1. 配置中指定的路径
+     * 2. 环境变量 INNOSETUP_PATH
+     * 3. 默认搜索路径
+     *
+     * @returns 编译器路径
+     * @throws CompilerNotFoundError 如果找不到编译器
      */
     private findInnosetupCompiler;
     /**
-     * 根据架构获取架构标识符
+     * 解析相对于基础目录的路径
+     *
+     * @param input - 输入路径
+     * @param baseDir - 基础目录
+     * @returns 解析后的绝对路径
+     */
+    private resolvePath;
+    /**
+     * 解析字符串中的路径占位符
+     *
+     * 支持的占位符：
+     * - {project} - 项目根目录
+     * - {build} - 构建输出目录
+     * - {assets} - 资源文件目录
+     *
+     * @param input - 输入字符串
+     * @returns 替换占位符后的字符串
      */
-    private getArchIdentifier;
+    private resolvePathPlaceholders;
     /**
-     * 根据架构获取 ArchitecturesAllowed 配置
+     * 解析配置中的所有路径
+     *
+     * @param config - Inno Setup 配置
+     * @param appDir - 应用目录
      */
-    private getArchitecturesAllowed;
+    private resolveConfigPaths;
     /**
-     * 生成默认配置
+     * 生成默认的 Inno Setup 配置
+     *
+     * @param appDir - 应用目录
+     * @param appName - 应用名称
+     * @param appVersion - 应用版本
+     * @param arch - 目标架构
+     * @param outputDir - 输出目录
+     * @returns 默认配置对象
      */
     private generateDefaultConfig;
     /**
-     * 合并用户配置和默认配置
+     * 合并用户配置与默认配置
+     *
+     * @param defaultConfig - 默认配置
+     * @param userConfig - 用户配置
+     * @returns 合并后的配置
      */
     private mergeConfig;
     /**
-     * 添加任务（桌面图标、快速启动等）
+     * 添加桌面图标和快速启动任务
+     *
+     * @param config - Inno Setup 配置
+     * @param appName - 应用名称
      */
     private addTasks;
     /**
-     * 执行 Innosetup 编译
+     * 编译 ISS 脚本
+     *
+     * @param scriptPath - 脚本文件路径
+     * @param compilerPath - 编译器路径
+     * @returns 编译输出
+     * @throws CompilationError 编译失败
+     * @throws CompilationTimeoutError 编译超时
      */
     private compileScript;
     /**
-     * 制作安装包
+     * 查找生成的安装程序文件
+     *
+     * @param searchDir - 搜索目录
+     * @param appName - 应用名称
+     * @param appVersion - 应用版本
+     * @param archId - 架构标识
+     * @returns 安装程序文件路径数组
+     * @throws InstallerNotFoundError 如果找不到安装程序
      */
-    make(options: MakerOptions): Promise<string[]>;
+    private findInstaller;
 }
-export * from "./types";
-export { InnoScriptGenerator } from "./generator";
-export { InnoScriptParser } from "./parser";
+//# sourceMappingURL=MakerInnosetup.d.ts.map

package/dist/MakerInnosetup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MakerInnosetup.d.ts","sourceRoot":"","sources":["../src/MakerInnosetup.ts"],"names":[],"mappings":"AAGA,OAAO,SAAS,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EACV,oBAAoB,EAMrB,MAAM,SAAS,CAAC;AAgCjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS,CAAC,oBAAoB,CAAC;IACzE,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,aAAa,EAAE,CAAa;IAEvD,OAAO,CAAC,eAAe,CAAsB;IAE7C;;OAEG;IACH,OAAO,CAAC,aAAa;IAIrB;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;IACH,OAAO,CAAC,YAAY;gBAIR,MAAM,GAAE,oBAAyB,EAAE,SAAS,CAAC,EAAE,aAAa,EAAE;IAU1E;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,oBAAoB;IAQ7D;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,oBAAoB;IAK/D;;;;OAIG;IACH,4BAA4B,IAAI,OAAO;IAIvC;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAmGpD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,qBAAqB;IA6B7B;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAmBnB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAwE1B;;;;;;;;;OASG;IACH,OAAO,CAAC,qBAAqB;IA2D7B;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IA8BnB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAkDhB;;;;;;;;OAQG;YACW,aAAa;IA+E3B;;;;;;;;;OASG;IACH,OAAO,CAAC,aAAa;CAiDtB"}