electron-forge-maker-innosetup 0.3.0 → 0.3.1

package/README.md

@@ -8,25 +8,6 @@
 npm install --save-dev electron-forge-maker-innosetup
 ```
 
-## 前置要求
-
-### 选项一：使用内置便携版（推荐）
-
-将 Innosetup 便携版放置在 `vendor/innosetup/` 目录：
-
-```
-vendor/
-└── innosetup/
-    ├── ISCC.exe
-    ├── ISCmplr.dll
-    ├── Default.isl
-    └── Languages/
-```
-
-### 选项二：系统安装
-
-需要在 Windows 系统上安装 [Innosetup](https://jrsoftware.org/isinfo.php)。
-
 ## 使用方法
 
 ### 导入方式
@@ -45,22 +26,74 @@ import {
 } from "electron-forge-maker-innosetup";
 ```
 
-### 方式一：在配置文件中使用（推荐）
+### 🎉 方式一：使用相对路径
+
+**为什么推荐？**
+
+- **可移植** - 配置可在不同机器间共享
+- **团队协作** - 每个开发者的路径可以不同
+- **CI/CD 友好** - 自动化构建无需修改配置
 
 在 `forge.config.ts` 中：
 
 ```typescript
 import type { ForgeConfig } from "@electron-forge/shared-types";
-import MakerInnosetup from "electron-forge-maker-innosetup";
+import { MakerInnosetup } from "electron-forge-maker-innosetup";
 
 const config: ForgeConfig = {
   makers: [
     new MakerInnosetup(
       {
-        appName: "MyApp",
+        // 基本信息
+        appName: "My Electron App",
+        appVersion: "1.0.0",
         appPublisher: "My Company",
-        setupIconFile: "./assets/icon.ico",
+
+        // 使用相对路径 - 自动基于项目根目录解析
+        setupIconFile: "./assets/icons/icon.ico",
+        licenseFile: "./LICENSE",
+
         createDesktopIcon: true,
+
+        config: {
+          // 使用占位符
+          Defines: {
+            MyAppName: "My Electron App",
+            MyAppExeName: "MyElectronApp.exe",
+          },
+
+          Setup: {
+            AppName: "{#MyAppName}",
+            // 相对路径会自动解析
+            SetupIconFile: "./assets/icons/icon.ico",
+            ArchitecturesAllowed: "x64compatible",
+            PrivilegesRequired: "admin",
+          },
+
+          Files: [
+            {
+              // {build} 占位符会被替换为 Electron Forge 的打包输出目录
+              Source: "{build}\\*",
+              DestDir: "{app}",
+              Flags: "ignoreversion recursesubdirs createallsubdirs",
+            },
+          ],
+
+          Icons: [
+            {
+              Name: "{autoprograms}\\{#MyAppName}",
+              Filename: "{app}\\{#MyAppExeName}",
+            },
+          ],
+
+          Run: [
+            {
+              Filename: "{app}\\{#MyAppExeName}",
+              Description: "Launch {#MyAppName}",
+              Flags: "nowait postinstall skipifsilent",
+            },
+          ],
+        },
       },
       ["win32"]
     ),
@@ -70,7 +103,79 @@ const config: ForgeConfig = {
 export default config;
 ```
 
-### 方式二：使用配置对象
+#### 支持的路径占位符
+
+- `{project}` - 项目根目录
+- `{build}` - Electron Forge 打包输出目录
+- `{assets}` - 资源文件目录（默认为 `assets`）
+
+示例：
+
+```typescript
+setupIconFile: "{assets}/icons/icon.ico",  // 等同于 "./assets/icons/icon.ico"
+setupIconFile: "{project}/resources/icon.ico",
+Source: "{build}\\*",  // Electron Forge 打包后的文件
+```
+
+#### 路径配置
+
+```typescript
+new MakerInnosetup({
+  // ... 其他配置
+
+  // 路径解析配置
+  paths: {
+    projectDir: process.cwd(), // 项目根目录，默认为 cwd()
+    assetsDir: "resources", // 资源目录，默认为 "assets"
+  },
+
+  // 自动解析相对路径，默认为 true
+  resolveRelativePaths: true,
+});
+```
+
+> 📖 **详细文档：**[docs/path-resolution.md](docs/path-resolution.md) - 查看完整的路径解析指南，包括更多示例和最佳实践
+
+### 方式二：使用绝对路径
+
+如果您坚持使用绝对路径，可以禁用自动解析：
+
+```typescript
+import type { ForgeConfig } from "@electron-forge/shared-types";
+import MakerInnosetup from "electron-forge-maker-innosetup";
+
+const config: ForgeConfig = {
+  makers: [
+    new MakerInnosetup(
+      {
+        // 禁用相对路径解析
+        resolveRelativePaths: false,
+
+        // 使用绝对路径
+        setupIconFile: "E:\\workSpace\\my-app\\assets\\icon.ico",
+
+        config: {
+          Setup: {
+            SetupIconFile: "E:\\workSpace\\my-app\\assets\\icon.ico",
+          },
+          Files: [
+            {
+              Source: "E:\\workSpace\\my-app\\out\\*",
+              DestDir: "{app}",
+              Flags: "ignoreversion recursesubdirs",
+            },
+          ],
+        },
+      },
+      ["win32"]
+    ),
+  ],
+};
+
+export default config;
+```
+
+### 方式三：使用配置对象
 
 在 `forge.config.js` 中：
 
