https://github.com/tclindner/stylelint-config-tc

Stylelint shareable config
https://github.com/tclindner/stylelint-config-tc

code code-style css lint linter quality style stylelint stylelint-config

Last synced: 3 months ago
JSON representation

Stylelint shareable config

• Host: GitHub
• URL: https://github.com/tclindner/stylelint-config-tc
• Owner: tclindner
• License: mit
• Created: 2018-06-02T15:32:57.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T02:00:30.000Z (4 months ago)
• Last Synced: 2024-09-10T03:35:08.699Z (4 months ago)
• Topics: code, code-style, css, lint, linter, quality, style, stylelint, stylelint-config
• Language: JavaScript
• Homepage:
• Size: 2.47 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-config-tc

> Stylelint [shareable config](http://stylelint.io/user-guide/configuration/#extends)

[![license](https://img.shields.io/github/license/tclindner/stylelint-config-tc.svg?maxAge=2592000&style=flat-square)](https://github.com/tclindner/stylelint-config-tc/blob/master/LICENSE)

[![npm](https://img.shields.io/npm/v/stylelint-config-tc.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/stylelint-config-tc)

![ci](https://github.com/tclindner/stylelint-config-tc/workflows/ci/badge.svg?branch=master)

## What is stylelint-config-tc?

Shared configuration for Stylelint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file!

# How do I install it?

First thing first, let's make sure you have the necessary pre-requisites.

### System Dependencies

#### Node

* [Node.js](https://nodejs.org/) - v18.0.0+

* [npm](http://npmjs.com) - v9.0.0+

### Command

```bash

npx install-peerdeps --dev stylelint-config-tc

```

> stylelint, stylelint-prettier, and prettier are peer dependencies and must be installed.

## Usage

Add the following to your `.stylelintrc.json` file:

```json

{

	"extends": "stylelint-config-tc"

}

```

If you need to override a rule, your `.stylelintrc.json` file should look like the example below. All shared rules will be used, but `declaration-block-trailing-semicolon` will be turned off.

```json

{

	"extends": "stylelint-config-tc",

	"rules": {

		"declaration-block-trailing-semicolon": null

	}

}

```

## Contributing

Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

## Change Log

Please see the [CHANGELOG.md](CHANGELOG.md) for more information.

## License

Copyright (c) 2018-2023 Thomas Lindner. Licensed under the MIT license.