https://github.com/funbox/scss-lint-config

Config for Stylelint SCSS linting
https://github.com/funbox/scss-lint-config

scss stylelint stylelint-config

Last synced: about 1 year ago
JSON representation

Config for Stylelint SCSS linting

• Host: GitHub
• URL: https://github.com/funbox/scss-lint-config
• Owner: funbox
• License: mit
• Created: 2020-10-26T08:53:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-09T09:26:35.000Z (over 2 years ago)
• Last Synced: 2025-04-14T20:41:58.671Z (about 1 year ago)
• Topics: scss, stylelint, stylelint-config
• Language: JavaScript
• Homepage:
• Size: 238 KB
• Stars: 6
• Watchers: 10
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @funboxteam/scss-lint-config

[![npm](https://img.shields.io/npm/v/@funboxteam/scss-lint-config.svg)](https://www.npmjs.com/package/@funboxteam/scss-lint-config)

[Stylelint](https://stylelint.io) rules that follow our style guide for SCSS.

[По-русски](./README.ru.md)

## Installation

First, install Stylelint that meets 

the [peerDependencies requirements](./package.json):

```bash

npm install --save-dev stylelint

```

If using Stylelint v14 or higher, also install postcss-scss:

```bash

npm install --save-dev postcss-scss

```

Then install the config:

```bash

npm install --save-dev @funboxteam/scss-lint-config

```

## Usage

Include into a project config and pass desired [options](https://stylelint.io/user-guide/cli/):

```bash

stylelint "src/**/*.scss" --cache --config node_modules/@funboxteam/scss-lint-config/.stylelintrc

```

For Stylelint v13 `--syntax scss` option is required.

Also you can create your own config based on this one:

```js

module.exports = {

  extends: '@funboxteam/scss-lint-config/.stylelintrc.json',

  rules: [

    // your rule settings here

  ]

};

```

[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)