@@ -82,6 +187,7 @@ module.exports = {
       config: {
         appName: "MyApp",
         appPublisher: "My Company",
+        // 相对路径会自动解析
         setupIconFile: "./assets/icon.ico",
       },
     },
@@ -225,22 +331,22 @@ const forgeConfig: ForgeConfig = {
 
 ### MakerInnosetupConfig
 
-| 选项                    | 类型              | 默认值             | 说明                                    |
-| ----------------------- | ----------------- | ------------------ | --------------------------------------- |
-| `config`                | `InnoSetupConfig` | -                  | 完整的 Innosetup 配置对象               |
-| `scriptPath`            | `string`          | -                  | 自定义脚本路径（如果提供则忽略 config） |
-| `innosetupPath`         | `string`          | 自动查找           | Innosetup 编译器路径                    |
-| `outputDir`             | `string`          | `./out/installers` | 输出目录                                |
-| `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`          | `./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 命令行参数                  |
 
 ### InnoSetupConfig
 
@@ -264,8 +370,6 @@ const forgeConfig: ForgeConfig = {
 - `CustomMessages` - 自定义消息
 - `Code` - Pascal Script 代码
 
-所有配置项都有完整的 TypeScript 类型提示和文档。
-
 ## 高级用法
 
 ### 使用预处理器常量 (#define)
@@ -277,13 +381,13 @@ config: {
   config: {
     // 定义预处理器常量
     Defines: {
-      MyAppName: "Police Self Report",
+      MyAppName: "Self Report",
       MyAppVersion: "1.0.0",
-      MyAppPublisher: "合肥视尔信息科技有限公司",
-      MyAppExeName: "Police Self Report.exe",
-      MyAppAssocName: "Police Self Report File",
+      MyAppPublisher: "信息科技有限公司",
+      MyAppExeName: "Self Report.exe",
+      MyAppAssocName: "Self Report File",
       MyAppAssocExt: ".myp",
-      MyAppShortcutName: "公安自助接报案系统",
+      MyAppShortcutName: "XXXX系统",
     },
     Setup: {
       // 使用 {#ConstantName} 引用预处理器常量
@@ -319,10 +423,10 @@ config: {
 ; Script generated by the Inno Setup Script Wizard.
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
-#define MyAppName "Police Self Report"
+#define MyAppName "Self Report"
 #define MyAppVersion "1.0.0"
-#define MyAppPublisher "合肥视尔信息科技有限公司"
-#define MyAppExeName "Police Self Report.exe"
+#define MyAppPublisher "信息科技有限公司"
+#define MyAppExeName "Self Report.exe"
 
 [Setup]
 AppName={#MyAppName}

package/dist/MakerInnosetup.d.ts

@@ -8,7 +8,42 @@ export default class MakerInnosetup extends MakerBase<MakerInnosetupConfig> {
     name: string;
     defaultPlatforms: ForgePlatform[];
     private scriptGenerator;
+    private buildDir;
+    private projectDir;
+    private assetsDir;
+    /**
+     * 获取项目根目录
+     */
+    private getProjectDir;
+    /**
+     * 获取构建目录
+     */
+    private getBuildDir;
+    /**
+     * 获取资源目录
+     */
+    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 文件路径

package/dist/MakerInnosetup.js

@@ -50,12 +50,164 @@ const parser_1 = require("./parser");
  * Electron Forge Maker for Innosetup
  */
 class MakerInnosetup extends maker_base_1.default {
+    /**
+     * 获取项目根目录
+     */
+    getProjectDir() {
+        return this.projectDir || this.config?.paths?.projectDir || process.cwd();
+    }
+    /**
+     * 获取构建目录
+     */
+    getBuildDir() {
+        return this.buildDir || this.config?.paths?.buildDir;
+    }
+    /**
+     * 获取资源目录
+     */
+    getAssetsDir() {
+        return this.assetsDir || this.config?.paths?.assetsDir || "assets";
+    }
     constructor(config = {}, platforms) {
+        // 默认启用相对路径解析
+        if (config.resolveRelativePaths === undefined) {
+            config.resolveRelativePaths = true;
+        }
         super(config, platforms);
         this.name = "innosetup";
         this.defaultPlatforms = ["win32"];
         this.scriptGenerator = new generator_1.InnoScriptGenerator();
     }
+    /**
+     * 解析路径 - 支持相对路径转换为绝对路径
+     * @param pathStr 输入路径
+     * @param baseDir 基础目录（默认为 projectDir）
+     * @returns 解析后的绝对路径
+     */
+    resolvePath(pathStr, baseDir) {
+        if (!pathStr) {
+            return undefined;
+        }
+        // 如果禁用了相对路径解析，直接返回
+        if (this.config?.resolveRelativePaths === false) {
+            return pathStr;
+        }
+        // 如果已经是绝对路径，直接返回
+        if (path.isAbsolute(pathStr)) {
+            return pathStr;
+        }
+        // 使用提供的 baseDir 或默认的 projectDir
+        const base = baseDir || this.getProjectDir();
+        return path.resolve(base, pathStr);
+    }
+    /**
+     * 解析配置中的路径占位符
+     * 支持：{project}, {assets}, {build}, {app}
+     * @param pathStr 包含占位符的路径字符串
+     * @returns 解析后的路径
+     */
+    resolvePathPlaceholders(pathStr) {
+        if (!pathStr) {
+            return undefined;
+        }
+        let resolved = pathStr;
+        const projectDir = this.getProjectDir();
+        const buildDir = this.getBuildDir();
+        const assetsDir = this.getAssetsDir();
+        // {project} - 项目根目录
+        resolved = resolved.replace(/\{project\}/g, projectDir);
+        // {build} - 构建输出目录
+        if (buildDir) {
+            resolved = resolved.replace(/\{build\}/g, buildDir);
+        }
+        // {assets} - 资源目录
+        const assetsPath = path.resolve(projectDir, assetsDir);
+        resolved = resolved.replace(/\{assets\}/g, assetsPath);
+        return resolved;
+    }
+    /**
+     * 处理配置对象中的所有路径
+     * @param config Innosetup 配置对象
+     * @param appDir 应用目录
+     */
+    resolveConfigPaths(config, appDir) {
+        if (this.config?.resolveRelativePaths === false) {
+            return;
+        }
+        const projectDir = this.getProjectDir();
+        // 解析 Setup 部分的路径
+        if (config.Setup) {
+            // SetupIconFile
+            if (config.Setup.SetupIconFile) {
+                config.Setup.SetupIconFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.SetupIconFile), projectDir);
+            }
+            // LicenseFile
+            if (config.Setup.LicenseFile) {
+                config.Setup.LicenseFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.LicenseFile), projectDir);
+            }
+            // InfoBeforeFile
+            if (config.Setup.InfoBeforeFile) {
+                config.Setup.InfoBeforeFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.InfoBeforeFile), projectDir);
+            }
+            // InfoAfterFile
+            if (config.Setup.InfoAfterFile) {
+                config.Setup.InfoAfterFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.InfoAfterFile), projectDir);
+            }
+            // WizardImageFile
+            if (config.Setup.WizardImageFile) {
+                config.Setup.WizardImageFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.WizardImageFile), projectDir);
+            }
+            // WizardSmallImageFile
+            if (config.Setup.WizardSmallImageFile) {
+                config.Setup.WizardSmallImageFile = this.resolvePath(this.resolvePathPlaceholders(config.Setup.WizardSmallImageFile), projectDir);
+            }
+        }
+        // 解析 Languages 部分的路径
+        if (config.Languages) {
+            config.Languages.forEach((lang) => {
+                if (lang.LicenseFile && !lang.LicenseFile.startsWith("compiler:")) {
+                    lang.LicenseFile = this.resolvePath(this.resolvePathPlaceholders(lang.LicenseFile), projectDir);
+                }
+                if (lang.InfoBeforeFile &&
+                    !lang.InfoBeforeFile.startsWith("compiler:")) {
+                    lang.InfoBeforeFile = this.resolvePath(this.resolvePathPlaceholders(lang.InfoBeforeFile), projectDir);
+                }
+                if (lang.InfoAfterFile && !lang.InfoAfterFile.startsWith("compiler:")) {
+                    lang.InfoAfterFile = this.resolvePath(this.resolvePathPlaceholders(lang.InfoAfterFile), projectDir);
+                }
+            });
+        }
+        // 解析 Files 部分的路径
+        if (config.Files) {
+            config.Files.forEach((file) => {
+                // Source 路径处理
+                if (file.Source) {
+                    // 首先替换我们自定义的占位符
+                    let sourcePath = this.resolvePathPlaceholders(file.Source);
+                    // 如果替换后不是 Inno Setup 内置常量（如 {app}, {tmp}），则解析为绝对路径
+                    // Inno Setup 常量通常以 {app}, {tmp}, {src}, {win}, {sys} 等开头
+                    const isInnoConstant = sourcePath?.match(/^\{(app|tmp|src|win|sys|pf|cf|dao|fonts|userappdata|localappdata|group|autoprograms|autodesktop|commondocs)/i);
+                    if (sourcePath && !isInnoConstant) {
+                        // 如果包含 * 通配符，需要特殊处理
+                        if (sourcePath.includes("*")) {
+                            const basePath = sourcePath.split("*")[0];
+                            const wildcard = sourcePath.substring(basePath.length);
+                            const resolvedBase = this.resolvePath(basePath, appDir);
+                            sourcePath = resolvedBase ? resolvedBase + wildcard : sourcePath;
+                        }
+                        else {
+                            sourcePath = this.resolvePath(sourcePath, appDir);
+                        }
+                        file.Source = sourcePath;
+                    }
+                    else if (sourcePath) {
+                        // 是 Inno Setup 常量，保持不变
+                        file.Source = sourcePath;
+                    }
+                }
+            });
+        }
+    }
     /**
      * 从 ISS 文件解析配置
      * @param issFilePath ISS 文件路径
@@ -385,6 +537,8 @@ class MakerInnosetup extends maker_base_1.default {
         const appVersion = packageJSON.version || "1.0.0";
         const archId = this.getArchIdentifier(targetArch);
         console.log(`Creating Innosetup installer for ${appName} ${appVersion} (${targetArch})...`);
+        console.log(`Project directory: ${this.getProjectDir()}`);
+        console.log(`Build directory: ${this.getBuildDir()}`);
         // 查找编译器
         const compilerPath = this.findInnosetupCompiler();
         console.log(`Using Innosetup compiler: ${compilerPath}`);
@@ -403,7 +557,7 @@ class MakerInnosetup extends maker_base_1.default {
         let actualOutputDir = outputDir; // 实际的输出目录
         if (this.config.scriptPath) {
             // 使用用户提供的脚本
-            scriptPath = this.config.scriptPath;
+            scriptPath = this.resolvePath(this.config.scriptPath, this.getProjectDir());
             console.log(`Using custom script: ${scriptPath}`);
             // 解析脚本以获取实际的输出目录
             try {
@@ -426,6 +580,8 @@ class MakerInnosetup extends maker_base_1.default {
             // 生成脚本
             const defaultConfig = this.generateDefaultConfig(dir, appName, appVersion, targetArch, outputDir);
             finalConfig = this.mergeConfig(defaultConfig, this.config.config);
+            // 解析配置中的路径
+            this.resolveConfigPaths(finalConfig, dir);
             // 添加任务
             this.addTasks(finalConfig, appName);
             // 生成脚本内容

package/dist/types.d.ts

@@ -604,9 +604,9 @@ export interface MakerInnosetupConfig {
     appPublisher?: string;
     /** 应用程序 ID（如果未在 config 中指定） */
     appId?: string;
-    /** 许可证文件路径 */
+    /** 许可证文件路径（支持相对路径） */
     licenseFile?: string;
-    /** 安装图标文件路径 */
+    /** 安装图标文件路径（支持相对路径） */
     setupIconFile?: string;
     /** 是否创建桌面图标 */
     createDesktopIcon?: boolean;
@@ -614,4 +614,32 @@ export interface MakerInnosetupConfig {
     createQuickLaunchIcon?: boolean;
     /** 编译超时时间（毫秒），默认 5 分钟 */
     compileTimeout?: number;
+    /**
+     * 路径解析配置
+     * 用于解析配置中的相对路径
+     */
+    paths?: {
+        /**
+         * 项目根目录，相对路径将基于此目录解析
+         * 默认为 Electron Forge 的 projectDir
+         */
+        projectDir?: string;
+        /**
+         * 资源文件目录（相对于 projectDir）
+         * 默认为 "assets"
+         * 用于快速引用图标、许可证等资源文件
+         */
+        assetsDir?: string;
+        /**
+         * 构建输出目录（相对于 projectDir）
+         * 默认为 Electron Forge 的打包输出目录
+         */
+        buildDir?: string;
+    };
+    /**
+     * 是否自动解析相对路径
+     * 默认为 true
+     * 设置为 false 时，所有路径将按原样使用（不推荐）
+     */
+    resolveRelativePaths?: boolean;
 }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "electron-forge-maker-innosetup",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "An Electron Forge maker for creating Windows installers using Innosetup with full TypeScript support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "prepublishOnly": "npm run build",
-    "test": "node dist/index.js",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
     "setup-portable": "node scripts/setup-portable.js",
     "prepare": "npm run build",
     "preversion": "npm test",
@@ -19,7 +20,10 @@
     "debug": "^4.3.4"
   },
   "devDependencies": {
+    "@types/jest": "^30.0.0",
     "@types/node": "^20.0.0",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.0.0"
   },
   "files": [