@virtual-live-lab/stylelint-config NPM

@virtual-live-lab/stylelint-config

NPM Version

Stylelint configuration for Virtual Live Lab.

Installation

!WARNING monorepoを利用してる場合、利用するすべてのワークスペースでインストールしてください。

Use for css

npm install stylelint \
  @virtual-live-lab/stylelint-config \
  @double-great/stylelint-a11y \
  stylelint-declaration-block-no-ignored-properties \
  stylelint-value-no-unknown-custom-properties \
  stylelint-config-recommended \
  stylelint-config-standard \
  stylelint-config-recess-order \
  --save-dev

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig();

Use for sass / scss

npm install stylelint \
  @virtual-live-lab/stylelint-config \
  @double-great/stylelint-a11y \
  stylelint-declaration-block-no-ignored-properties \
  stylelint-value-no-unknown-custom-properties \
  stylelint-config-recommended \
  stylelint-config-standard \
  stylelint-config-recess-order \
  stylelint-config-standard-scss \
  stylelint-config-sass-guidelines \
  --save-dev

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig({ sass: true });

Use for Astro

!TIP If some syntax error occurred in Astro, you should install postcss-html.
npm install postcss-html --save-dev

npm install stylelint \
  @virtual-live-lab/stylelint-config \
  @double-great/stylelint-a11y \
  stylelint-declaration-block-no-ignored-properties \
  stylelint-value-no-unknown-custom-properties \
  stylelint-config-recommended \
  stylelint-config-standard \
  stylelint-config-recess-order \
  stylelint-config-standard-scss \
  stylelint-config-sass-guidelines \
  stylelint-config-html \
  --save-dev

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig({
  astro: true,
  // enable sass if you use sass / scss
  sass: true,
});

a11y rules

a11y rules are enabled by default. If you do not want to use a11y rules, you can disable it.

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig({ a11y: false });

tailwindcss rules

If you use tailwindcss, you can enable tailwindcss rules.

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig({ tailwindcss: true });

Customization

You can simply pass additional configs to createConfig.

Configs will be merged deeply.

// stylelint.config.mjs
import createConfig from "@virtual-live-lab/stylelint-config";

export default createConfig({
  tailwindcss: true,
  sass: true,
  astro: true,
},
{
  // for example
  overrides: [
    {
      files: ["*.css", "**/*.css"],
      rules: {
        "at-rule-no-unknown": null,
      },
    },
  ],
});