# linteverything

> lint everything

Latest version **0.9.5** (published 2018-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install linteverything
pnpm add linteverything
yarn add linteverything
bun add linteverything
```

Provides the command `linteverything`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.5 |
| Published | 2018-05-31 |
| First published | 2018-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 10.1 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Loïc Bourgois |
| Maintainers | loicbourgois |
| Keywords | lint, linter |

## Links

- npm: https://www.npmjs.com/package/linteverything
- Repository: https://github.com/loicbourgois/linteverything
- Homepage: https://github.com/loicbourgois/linteverything#readme
- Issues: https://github.com/loicbourgois/linteverything/issues
- npm.io page: https://npm.io/package/linteverything

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.3.1
- [eslint](https://npm.io/package/eslint.md) ^4.18.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.19
- [htmllint](https://npm.io/package/htmllint.md) ^0.7.2
- [stylelint](https://npm.io/package/stylelint.md) ^9.1.1
- [stylelint-config-standard](https://npm.io/package/stylelint-config-standard.md) ^18.1.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

- 0.9.5 (latest) — 2018-05-31
- 0.9.4 — 2018-03-09
- 0.9.3 — 2018-03-09
- 0.9.2 — 2018-03-01
- 0.9.1 — 2018-03-01
- 0.9.0 — 2018-03-01
- 0.8.0 — 2018-02-28
- 0.7.2 — 2018-02-28
- 0.7.1 — 2018-02-28
- 0.7.0 — 2018-02-28
- 0.6.2 — 2018-02-27
- 0.6.1 — 2018-02-27
- 0.6.0 — 2018-02-27
- 0.5.1 — 2018-02-26
- 0.5.0 — 2018-02-26
- … 8 more at https://npm.io/package/linteverything/versions

## README

# Lint Everything ! [![Build Status](https://travis-ci.org/loicbourgois/linteverything.svg?branch=master)](https://travis-ci.org/loicbourgois/linteverything)
> One Linter to parse them all and in the darkness lint them.

## Usage

### In a npm script
First install the package with:
```bash
$ npm install linteverything
```
Then add a script to `package.json` :
```js
{
	...
	"scripts": {
		"linteverything": "linteverything"
	},
	...
}
```
Finally run the script:
```bash
$ npm run linteverything
```

### In a Travis CI script
Just add the following to `.travis.yml` :
```
script:
  - npm install linteverything
  - printf "module.exports={ignore:['node_modules','package-lock.json','.git','.travis.yml'],verbose:true};" > .linteverythingrc.js
  - node ./node_modules/linteverything/bin/linteverything.js
```

### In Node.js
First install the package with :
```bash
$ npm install linteverything --save-dev
```
Then add the following to your code :
```js
const linteverything = require('linteverything');
const options = {
	verbose:true
};
linteverything(options).then(function(result) {
	console.log(result);
});
```

[Try it on your browser !](https://npm.runkit.com/linteverything)

## Options
Options are defined as javascript objects.

They can be set in 3 places:
- in the argument passed to `linteverything(options)` ;
- in `.linteverythingrc.js` ;
- in [`default-settings.js`](default-settings.js?ts=2).

### failOnError
Default : `true`.

Boolean controlling how to exit.

If set to `true`, `linteverything` will exit with code `1`.

### ignore
Default : `[]`.

An array of files and folders to ignore. They will be ignored by every linters.

### ignoreExtensions
Default : `['jar', 'pdf']`.

An array of extensions to ignore. They will be ignored by every linters.

### logLevel
Default : `'error'`.

Values :
- `'all'` : report everything ;
- `'error'` : report errors only ;
- `'warning'` : report errors and warnings.

### linters
Default : all linters are enabled.

Supported linters:
- [checkstyle](https://github.com/checkstyle/checkstyle) ;
- [eslint](https://github.com/eslint/eslint) ;
- [htmllint](https://github.com/htmllint/htmllint) ;
- [stylelint](https://github.com/stylelint/stylelint).

### verbose
Default : `false`.

Boolean to enable or disable verbose logs.

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