stylelint

一个强大的，现代的代码检查工具，可以帮助您避免错误并在您的样式中强制执行约定。

特性

它很强大，因为它：

• 有超过160条内置规则来捕捉错误，采取限制和执行风格约定
• 懂得最新的CSS语法，包括自定义属性和4级选择器
• 从 HTML、markdown、CSS-in-JS 的对象/模板字符串中提取内嵌样式
• 解析类CSS语法，如SCSS、Sass、Less 和 SugarSS
• 支持插件，这样您就可以创建自己的规则或使用社区编写的插件
• 自动修复一些违规（实验性功能）
• 经10000多个单元测试充分测试
• 支持可共享的配置，您可以扩展或创建自己的配置
• 是非倾向性的，所以您可以根据您的确切需要定制代码检查工具
• 有一个不断发展的社区，被用于 Facebook, GitHub 和 WordPress

示例输出

入门

它很容易上手。

首先，决定如何使用stylelint：

• 在命令行中
• 在您的文本编辑器中, 例如在 VS Code 中
• 在您的构建工具中, 例如在 webpack 中
• 通过 Node.js API
• 作为 PostCSS 插件

然后创建您的配置对象。您可以扩展共享配置或制作自己的配置。

扩展共享配置

这是最快捷的入门方式。我们建议您扩展：

• stylelint-config-recommended
• stylelint-config-standard

建议(recommended)配置仅打开可能错误的规则。标准(standard)配置通过打开60个风格规则来扩展它。我们建议您扩展：

• 建议(recommended)配置，如果您使用 prettier 之类的美化排版工具
• 标准(standard)配置，如果您希望 stylelint 强制执行风格约定

您可能希望在配置中添加限制语言功能的规则，作为您的团队/项目特殊规则。

如果您使用语言扩展, 例如 @if 和 @extends, 您可以使用像 stylelint-config-recommended-scss 这样的社区配置代替。

制作您自己的配置

或者，您可以了解规则，然后：

• 从小处开始，只添加您要打开的规则
• 复制，粘贴和调整示例配置中列出的所有规则及其主要选项

指南

您可以在我们的指南中找到有关自定义 stylelint 的详细信息：

• 用户指南 - 如何使用和配置 stylelint
• 开发者指南 - 如何开发 stylelint

需要帮助？

首先阅读我们的常问问题。

如果没有您问题的答案，那么请将问题发布到 stackoverflow

如果出现以下情况，请创建新问题

• 您觉得发现了一个 bug
• 您有功能请求

如果您正在升级，请阅读我们的更改日志以了解最新版本中的更改。

协助我们

要协助我们，您可以：

• 参与任何公开问题或拉取请求
• 使用我们的制定规则指南来创建、增强和调试规则
• 改进文档
• 为任何一切添加新测试
• 改善规则的表现
• 开创新问题来表述您让 stylelint 变得更好的主意
• 开创拉取请求来展示您的主意是如何工作的
• 创建或贡献生态系统工具，例如 VS Code 插件

我们在蓝图文档的指导下工作。

语义版本控制策略

我们有一个语义版本控制策略。任何次要更新都可能报告比以前版本更多的错误。因此，我们建议在 package.json 中使用波浪号 (~)，例如 "stylelint": "~7.2.0" 以保证构建的结果。

许可证

MIT许可证.

贡献者

这个项目归功于所有这些人。贡献。

支持者

谢谢所有支持者！成为支持者。

赞助商

成为赞助商支持这个项目。您的商标将显示在此处，并带有指向您网站的链接。成为赞助商。