Skip to content

GetTerminus/stylelint-config-frontend

Repository files navigation

Terminus stylelint Frontend Configuration


🚨 ATTENTION: THIS REPO HAS MOVED 🚨

We have moved to separately published packages within a monorepo.

Please update any bookmarks to point to the new repo.

NOTE: This package will still be published to the existing NPM package.

🚨


CircleCI DavidDM DavidDM Dev
semantic-release MIT License
NPM version Github release

A collection of SCSS lint rules for Terminus frontend codebases.

Installation

$ yarn add stylelint @terminus/stylelint-config-frontend -D

Set up

1. Create the file and extend our ruleset

Create a stylelint config file at the root level named stylelint.config.js and extend our base ruleset:

module.exports = {
  extends: '@terminus/stylelint-config-frontend',
}

2. Add a linting command to package.json

  • The --project flag reference should point to the primary app tsconfig file.
  • The --config flag reference should point to the ci tslint file.
{
  "name": "My Project",
  "scripts": {
    "lint:scss": "npx stylelint 'your/path/to/styles/**/*.scss'"
  }
}