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

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

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/untile/stylelint-config-untile
• Owner: untile
• License: mit
• Created: 2021-03-25T16:50:52.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-14T16:27:00.000Z (almost 2 years ago)
• Last Synced: 2024-12-19T21:35:57.042Z (28 days ago)
• Language: JavaScript
• Size: 750 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-config-untile

Untile-flavored stylelint config.

This configuration was created for react environment using [styled-components](https://www.styled-components.com/),

however it can be applied in other contexts.

## Installation

```sh

$ npm install stylelint @untile/stylelint-config-untile --save-dev

```

## Usage

Create an `.stylelintrc` file with the following:

```json

{

  "extends": ["@untile/stylelint-config-untile"]

}

```

Add the following `script` to your `package.json`:

```json

{

  "scripts": {

    "lint-styles": "stylelint './src/**/*.js'",

  }

}

```

and run the linter with:

```sh

$ npm run lint-styles

```

## Extending the config

Simply add a `"rules"` key to your config, then add your overrides and additions there.

```json

{

  "extends": "@untile/stylelint-config-untile",

  "rules": {

    "your-rules-here"

  }

}

```

## Releases

Be sure to have configured `NPM_TOKEN` in your globals.

```bash

npm version [ | major | minor | patch] -m "Release %s"

git push origin master && git push --tags

```