@contactlab/stylelint-config-uxd

Stylelint configuration used in Contactlab projects.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@contactlab/stylelint-config-uxd
1.1.86 years ago6 years agoMinified + gzip package size for @contactlab/stylelint-config-uxd in KB

Readme

Contactlab UXD Stylelint
NPM version Conventional Commits
Stylelint configuration used in Contactlab projects.
The purpose of this library is to promote code style consistency across complex projects in organizations of all sizes.
- Installation - Usage - Tests - Similar projects - Rules - Contributing - Code of Conduct

Installation

We recommend to use Yarn over npm (is fine anyway) and this stylelint config package:
$ yarn add --dev @contactlab/stylelint-config-uxd

Usage

Create a .stylelintrc file with the following basic configuration:
{
  "extends": "@contactlab/stylelint-config-uxd"
}

Otherwise, add the stylelint key to your package.json:
{
  "stylelint": {
    "extends": "@contactlab/stylelint-config-uxd"
  }
}

For more details about how shareable configs work, see the Stylelint documentation.

Tests

$ yarn install && yarn test

Similar projects

A configuration for linting JavaScript (ES5 & ES6) with eslint is available at eslint-config-contactlab.

Rules

The configuration extends the default stylelint-config-standard rules. A more comprehensive list of examples is available in the examples folder.
Package specific rules can be found in ./lib folder.