Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 2.21 KB

README.md

File metadata and controls

75 lines (56 loc) · 2.21 KB
Raw

stylelint-config-react-native-styled-components

NPM version Build Status contributions welcome

Shareable stylelint config for styled components when using React Native.

Installation and usage

Install stylelint-config-react-native-styled-components (and stylelint + stylelint-react-native).

For stylelint v15+ (recommended)

yarn add \
  stylelint \
  stylelint-react-native \
  stylelint-config-react-native-styled-components \
  postcss-styled-syntax --dev

or

npm install \
  stylelint \
  stylelint-react-native \
  stylelint-config-react-native-styled-components \
  postcss-styled-syntax --save-dev

Create the .stylelintrc config file (or open the existing one), extend stylelint-config-react-native-styled-components config, and defined the customSyntax.

{
  "extends": ["stylelint-config-react-native-styled-components"],
  "customSyntax": "postcss-styled-syntax"
}

For stylelint v14 and below

yarn add \
  stylelint \
  stylelint-react-native \
  stylelint-processor-styled-components \
  stylelint-config-react-native-styled-components --dev

or

npm install \
  stylelint \
  stylelint-react-native \
  stylelint-processor-styled-components \
  stylelint-config-react-native-styled-components --save-dev

Create the .stylelintrc config file (or open the existing one) add the stylelint processor and extend stylelint-config-react-native-styled-components config.

{
  "processors": ["stylelint-processor-styled-components"],
  "extends": ["stylelint-config-react-native-styled-components"]
}

License

MIT