从nw-builder v3迁移到v4的注意事项与示例

nw-builder是一个用于构建NW.js应用程序的工具，近期从v3升级到了v4版本。在迁移过程中，开发者需要注意一些API变更和使用方式的变化。

主要变更点

1. 模块导入方式：v4版本推荐使用ES模块的import语法，但需要注意正确的模块名称是"nw-builder"而非"nwbuild"。

2. 配置选项重命名：多个配置项名称发生了变化：

   • files → srcDir
   • buildDir → outDir
   • appName → app
   • Windows相关选项整合到了app对象中

3. 构建平台指定：platforms选项被简化为platform，需要单独指定平台和架构。

迁移示例

以下是一个从v3迁移到v4的典型示例：

const nwOptions = {
    srcDir: ['./app/**', './package.json'],
    outDir: './build',
    app: 'my-app',
    version: '0.76.0',
    platform: 'win',
    arch: 'x64',
    flavor: 'normal',
    mode: 'build'
};

// Windows特有配置
if (process.platform === 'win32') {
    nwOptions.app = {
        ...nwOptions.app,
        icon: './icon.ico',
        fileDescription: 'My Application',
        company: 'My Company',
        productVersion: '1.0.0'
    };
}

// 使用动态导入
const { default: nwbuild } = await import('nw-builder');
await nwbuild(nwOptions);

常见问题解决

1. 动态导入问题：确保使用正确的模块名称"nw-builder"，并正确处理Promise。

2. Windows配置：所有Windows特有的配置现在都放在app对象下，包括图标和版本信息。

3. 平台指定：不再使用数组形式指定多个平台，需要分别构建不同平台的版本。

最佳实践

1. 对于大型项目，建议将配置单独放在一个配置文件中。

2. 考虑使用async/await语法简化异步操作。

3. 对于跨平台构建，可以使用环境变量来判断当前平台。

4. 在CI/CD流程中，可以为不同平台创建单独的构建任务。

通过理解这些变更点和遵循迁移示例，开发者可以顺利地将项目从nw-builder v3升级到v4，享受新版本带来的改进和性能提升。