Stylelint 项目中关于缩进规则的变更与迁移指南

缩进规则的历史变更

在 Stylelint 16.3.1 版本中，用户报告了一个关于缩进(indentation)规则的问题。该规则在本地运行和官方演示中均显示"Unknown rule indentation"错误。经过调查发现，这是由于在 Stylelint 15.0.0 版本中进行了重大架构调整，将部分样式相关的规则(包括缩进规则)迁移到了专门的插件中。

规则迁移背景

Stylelint 团队为了更清晰地分离核心功能与样式偏好规则，决定将缩进等与代码风格密切相关的规则从核心库中移除。这种架构调整使得核心库更加专注于代码质量检查，而将代码风格相关的规则交给专门的插件处理。

解决方案

对于需要使用缩进规则的用户，现在需要通过安装额外的插件来获得此功能：

1. 安装 @stylistic/stylelint-plugin 插件包
2. 在配置文件中将原来的 "indentation" 规则替换为 "@stylistic/indentation"
3. 可以继续使用原有的配置值，如 "tab" 或数字表示的缩进空格数

配置示例

新的配置文件应如下所示：

{
  "plugins": ["@stylistic/stylelint-plugin"],
  "rules": {
    "@stylistic/indentation": 2  // 或 "tab" 表示使用制表符
  }
}

迁移建议

1. 检查项目中所有依赖缩进规则的地方
2. 更新配置文件以使用新的规则命名空间
3. 确保团队成员都了解这一变更，避免混淆
4. 在项目文档中记录这一变更，方便新成员快速上手

总结

Stylelint 的这次架构调整虽然带来了一定的迁移成本，但从长远来看有利于项目的维护和功能扩展。开发者现在可以更灵活地选择需要的样式规则，而不必引入整个规则集合。对于团队项目，建议在迁移前进行充分的测试，确保代码风格检查功能按预期工作。