# @btrl/stylelint-config

> Coding standards for styles

Latest version **1.0.3** (published 2023-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @btrl/stylelint-config
pnpm add @btrl/stylelint-config
yarn add @btrl/stylelint-config
bun add @btrl/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 | 1.0.3 |
| Published | 2023-12-19 |
| First published | 2023-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | KC |
| Maintainers | btrl |
| Keywords | stylelint, stylelint-config, vue-scss, sass |

## Links

- npm: https://www.npmjs.com/package/@btrl/stylelint-config
- Repository: https://github.com/orangelckc/stylelint-config
- Issues: https://github.com/orangelckc/stylelint-config/issues
- npm.io page: https://npm.io/package/@btrl/stylelint-config

## Dependencies (6)

- [local-pkg](https://npm.io/package/local-pkg.md) ^0.4.3
- [postcss-html](https://npm.io/package/postcss-html.md) ^1.5.0
- [postcss-scss](https://npm.io/package/postcss-scss.md) ^4.0.6
- [stylelint-config-clean-order](https://npm.io/package/stylelint-config-clean-order.md) ^5.0.1
- [stylelint-config-recommended-vue](https://npm.io/package/stylelint-config-recommended-vue.md) ^1.4.0
- [stylelint-config-recommended-scss](https://npm.io/package/stylelint-config-recommended-scss.md) ^10.0.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

- 1.0.3 (latest) — 2023-12-19
- 1.0.2 — 2023-12-19
- 1.0.1 — 2023-04-21
- 1.0.0 — 2023-04-20

## README

# @btrl/stylelint-config

Coding standards for all things style-related, specifically CSS & SCSS with vue3.

[![npm](https://img.shields.io/npm/v/@btrl/stylelint-config)](https://npm.im/@btrl/stylelint-config)

## Installation

```bash
# Install the config as a dev dependency.
pnpm add -D @btrl/stylelint-config
```

### Peer dependencies

You need to additionally install [stylelint](https://www.npmjs.com/package/stylelint) into your project.

```bash
# Install manually
pnpm add -D stylelint
```

## Usage

Depends on your [default module system configuration](https://nodejs.org/api/packages.html#determining-module-system) for Node.js, create a `stylelint.config.cjs` file using `CommonJS` OR create a `stylelint.config.mjs` file using `ES module` with the following contents:

```js
// stylelint.config.cjs
module.exports = {
  extends: '@btrl/stylelint-config',
}
```

```js
// stylelint.config.mjs
export default {
  extends: '@btrl/stylelint-config',
}
```

## Config VS Code lint & auto fix

- Install the [VS Code Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) extension.
- Add the following to your workspace settings in `.vscode/settings.json`:

```json
{
  "prettier.enable": false,
  "editor.formatOnSave": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.stylelint": true
  },
  "stylelint.validate": [
    "css",
    "scss",
    "vue"
  ]
}
```

## Script for linting style in package.json

For example:

```json
{
  "scripts": {
    "lint:style": "stylelint src/**/*.{vue,css,scss} --fix"
  }
}
```

## Extended configs

We've adopted the following list of shared configs that remain actively maintained by the broader developer community.

- [stylelint-config-recommended-vue](https://github.com/ota-meshi/stylelint-config-recommended-vue) - The recommended shareable Vue config for Stylelint.
- [stylelint-config-recommended-scss](https://github.com/stylelint-scss/stylelint-config-recommended-scss) - The recommended shareable SCSS config for stylelint.
- [stylelint-config-clean-order](https://github.com/kutsan/stylelint-config-clean-order) - A stylelint order config inspired by [stylelint-order](https://github.com/hudochenkov/stylelint-order).

## Recommended ESLint configuration

This project is heavily inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config), which is an excellent project for eslint. The main goal of this project is to enhance the linting experience while developing `Vue` projects.

## License

[MIT](./LICENSE) License © 2023

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