インストール

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

注意: このパッケージは長期サポートステータスのあるNode.jsバージョンを必要とします（アクティブLTSまたはメンテナンスLTSリリースを確認）。古いバージョンとは互換性がありません。

使用法

プロジェクト内に@wordpress/stylelint-configをローカルにインストールした場合は、stylelint設定を次のように設定してください: 

  1. {
  2.    "extends": "@wordpress/stylelint-config"
  3. }
  3. ``````bash
  4. {
  5.    "extends": "/absolute/path/to/@wordpress/stylelint-config"
  6. }
  7. `

プリセット

デフォルトのプリセットに加えて、SCSSプリセットと2つのスタイリスティックバリアントプリセットもあります。

SCSS

このプリセットは@wordpress/stylelint-configとstylelint-config-recommended-scssの両方を拡張します。 

  1. {
  2.    "extends": [ "@wordpress/stylelint-config/scss" ]
  3. }

スタイリスティック

このプリセットは@wordpress/stylelint-configを拡張し、indentationなどのスタイリスティックルールを追加します。 

  1. {
  2.    "extends": [ "@wordpress/stylelint-config/stylistic" ]
  3. }

SCSSスタイリスティック

このプリセットは@wordpress/stylelint-config、@wordpress/stylelint-config/stylistic、@wordpress/stylelint-config/scssを拡張し、SCSS用のいくつかのスタイリスティックルールを適応させます。 

  1. {
  2.    "extends": [ "@wordpress/stylelint-config/scss-stylistic" ]
  3. }

設定の拡張

単に"rules"キーを設定に追加し、そこにオーバーライドを追加します。

例えば、indentationを4つのスペースに変更し、number-leading-zeroルールをオフにするには: 

  1. {
  2.    "extends": "@wordpress/stylelint-config/stylistic",
  3.    "rules": {
  4.    "@stylistic/indentation": 4,
  5.    "@stylistic/number-leading-zero": null
  6.    }
  7. }

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。