# neworbit-stylelint-config

> NewOrbit standard config for stylelint

Latest version **4.0.0** (published 2024-02-28) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2024-02-28 |
| First published | 2018-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | NewOrbit Ltd |
| Maintainers | senderek, neworbit-admin, petevb, ksstott, thyde1, owenpattison |
| Keywords | stylelint, scss, sass, lint |

## Links

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

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

- 4.0.0 (latest) — 2024-02-28
- 3.0.2 — 2021-05-12
- 3.0.1 — 2021-01-20
- 3.0.0 — 2020-02-13
- 2.0.9 — 2020-01-17
- 2.0.8 — 2019-04-08
- 2.0.7 — 2018-07-27
- 2.0.6 — 2018-07-27
- 2.0.5 — 2018-07-26
- 2.0.4 — 2018-07-26
- 2.0.3 — 2018-07-26
- 2.0.2 — 2018-07-26
- 2.0.1 — 2018-07-26

## README

# neworbit-stylelint-config

NewOrbit standard config for stylelint

## Usage
### Installation

`npm install neworbit-stylelint-config --save-dev`

### Setup

 - Install peer dependencies
 `npm install stylelint stylelint-config-standard-scss @stylistic/stylelint-config stylelint-scss stylelint-order stylelint-no-unsupported-browser-features --save-dev`
 - Add `.stylelintrc.json` file with the following contents:

 ```json
{
    "extends": "neworbit-stylelint-config"
}
 ```

 - Add an npm script to run linter

 ```json
     "lint:sass": "stylelint \"**/*.scss\""
 ```

### Integrate with webpack

You may want to integrate with webpack so that you get linting warnings on build.  You may also want to consider failing on production build so linting errors block a pull request.

`npm install stylelint-webpack-plugin --save-dev`

```js
const StyleLintPlugin = require('stylelint-webpack-plugin');

const config = { /* webpack config */ };

let styleLintOptions = {
    files: "**/*.scss"
};

if (process.env.NODE_ENV === "production") {
    styleLintOptions.failOnError = true;
}

config.plugins.push(new StyleLintPlugin(styleLintOptions));

```

## Visual Studio Code
To make life better in Visual Studio Code when using stylelint install:
[VSCode Stylelint Plugin](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)

## License

Made with :sparkling_heart: by [NewOrbit](https://www.neworbit.co.uk/) in Oxfordshire, and licensed under the [MIT License](LICENSE)

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