https://github.com/kristerkari/stylelint-config-react-native-styled-components

Shareable stylelint config for styled components when using React Native
https://github.com/kristerkari/stylelint-config-react-native-styled-components

react-native styled-components stylelint stylelint-config

Last synced: 2 months ago
JSON representation

Shareable stylelint config for styled components when using React Native

• Host: GitHub
• URL: https://github.com/kristerkari/stylelint-config-react-native-styled-components
• Owner: kristerkari
• License: mit
• Created: 2019-03-24T22:03:17.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-04T18:01:12.000Z (4 months ago)
• Last Synced: 2024-09-06T01:17:12.117Z (4 months ago)
• Topics: react-native, styled-components, stylelint, stylelint-config
• Language: JavaScript
• Homepage:
• Size: 4.4 MB
• Stars: 27
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-config-react-native-styled-components

[![NPM version](http://img.shields.io/npm/v/stylelint-config-react-native-styled-components.svg)](https://www.npmjs.org/package/stylelint-config-react-native-styled-components)

[![Build Status](https://github.com/kristerkari/stylelint-config-react-native-styled-components/workflows/Tests/badge.svg)](https://github.com/kristerkari/stylelint-config-react-native-styled-components/actions?workflow=Tests)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

Shareable stylelint config for [styled components](https://www.styled-components.com/) 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`.

```json

{

  "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.

```json

{

  "processors": ["stylelint-processor-styled-components"],

  "extends": ["stylelint-config-react-native-styled-components"]

}

```

## License

[MIT](/LICENSE)