@wordpress/stylelint-config

stylelint 配置规则，用于确保你的 CSS 符合 WordPress CSS 编码标准。

安装

$ npm install @wordpress/stylelint-config --save-dev

注意：此软件包需要具有长期支持状态的 Node.js 版本（请查看 Active LTS 或 Maintenance LTS 版本）。它与旧版本不兼容。

用法

如果你已在项目本地安装了 @wordpress/stylelint-config，只需将你的 stylelint 配置设置为：

{
    "extends": "@wordpress/stylelint-config"
}

如果你使用 -g 标志全局安装了 @wordpress/stylelint-config，则需要在配置中使用 @wordpress/stylelint-config 的绝对路径：

{
    "extends": "/absolute/path/to/@wordpress/stylelint-config"
}

预设

除了默认预设外，还有一个 SCSS 预设和两个风格变体预设。

SCSS

此预设同时继承了 @wordpress/stylelint-config 和 stylelint-config-recommended-scss。

{
    "extends": [ "@wordpress/stylelint-config/scss" ]
}

Stylistic

此预设继承了 @wordpress/stylelint-config，并添加了诸如 indentation 之类的风格规则。

{
    "extends": [ "@wordpress/stylelint-config/stylistic" ]
}

SCSS Stylistic

此预设继承了 @wordpress/stylelint-config、@wordpress/stylelint-config/stylistic 和 @wordpress/stylelint-config/scss，并调整了一些适用于 SCSS 的风格规则。

{
    "extends": [ "@wordpress/stylelint-config/scss-stylistic" ]
}

扩展配置

只需在你的配置中添加一个 "rules" 键，并在其中添加你的覆盖规则。

例如，要将 indentation 更改为四个空格并关闭 number-leading-zero 规则：

{
    "extends": "@wordpress/stylelint-config/stylistic",
    "rules": {
        "@stylistic/indentation": 4,
        "@stylistic/number-leading-zero": null
    }
}

custom-property-pattern

该预设禁止使用 --_gcd-* 和 --_wp-* 自定义属性。这些属性是私有的，随时可能会失效。

Stylelint 不会合并 custom-property-pattern 的值。如果你的项目已经设置了该规则，预设中的限制将被替换——如果你希望保留该限制，请在你的模式中包含 (?!_(?:gcd|wp)-)，例如：

{
    "extends": "@wordpress/stylelint-config",
    "rules": {
        "custom-property-pattern": "^(?!_(?:gcd|wp)-)my-prefix-.+"
    }
}

参与此软件包贡献

这是一个独立软件包，属于 Gutenberg 项目。该项目以 monorepo 形式组织，由多个自包含的软件包组成，每个软件包都有特定用途。此 monorepo 中的软件包发布到 npm，并被 WordPress 以及其他软件项目使用。

要了解更多关于为此软件包或整个 Gutenberg 项目做贡献的信息，请阅读项目的主要 贡献者指南。