Angular项目中读取仅含setter的属性时如何触发警告？

我们在Angular项目中广泛使用以下模式：

public _value;
@Input() public set value(value) {
    this._value = value;
}

该模式有特定适用场景，我们希望保留，但开发人员时常会忘记加下划线直接使用this.value读取值——此时因为只有setter没有对应的getter，读取会返回undefined，却无任何错误或警告，导致逻辑异常和调试困难，比如：

if(this.value) {
    // 永远不会进入此处，因为this.value返回undefined
}

现有限制 #

TypeScript目前确实不支持对仅读取setter的操作主动抛出编译错误，这类读取操作会被默认视为undefined类型，但不会触发警告。

可行解决方案 #

1. 自定义ESLint规则

可以编写自定义ESLint规则，检测代码中读取仅含setter的属性的操作并抛出警告。核心逻辑分为两步：

• 遍历代码AST，收集所有仅定义了setter、未定义getter的类属性名
• 检测所有this.xxx形式的属性读取操作，若读取的是上述收集到的属性，则报告警告

简化版的自定义规则示例：

module.exports = {
  create(context) {
    const setterOnlyProps = new Set();

    // 收集仅含setter的公开属性
    context.on('ClassProperty', node => {
      if (node.accessibility === 'public' && node.set && !node.get) {
        setterOnlyProps.add(node.key.name);
      }
    });

    // 检测读取仅含setter属性的操作
    context.on('MemberExpression', node => {
      if (node.object.type === 'ThisExpression' && setterOnlyProps.has(node.property.name)) {
        context.report({
          node,
          message: '禁止直接读取仅含setter的属性 {{name}}，请使用对应的带下划线的变量',
          data: { name: node.property.name }
        });
      }
    });

    return {};
  }
};

将该规则添加到项目的ESLint配置中，即可在开发阶段及时触发警告。

2. 类型强化方案（编译阶段报错）

如果需要更严格的约束，可以手动给仅含setter的属性添加一个抛出错误的getter，同时通过类型定义强化约束：

public _value: string | undefined;
@Input() public set value(value: string | undefined) {
    this._value = value;
}
// 定义getter并抛出错误，同时标记返回类型为never
public get value(): never {
    throw new Error('请勿直接读取value属性，请使用_value');
}

这种方式会在编译阶段直接报错，运行时读取也会抛出明确错误，但会修改原有模式的结构，适合对类型严谨性要求极高的场景。

3. 社区规则集（可选）

部分Angular专用ESLint规则集可能包含类似检测逻辑，但需要注意与当前项目的ESLint、TypeScript版本兼容性，使用前需验证规则有效性。

内容的提问来源于stack exchange，提问作者valepu