# stylint-stylish

> A stylish reporter for Stylint, heavily inspired by jshint-stylish

Latest version **2.0.2** (published 2024-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install stylint-stylish
pnpm add stylint-stylish
yarn add stylint-stylish
bun add stylint-stylish
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: no vulnerabilities; has provenance; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2024-02-13 |
| First published | 2015-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 10 |
| Author | Simen Bekkhus |
| Maintainers | simenb |
| Keywords | lint, reporter, stylint, stylint-reporter, stylish, stylus |

## Links

- npm: https://www.npmjs.com/package/stylint-stylish
- Repository: https://github.com/SimenB/stylint-stylish
- Homepage: https://github.com/SimenB/stylint-stylish#readme
- Issues: https://github.com/SimenB/stylint-stylish/issues
- npm.io page: https://npm.io/package/stylint-stylish

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^2.0.1
- [text-table](https://npm.io/package/text-table.md) ^0.2.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^2.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2024-02-13
- 2.0.0 — 2018-09-17
- 1.4.1 — 2018-01-20
- 1.4.0 — 2016-09-30
- 1.3.3 — 2016-09-27
- 1.3.2 — 2016-06-21
- 1.3.1 — 2016-06-21
- 1.3.0 — 2016-06-21
- 1.2.2 — 2016-04-11
- 1.2.1 — 2016-03-27
- 1.2.0 — 2015-08-05
- 1.1.2 — 2015-08-04
- 1.1.1 — 2015-07-21
- 1.1.0 — 2015-07-19
- 1.0.2 — 2015-07-19
- … 2 more at https://npm.io/package/stylint-stylish/versions

## README

# stylint-stylish
> Stylish formatter for Stylint

[![NPM Version][npm-image]][npm-url]
[![Build Status][gh-actions-image]][gh-actions-url]
[![Coverage Status][coveralls-image]][coveralls-url]

## Screenshots
![This reporter][new-image]

vs original:

![Original reporter][orig-image]

## Usage

To use it, just set `reporter` to `stylint-stylish` in the config (`.stylintrc`) or when calling stylint programatically.

```json
{
  "reporter": "stylint-stylish",
  "noImportant": true,
  "semicolons": {
    "expect": "always",
    "error": true
  }
}
```

## Options
To use options, add a `reporterOptions`-object to the config

```json
{
  "reporter": "stylint-stylish",
  "reporterOptions": {
    "absolutePath": true
  },
  "noImportant": true,
  "semicolons": {
    "expect": "always",
    "error": true
  }
}
```

#### `verbose`
Type: `boolean`, default: `false`

When printing out a violation, print the full line with the violation as well.

#### `absolutePath`
Type: `boolean`, default: `false`

When printing out a filename, print the absolute path instead of a relative one

#### `ruleName`
Type: `boolean`, default: `false`

When printing out a violation, Include the name of the rule at the end


[gh-actions-url]: https://github.com/SimenB/stylint-stylish/actions
[gh-actions-image]: https://github.com/SimenB/stylint-stylish/actions/workflows/nodejs.yml/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/SimenB/stylint-stylish
[coveralls-image]: https://img.shields.io/coveralls/SimenB/stylint-stylish.svg
[npm-url]: https://npmjs.org/package/stylint-stylish
[npm-image]: https://img.shields.io/npm/v/stylint-stylish.svg
[new-image]: screenshots/this.png
[orig-image]: screenshots/original.png

---
_Source: https://npm.io/package/stylint-stylish · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._