Projen项目中如何为.projenrc.ts文件设置默认值

在Projen项目中，当我们创建自定义项目类型时，经常需要为.projenrc.ts文件生成默认配置值。本文将详细介绍如何实现这一功能。

问题背景

Projen是一个强大的项目生成工具，允许开发者通过代码定义项目配置。当我们基于Projen创建自定义项目类型时，通常会扩展基础Project类并定义自己的选项接口。

例如，我们可能定义如下接口：

export interface MyProjectOptions {
    readonly name: string;
    readonly libVersion?: string;
}

当用户使用npx projen new命令创建项目时，Projen会自动生成.projenrc.ts文件。但默认情况下，可选参数(libVersion)不会出现在生成的配置文件中，即使用户在接口中定义了默认值。

解决方案

Projen提供了一个特殊的装饰器标记@pjnew，用于指示哪些属性应该包含在自动生成的.projenrc.ts文件中。这个标记需要添加到接口属性的JSDoc注释中。

正确用法如下：

export interface MyProjectOptions {
    readonly name: string;
    /**
     * @pjnew
     */
    readonly libVersion?: string;
}

添加这个标记后，Projen在生成.projenrc.ts文件时会将libVersion属性包含在内，并使用接口中定义的默认值。

实现原理

Projen在解析项目选项接口时，会检查每个属性的JSDoc注释。当发现@pjnew标记时，会将该属性视为"新项目"属性，意味着：

1. 该属性应该出现在通过projen new命令生成的配置中
2. 如果属性有默认值，该默认值会被包含在生成的配置中
3. 即使用户没有显式指定该选项，它仍会出现在配置文件中

高级用法

对于更复杂的场景，我们还可以：

1. 为属性指定默认值表达式而不仅仅是字面量
2. 控制多个相关属性的生成顺序
3. 为不同的项目类型定义不同的默认值生成策略

注意事项

1. @pjnew标记目前文档较少，属于Projen的高级功能
2. 标记必须放在JSDoc注释块中，不能单独使用
3. 对于必填属性(name)，不需要添加标记也会自动包含
4. 默认值必须能够在编译时确定，不能是运行时计算的表达式

通过合理使用@pjnew标记，我们可以创建更加友好和功能完备的自定义项目类型，为用户提供更好的开箱即用体验。