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

⚙️ A reusable stylelint configuration.
https://github.com/gcoguiec/stylelint-config

stylelint stylelint-config

Last synced: about 1 month ago
JSON representation

⚙️ A reusable stylelint configuration.

• Host: GitHub
• URL: https://github.com/gcoguiec/stylelint-config
• Owner: gcoguiec
• License: bsd-2-clause
• Created: 2023-01-23T18:32:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-06T14:53:59.000Z (4 months ago)
• Last Synced: 2024-11-30T22:33:11.154Z (about 1 month ago)
• Topics: stylelint, stylelint-config
• Language: JavaScript
• Homepage: https://github.com/gcoguiec/stylelint-config
• Size: 416 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
@gcoguiec/stylelint-config






  

    

  

  

    

  

  

    

  





## Table of Contents

- [Getting Started](#getting-started)

- [License](#license)

## Getting Started

### Install

```bash

pnpm add -D stylelint stylelint-order stylelint-scss @gcoguiec/stylelint-config

```

### Configure

Add a `stylelint.config.cjs` file at the project root with the following configuration:

```js

// stylelint.config.cjs

module.exports = {

  root: true,

  extends: ['@gcoguiec/stylelint-config']

};

```

### (Optional) Add scripts to your `package.json` file

```json

{

  "scripts": {

    "lint:scss": "stylelint \"**/*.scss\"",

    "lint:scss:fix": "pnpm lint:scss --fix"

  }

}

```

**Note:** you can replace `pnpm` by your favorite package manager instead.

### (Optional) Add the tasks to your `justfile`

```just

lint-scss *args:

  pnpm stylelint "**/*.scss" {{args}}

lint-scss-fix:

  @just lint-scss --fix

```

## License

This project is licensed under [BSD 2-Clause](https://spdx.org/licenses/BSD-2-Clause.html).