🤖

stylelint開発ガイドー構文

に公開

内容の目的

本内容は、stylelint開発ガイドー構文 を翻訳し、個人活用のために整理しています。

カスタム構文の作成

カスタム構文とは、SCSS のような他のスタイリング言語や、HTML のようなコンテナ構造をサポートするために、コミュニティによって作成された PostCSS の構文です。これらは customSyntax オプション を使用して指定します。

カスタム構文を作成するには、PostCSS の カスタム構文の書き方 ガイドに目を通してください。また、Awesome Stylelint に掲載されている既存のカスタム構文も参考になります。

カスタム構文を公開した後は、以下の内容を含む共有設定(shared config)を作成することを推奨します:

  • standard config を拡張する
  • カスタム構文をバンドルする
  • 非互換な組み込みルールを無効化する

これらは、対象のファイル拡張子に対する overrides セクション内で定義します。

たとえば、".foo" という拡張子を持つ「foo」という言語のカスタム構文を作成する場合には、次のような内容で "stylelint-config-standard-foo" という共有設定を作成することをおすすめします:

import yourCustomSyntax from "postcss-your-custom-syntax";

export default {
  overrides: [
    {
      files: ["*.foo", "**/*.foo"],
      customSyntax: yourCustomSyntax,
      extends: ["stylelint-config-standard"],
      rules: {
        "at-rule-no-unknown": null
        // ..
      }
    }
  ]
};

PostCSS v7 が使用されなくなるまでは、カスタム構文は require で読み込むことを推奨します。


目次に戻る

Discussion