stylelint-typesstylelint-define-config
Provide a defineConfig function for stylelint.config.js.
Install
npm i -D stylelint-define-config
# or
pnpm add -D stylelint-define-config
# or
yarn add -D stylelint-define-configUsage
By default only stylelint's rules are supported. To activate auto-suggestions for Rules of specific plugins, you need to install the respective types for that plugin.
Plugins can either support their own types, or they could be supported by the community in the @stylelint-types repository.
stylelint.config.js
// @ts-check
const defineConfig = require('stylelint-define-config')
/// <reference types="@stylelint-types/stylelint-scss" />
module.exports = defineConfig({
extends: 'stylelint-config-standard',
rules: {
// ...rules
}
})Why?
Improve your stylelint configuration experience with:
- auto-suggestions
- type checking (Use
// @ts-checkat the first line in yourstylelint.config.[c,m]js) - documentation
Community Plugins
- @stylelint-types/stylelint-scss
- @stylelint-types/stylelint-stylistic
- @stylelint-types/stylelint-codeguide
- @stylelint-types/stylelint-scales
- @stylelint-types/stylelint-order
- @stylelint-types/stylelint-stylus
Want to support your own plugin?
:warning: This feature is very new and requires the support of the respective plugin owners
Add a declare module to your plugin package like this:
declare module 'stylelint-define-config' {
export interface CustomRuleOptions {
/**
* Require or disallow a newline after the closing brace of `@else` statements.
*
* @see [at-else-closing-brace-newline-after](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-else-closing-brace-space-after)
*/
'scss/at-else-closing-brace-newline-after': AtElseClosingBraceNewlineAfterOptions
// ... more Rules
}
}import { RuleConfig } from 'stylelint-define-config'
export type AtElseClosingBraceNewlineAfterOptions = RuleConfig<'always-last-in-chain', {
disableFix?: boolean
}>There are other interfaces that can be extended.
CustomExtendsCustomPluginsCustomSyntax