ESLint-Stylistic 配置中 semi 选项的正确使用方式

ESLint-Stylistic 是一个专注于代码风格规则的 ESLint 插件，它提供了丰富的配置选项来帮助开发者统一代码风格。在使用过程中，有一个常见的配置问题值得开发者注意。

问题背景

在配置 @stylistic/member-delimiter-style 规则时，开发者可能会遇到一个类型错误提示："Value 'always' should be boolean"。这个错误通常发生在使用配置工厂函数 stylistic.configs.customize() 时，错误地将 semi 选项设置为字符串值。

正确配置方式

member-delimiter-style 规则用于控制 TypeScript 接口和类型字面量中的成员分隔符样式。其 semi 选项应该是一个布尔值，而不是字符串：

stylistic.configs.customize({
  semi: true,  // 正确：使用布尔值
  // 其他配置...
})

常见错误

开发者容易犯的错误是沿用其他规则的配置习惯，将 semi 设为字符串：

// 错误示例
stylistic.configs.customize({
  semi: 'always',  // 错误：应该使用布尔值
  // 其他配置...
})

深入理解

member-delimiter-style 规则的 semi 选项控制是否使用分号作为分隔符。当设置为 true 时：

• 多行情况下使用分号作为分隔符
• 单行情况下也使用分号作为分隔符

而设置为 false 时则表示不使用分号作为分隔符。

最佳实践

1. 明确区分不同规则的配置格式
2. 查阅官方文档确认每个选项的类型
3. 使用 TypeScript 类型提示来避免类型错误
4. 对于布尔选项，始终使用 true/false 而非字符串

通过正确配置这些风格规则，可以确保团队代码风格的一致性，同时避免不必要的配置错误。