https://github.com/styled-components/stylelint-config-styled-components

The shareable stylelint config for stylelint-processor-styled-components
https://github.com/styled-components/stylelint-config-styled-components

styled-components stylelint stylelint-config stylelint-processor

Last synced: 1 day ago
JSON representation

The shareable stylelint config for stylelint-processor-styled-components

• Host: GitHub
• URL: https://github.com/styled-components/stylelint-config-styled-components
• Owner: styled-components
• Created: 2017-06-17T14:14:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T14:57:02.000Z (about 1 year ago)
• Last Synced: 2024-12-23T11:22:44.260Z (8 days ago)
• Topics: styled-components, stylelint, stylelint-config, stylelint-processor
• Language: JavaScript
• Homepage:
• Size: 625 KB
• Stars: 70
• Watchers: 34
• Forks: 10
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# `stylelint-config-styled-components`

The shareable stylelint config for [stylelint-processor-styled-components](https://github.com/styled-components/stylelint-processor-styled-components)

[![npm version][version-badge]][version-url]

[![build status][build-badge]][build-url]

[![greenkeeper badge][greenkeeper-badge]][greenkeeper-url]

**If you're having problems with stylelint and styled-components, please submit an issue over at the [stylelint processor](https://github.com/styled-components/stylelint-processor-styled-components)!**

## Why

When using [stylelint-processor-styled-components](https://github.com/styled-components/stylelint-processor-styled-components)

a couple of stylelint rules throw errors that you cannot prevent. Like 

'[no-empty-source](https://stylelint.io/user-guide/rules/no-empty-source)' or 

'[no-missing-end-of-source-newline](https://stylelint.io/user-guide/rules/no-missing-end-of-source-newline)'.

This shareable config will automatically disable rules that cause unresolvable conflicts. Besides

those rules vendor prefixed [properties](https://stylelint.io/user-guide/rules/property-no-vendor-prefix)

and [values](https://stylelint.io/user-guide/rules/value-no-vendor-prefix) will throw an error since

styled-components automatically generates vendor prefixes for your css. Note that if you want to

change any of these rules you can always override them in your stylelint config.

## Installation

```

npm install stylelint-config-styled-components --save-dev

```

## [Documentation](https://www.styled-components.com/docs/tooling#)

**The documentation for this config lives on [the styled-components website](https://www.styled-components.com/docs/tooling#)!**

- [Interpolation tagging](https://www.styled-components.com/docs/tooling#interpolation-taggingp)

- [Tags](https://www.styled-components.com/docs/tooling#tags)

- [sc-custom](https://www.styled-components.com/docs/tooling#sc-custom)

- [Syntax Notes](https://www.styled-components.com/docs/tooling#syntax-notes)

## License

[MIT](http://ismay.mit-license.org/)

[version-badge]: https://img.shields.io/npm/v/stylelint-config-styled-components.svg

[version-url]: https://www.npmjs.com/package/stylelint-config-styled-components

[build-badge]: https://travis-ci.org/styled-components/stylelint-config-styled-components.svg?branch=master

[build-url]: https://travis-ci.org/styled-components/stylelint-config-styled-components

[greenkeeper-badge]: https://badges.greenkeeper.io/styled-components/stylelint-config-styled-components.svg

[greenkeeper-url]: https://greenkeeper.io/