# stylelint-config-wordpress

> WordPress shareable config for stylelint

Latest version **17.0.0** (published 2020-05-31) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install stylelint-config-wordpress
pnpm add stylelint-config-wordpress
yarn add stylelint-config-wordpress
bun add stylelint-config-wordpress
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 17.0.0 |
| Published | 2020-05-31 |
| First published | 2015-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 20 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 96 |
| Author | stylelint |
| Maintainers | jeddy3, ntwb |
| Keywords | code, code style, css, lint, linter, linting, stylelint, stylelint-config, stylelint-config-wordpress, validate, wordpress, WordPress |

## Links

- npm: https://www.npmjs.com/package/stylelint-config-wordpress
- Repository: https://github.com/WordPress-Coding-Standards/stylelint-config-wordpress
- Issues: https://github.com/WordPress-Coding-Standards/stylelint-config-wordpress/issues
- npm.io page: https://npm.io/package/stylelint-config-wordpress

## Dependencies (3)

- [stylelint-scss](https://npm.io/package/stylelint-scss.md) ^3.17.2
- [stylelint-config-recommended](https://npm.io/package/stylelint-config-recommended.md) ^3.0.0
- [stylelint-config-recommended-scss](https://npm.io/package/stylelint-config-recommended-scss.md) ^4.2.0

## 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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 17.0.0 (latest) — 2020-05-31
- 16.0.0 — 2019-12-31
- 15.0.0 — 2019-10-05
- 14.0.0 — 2019-04-18
- 13.1.0 — 2018-08-19
- 13.0.0 — 2018-03-19
- 12.0.0 — 2017-07-18
- 11.0.0 — 2017-05-16
- 10.0.2 — 2017-04-29
- 10.0.1 — 2017-04-21
- 10.0.0 — 2017-04-21
- 9.1.1 — 2016-09-30
- 9.1.0 — 2016-09-30
- 9.0.0 — 2016-09-10
- 8.0.0 — 2016-06-14
- … 17 more at https://npm.io/package/stylelint-config-wordpress/versions

## README

# stylelint-config-wordpress
[![NPM version](http://img.shields.io/npm/v/stylelint-config-wordpress.svg)](https://www.npmjs.org/package/stylelint-config-wordpress) [![Build Status](https://api.travis-ci.org/WordPress-Coding-Standards/stylelint-config-wordpress.svg?branch=master)](https://travis-ci.org/WordPress-Coding-Standards/stylelint-config-wordpress) 

> WordPress shareable config for stylelint.

Configuration rules to ensure your CSS is compliant with the [WordPress CSS Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/css/).

-   `stylelint-config-wordpress` extends [`stylelint-config-recommended`](https://github.com/stylelint/stylelint-config-recommended)

## Table of Contents

-   [Installation](#installation)
-   [Usage](#usage)
-   [Presets](#presets)
-   [Extending the config](#extending-the-config)
-   [Changelog](#changelog)
-   [License](#license)

## Installation

```bash
$ npm install stylelint-config-wordpress --save-dev
```

## Usage

If you've installed `stylelint-config-wordpress` locally within your project, just set your `stylelint` config to:

```json
{
  "extends": "stylelint-config-wordpress"
}
```

If you've globally installed `stylelint-config-wordpress` using the `-g` flag, then you'll need to use the absolute path to `stylelint-config-wordpress` in your config:

```json
{
  "extends": "/absolute/path/to/stylelint-config-wordpress"
}
```

## Presets

In addition to the default preset, there is also a SCSS preset. This preset extends both `stylelint-config-wordpress` and [`stylelint-config-recommended-scss`](https://github.com/kristerkari/stylelint-config-recommended-scss).

### SCSS

```json
{
  "extends": [
    "stylelint-config-wordpress/scss"
  ]
}
```

## Extending the config

Simply add a `"rules"` key to your config and add your overrides there.

For example, to change the `indentation` to four spaces and turn off the `number-leading-zero` rule:


```json
{
  "extends": "stylelint-config-wordpress",
  "rules": {
    "indentation": 4,
    "number-leading-zero": null
  }
}
```

## [Changelog](CHANGELOG.md)

## [License](LICENSE)

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