https://github.com/morevm/stylelint-config

Strict shareable Stylelint configuration
https://github.com/morevm/stylelint-config

Last synced: over 1 year ago
JSON representation

Strict shareable Stylelint configuration

• Host: GitHub
• URL: https://github.com/morevm/stylelint-config
• Owner: MorevM
• License: mit
• Created: 2022-02-05T10:25:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-09T17:05:02.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T20:21:19.279Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 1.85 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
![Promo image of @morev/stylelint-config package](./.github/images/banner.svg)

![Stability of "master" branch](https://img.shields.io/github/actions/workflow/status/MorevM/stylelint-config/build.yaml?branch=master)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Last commit](https://img.shields.io/github/last-commit/morevm/stylelint-config)

![Release version](https://img.shields.io/github/v/release/morevm/stylelint-config?include_prereleases)

![GitHub Release Date](https://img.shields.io/github/release-date/morevm/stylelint-config)

![Keywords](https://img.shields.io/github/package-json/keywords/morevm/stylelint-config)

# @morev/stylelint-config

Strict shareable Stylelint configuration with reasonable defaults.

✔️ 200+ configured rules of Stylelint and its plugins; \

✔️ 70+ extra rules for SCSS; \

✔️ Consistent order of properties and rules according to BEM methodology.

---

## Installation

### Using `yarn`

```bash

yarn add stylelint @morev/stylelint-config --dev

```

### Using `npm`

```bash

npm install -D stylelint @morev/stylelint-config

```

### Using `pnpm`

```bash

pnpm add -d stylelint @morev/stylelint-config

```

## Usage

Create a [Stylelint configuration file](https://stylelint.io/user-guide/configure/)

(`.stylelintrc.js` for the following instruction) in the package root with the following content:

> Note: the following instruction assumes that the package is written in ESM.

>

> For projects written in CommonJS (that doesn't have `"type": "module"` within its `package.json`)

> you need to specify `.cjs` extension for configuration file and use `module.exports` instead of `export default`.

>

> Alternatively you can use a configuration file defined in YAML or JSON format, but it's less extensible.

### SCSS repository (default)

```js

/** @type {import('stylelint').Config} */

export default {

  extends: [

    '@morev/stylelint-config',

  ],

  rules: {},

}

```

### CSS repository

```js

/** @type {import('stylelint').Config} */

export default {

  extends: [

    '@morev/stylelint-config/css',

  ],

  rules: {},

}

```

### Mixed (for some reason O_o) repository

```js

/** @type {import('stylelint').Config} */

export default {

  overrides: [

    { files: ['*.css'], extends: ['@morev/stylelint-config/css'] }

    { files: ['*.scss'], extends: ['@morev/stylelint-config/scss'] }

  ]

}

```