@cerner/stylelint-config-terra

Terra Stylelint Shared Config

Usage no npm install needed!

<script type="module">
  import cernerStylelintConfigTerra from 'https://cdn.skypack.dev/@cerner/stylelint-config-terra';
</script>

README

Stylelint Config Terra

NPM version Build Status

This configuration reflects Terra's supported stylelint policy for their UI library stylesheets. It extends the stylelint-config-sass-guidelines configuration which is based on sass-guidelines. Additionally, this configuration utilizes the stylelint-no-unsupported-browser-features plugin to check if the styles used are supported by the local browserslist being targeted.

What is Stylelint?

Stylelint is a mighty, modern CSS linter and fixer that helps you avoid errors and enforce consistent conventions in your stylesheets.

Installation

Install the module

$ npm install stylelint --save-dev
$ npm install @cerner/stylelint-config-terra --save-dev

Usage

package.json

{
  "stylelint": {
    "extends": "@cerner/stylelint-config-terra"
  }
}

Extending Terra's Configuration

It is possible to specify and override the rules defined by stylelint-config-terra. Read more about it here.

For example, it is possible to override the browsers specified to the no-unsupported-browser-features plugin.

{
  "stylelint": {
    "extends @cerner/stylelint-config-terra",
    "rules": {
      "plugin/no-unsupported-browser-features": [
        true,
        "browsers": ["iOS >= 10"],
        "severity": "warning",
      ]
    }
  }
}

Custom Lint Rules

The following custom rules are enabled by default.

Contributing

Please read through our contributing guidelines. Included are directions for issue reporting and pull requests.

LICENSE

Copyright 2018 - 2020 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.