# @terminus/stylelint-config-frontend

> stylelint-config-frontend

Latest version **1.3.2** (published 2021-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @terminus/stylelint-config-frontend
pnpm add @terminus/stylelint-config-frontend
yarn add @terminus/stylelint-config-frontend
bun add @terminus/stylelint-config-frontend
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2021-01-20 |
| First published | 2019-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | @terminus |
| Maintainers | benjamincharity, bmalinconico-terminus, atlwendy, terminus_devops |

## Links

- npm: https://www.npmjs.com/package/@terminus/stylelint-config-frontend
- Repository: https://github.com/GetTerminus/terminus-oss
- Issues: https://github.com/GetTerminus/terminus-oss/issues
- npm.io page: https://npm.io/package/@terminus/stylelint-config-frontend

## Recent versions

- 1.3.2 (latest) — 2021-01-20
- 1.3.1 — 2020-12-16
- 1.3.0 — 2020-09-08
- 1.2.7 — 2020-08-14
- 1.2.6 — 2020-08-05
- 1.2.5 — 2020-07-28
- 1.2.4 — 2020-07-13
- 1.2.3 — 2020-07-08
- 1.1.6 — 2020-04-14
- 1.1.5 — 2020-02-06
- 1.1.4 — 2020-01-16
- 1.1.3 — 2019-12-17
- 1.1.2 — 2019-10-31
- 1.1.1 — 2019-10-16
- 1.1.0 — 2019-08-05
- … 3 more at https://npm.io/package/@terminus/stylelint-config-frontend/versions

## README

<h1>stylelint-config-frontend</h1>

[![CI/CD Status][github-action-badge]][github-action-link] [![MIT License][license-image]][license-url]  
[![NPM version][npm-version-image]][npm-package] [![Library size][file-size-badge]][raw-distribution-js]

A collection of SCSS lint rules for Terminus frontend codebases.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents

- [Installation](#installation)
- [Set up](#set-up)
  - [1. Create the file and extend the base ruleset](#1-create-the-file-and-extend-the-base-ruleset)
  - [2. Add a linting command to `package.json`](#2-add-a-linting-command-to-packagejson)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

```bash
yarn add stylelint @terminus/stylelint-config-frontend -D
```

## Set up

### 1. Create the file and extend the base ruleset

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

```javascript
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.

```json
{
  "name": "My Project",
  "scripts": {
    "lint:scss": "npx stylelint 'your/path/to/styles/**/*.scss'"
  }
}
```

<!-- Links -->
[license-url]:         https://github.com/GetTerminus/terminus-oss/blob/release/LICENSE
[license-image]:       http://img.shields.io/badge/license-MIT-blue.svg
[npm-version-image]:   http://img.shields.io/npm/v/@terminus/stylelint-config-frontend.svg
[npm-package]:         https://www.npmjs.com/package/@terminus/stylelint-config-frontend
[github-action-badge]: https://github.com/GetTerminus/terminus-oss/workflows/Release%20CI/badge.svg
[github-action-link]:  https://github.com/GetTerminus/terminus-oss/actions?query=workflow%3A%22CI+Release%22
[file-size-badge]:     http://img.badgesize.io/https://unpkg.com/@terminus/stylelint-config-frontend/src/lib/rules.js?compression=gzip
[raw-distribution-js]: https://unpkg.com/@terminus/stylelint-config-frontend@*/rules.js

---
_Source: https://npm.io/package/@terminus/stylelint-config-frontend · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
