@cssdoc/stylelint-plugin
v0.16.2
Published
Stylelint rules that check CSS doc-comment hygiene (undocumented modifiers/parts, deprecations, drift).
Downloads
955
Maintainers
Readme
@cssdoc/stylelint-plugin
A Stylelint plugin that checks CSS doc-comment hygiene, powered by the shared
@cssdoc/lint-core rules.
Install
npm i -D @cssdoc/stylelint-plugin stylelintSetup
// stylelint.config.js
export default {
plugins: ["@cssdoc/stylelint-plugin"],
rules: {
"cssdoc/valid-doc-comments": true,
// or with per-rule toggles:
// "cssdoc/valid-doc-comments": [true, { rules: { "missing-summary": false } }],
},
};The rule reports every @cssdoc/lint-core violation: missing
summaries, undocumented modifiers/parts, deprecations without a replacement, and documentation that has
drifted from the CSS.
License
MIT
