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

StyleLint Configuration
https://github.com/studiometa/stylelint-config

Last synced: about 1 year ago
JSON representation

StyleLint Configuration

• Host: GitHub
• URL: https://github.com/studiometa/stylelint-config
• Owner: studiometa
• Created: 2018-11-20T15:36:42.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-12-09T01:18:49.000Z (over 1 year ago)
• Last Synced: 2025-03-31T04:02:04.245Z (about 1 year ago)
• Language: JavaScript
• Size: 930 KB
• Stars: 2
• Watchers: 14
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# StyleLint Configuration

[![NPM Version](https://img.shields.io/npm/v/@studiometa/stylelint-config.svg?style=flat-square)](https://www.npmjs.com/package/@studiometa/stylelint-config)

[![Dependency Status](https://img.shields.io/david/studiometa/stylelint-config.svg?label=deps&style=flat-square)](https://david-dm.org/studiometa/stylelint-config)

[![devDependency Status](https://img.shields.io/david/dev/studiometa/stylelint-config.svg?label=devDeps&style=flat-square)](https://david-dm.org/studiometa/stylelint-config?type=dev)

> Studio Meta's one and only Stylelint configuration to be used across projects.

## Usage

Install the package with your favorite package manager:

```bash

yarn add --dev @studiometa/stylelint-config

# or

npm install --save-dev @studiometa/stylelint-config

```

Create a `.stylelintrc.js` in your project's root folder with the following:

```js

module.exports = {

  extends: '@studiometa/stylelint-config',

};

```

It is recommended to use [Prettier](https://prettier.io/) in your project for a more opinionated linting and formatting of your files. To do so, you can use the `prettier` configuration sent in this package. Add a `.prettierrc` file at the root of your project and set the StyleLint configuration as follow:

```js

module.exports = {

  extends: '@studiometa/stylelint-config/prettier',

};

```

## TODO

- Add tests (cf. [tests](https://github.com/stylelint/stylelint-config-recommended/blob/master/__tests__/index.test.js) from recommended configuration)