# stylelint-config-styled-components

> A shareable stylelint config for stylelint-processor-styled-components

Latest version **0.1.1** (published 2017-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install stylelint-config-styled-components
pnpm add stylelint-config-styled-components
yarn add stylelint-config-styled-components
bun add stylelint-config-styled-components
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-08-29 |
| First published | 2017-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 68 |
| Author | ismay |
| Maintainers | ismay |
| Keywords | stylelint, stylelint-config, styled-components |

## Links

- npm: https://www.npmjs.com/package/stylelint-config-styled-components
- Repository: https://github.com/styled-components/stylelint-config-styled-components
- Homepage: https://github.com/styled-components/stylelint-config-styled-components#readme
- Issues: https://github.com/styled-components/stylelint-config-styled-components/issues
- npm.io page: https://npm.io/package/stylelint-config-styled-components

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2017-08-29

## 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]

## 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
```

## Usage

After installing, add this config to your stylelint config like so:

```
{
  "extends": "stylelint-config-styled-components"
}
```

If you're extending multiple shareable configs, put this config as the last so it overrides the relevant rules in all previous configs:

```
{
  "extends": [
    "stylelint-config-standard",
    "stylelint-config-styled-components"
  ]
}
```

See also https://stylelint.io/user-guide/configuration for documentation on the various ways
stylelint can be configured.

## 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/

---
_Source: https://npm.io/package/stylelint-config-styled-components · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._