https://github.com/cargosense/stylelint-config-scss

Shareable Stylelint configuration for SCSS syntax Sass files.
https://github.com/cargosense/stylelint-config-scss

scss stylelint stylelint-config supporting-software

Last synced: about 1 month ago
JSON representation

Shareable Stylelint configuration for SCSS syntax Sass files.

• Host: GitHub
• URL: https://github.com/cargosense/stylelint-config-scss
• Owner: CargoSense
• License: mit
• Created: 2024-02-09T20:09:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-14T19:04:44.000Z (about 2 months ago)
• Last Synced: 2025-04-22T16:48:50.063Z (about 2 months ago)
• Topics: scss, stylelint, stylelint-config, supporting-software
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@cargosense/stylelint-config-scss
• Size: 117 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# stylelint-config-scss

**Shareable [Stylelint](https://stylelint.io) configuration for SCSS syntax [Sass](https://sass-lang.com) files.**

[![npm](https://img.shields.io/npm/v/@cargosense/stylelint-config-scss.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@cargosense/stylelint-config-scss)

[![Downloads](https://img.shields.io/npm/dt/@cargosense/stylelint-config-scss.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@cargosense/stylelint-config-scss)

[![Build](https://img.shields.io/github/actions/workflow/status/CargoSense/stylelint-config-scss/ci.yml?logo=github&style=for-the-badge)](https://github.com/CargoSense/stylelint-config-scss/actions/workflows/ci.yml)

## Installation

```sh

npm install --save-dev @cargosense/stylelint-config-scss

```

## Usage

Stylelint supports [a variety of configuration file formats](https://stylelint.io/user-guide/configure).

> [!TIP]

> We recommend using a configuration file named `stylelint.config.js` using either [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) or [CommonJS module](https://nodejs.org/api/modules.html) syntax.

### YAML

In a file named `.stylelintrc` or `.stylelintrc.yml`:

```yaml

---

extends: "@cargosense/stylelint-config-scss"

---

```

### JSON

In a file named `.stylelintrc` or `.stylelintrc.json`:

```json

{

  "extends": "@cargosense/stylelint-config-scss"

}

```

### JavaScript

In a JavaScript file using ESM syntax:

```js

// stylelint.config.mjs

export { default } from "@cargosense/stylelint-config-scss";

// or…

import config from "@cargosense/stylelint-config-scss";

export default {

  extends: [config]

};

```

In a JavaScript file using CommonJS module syntax:

```js

// stylelint.config.cjs

module.exports = {

  extends: ["@cargosense/stylelint-config-scss"]

}

```

## License

stylelint-config-scss is freely available under the [MIT License](https://opensource.org/licenses/MIT).