@asvetliakov/stylelint-processor-styled-components
v1.5.1
Published
A stylelint processor for styled-components
Downloads
13
Maintainers
Readme
stylelint-processor-styled-components
Lint your styled components with stylelint!
Setup
You need:
stylelint
(duh)- This processor, to extract styles from
styled-components
- The
stylelint-config-styled-components
config to disable stylelint rules that clash withstyled-components
- Your favorite
stylelint
config! (for examplestylelint-config-recommended
)
(npm install --save-dev
stylelint
stylelint-processor-styled-components
stylelint-config-styled-components
stylelint-config-recommended)
Now use those in your .stylelintrc
and run stylelint with your JavaScript files!
{
"processors": ["stylelint-processor-styled-components"],
"extends": [
"stylelint-config-recommended",
"stylelint-config-styled-components"
]
}
NOTE: The processor works with Flow- and TypeScript-typed files too! (we'll assume TypeScript usage if your files end in
.ts
or.tsx
)
Documentation
Further documentation for this processor lives on the styled-components website!
License
Licensed under the MIT License, Copyright © 2017 Maximilian Stoiber. See LICENSE.md for more information!
Based on Mapbox' excellent stylelint-processor-markdown
, thanks to @davidtheclark!