@envsa/stylelint-config

@envsa/stylelint-config

Stylelint configuration for @envsa/shared-config.

Overview

It's a shared Stylelint config, plus a command-line tool envsa-stylelint to perform Stylelint-related project initialization, linting, and fixing.

[!IMPORTANT]

You can use this package on its own, but it's recommended to use @envsa/shared-config instead for a single-dependency and single-package approach to linting and fixing your project.

This package is included as a dependency in @envsa/shared-config, which also automatically invokes the command line functionality in this package via its envsa command

Setup

To use just this Stylelint config in isolation:

• Install the .npmrc in your project root. This is required for correct PNPM behavior:

  pnpm dlx @envsa/repo-config init
  

• Add the package:

  pnpm add -D @envsa/stylelint-config
  

• Add the starter stylelint.config.js file to your project root, and add any customizations you'd like:

  pnpm exec envsa-stylelint init
  

Rules

• stylelint-config-recommended (Rules)
• stylelint-config-standard (Extends the above with additional rules)
• stylelint-config-standard-scss For projects still using scss
• stylelint-config-clean-order
• stylelint-config-html (Parses HTML, XML, Vue, Svelte, Astro, and PHP files)
• Additional customizations

Usage

The Stylelint binary should be picked up automatically by VS Code plugins.

You can call it directly, or use the script bundled with the config.

Integrate with your package.json scripts as you see fit, for example:

{
  "scripts": {
    "lint": "envas-stylelint lint",
    "fix": "envas-stylelint fix"
  }
}

Configuration

To create a stylelint.config.js in your project root:

pnpm exec envas-stylelint init

(Note that this will delete the stylelint property in your package.json!)

Or

To create a stylelint property in package.json:

pnpm exec envas-stylelint init --location package

(Note that this will delete the stylelint.config.js file in your project root!)

Ignoring files

Ignores all files in .gitignore by default.

Additional tool-specific ignores may be added to the config via the ignoreFiles key.

Ignoring code

See the Stylelint documentation.

Blocks:

/* stylelint-disable */ ... /* stylelint-enable */

Inline:

/* stylelint-disable-line */

Next line:

/* stylelint-disable-next-line

CLI

Command: envsa-stylelint

Envsa's Stylelint shared configuration tools.

This section lists top-level commands for envsa-stylelint.

Usage:

envsa-stylelint <command>

Command	Argument	Description
init		Initialize by copying starter config files to your project root or to your package.json file.
lint	[files..]	Lint your project with Stylelint. Matches files below the current working directory by default.
fix	[files..]	Fix your project with Stylelint. Matches files below the current working directory by default.
print-config	[file]	Print the effective Stylelint configuration. Package-scoped by default, file-scoped if a file argument is provided..

Option	Description	Type
--help -h	Show help	boolean
--version -v	Show version number	boolean

See the sections below for more information on each subcommand.

Subcommand: envsa-stylelint init

Initialize by copying starter config files to your project root or to your package.json file.

Usage:

envsa-stylelint init

Option	Description	Type	Default
--location	TK	"file" "package"	"file"
--help -h	Show help	boolean
--version -v	Show version number	boolean

Subcommand: envsa-stylelint lint

Lint your project with Stylelint. Matches files below the current working directory by default.

Usage:

envsa-stylelint lint [files..]

Positional Argument	Description	Type	Default
files	Files or glob pattern to lint.	array	"**/*.{css,scss,sass,svelte,html,astro,tsx,jsx,php,vue,twig}"

Option	Description	Type
--help -h	Show help	boolean
--version -v	Show version number	boolean

Subcommand: envsa-stylelint fix

Fix your project with Stylelint. Matches files below the current working directory by default.

Usage:

envsa-stylelint fix [files..]

Positional Argument	Description	Type	Default
files	Files or glob pattern to fix.	array	"**/*.{css,scss,sass,svelte,html,astro,tsx,jsx,php,vue,twig}"

Option	Description	Type
--help -h	Show help	boolean
--version -v	Show version number	boolean

Subcommand: envsa-stylelint print-config

Print the effective Stylelint configuration. Package-scoped by default, file-scoped if a file argument is provided..

Usage:

envsa-stylelint print-config [file]

Positional Argument	Description	Type
file	File or glob pattern to TK.	string

Option	Description	Type
--help -h	Show help	boolean
--version -v	Show version number	boolean

Notes

Ignores files in .gitignore

Credits

Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.

License

MIT © Liam Rella