# lfeslint

> Livefyre ES Linter

Latest version **1.3.3** (published 2018-03-15) · ISC license · 0 weekly downloads

## Install

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

Provides the command `lfeslint`.

## 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.3 |
| Published | 2018-03-15 |
| First published | 2017-05-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| Author | Livefyre |
| Maintainers | livefyre |

## Links

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

## Dependencies (7)

- [mout](https://npm.io/package/mout.md) 0.11.1
- [eslint](https://npm.io/package/eslint.md) ^4.0.0
- [minimist](https://npm.io/package/minimist.md) 1.2.0
- [multiline](https://npm.io/package/multiline.md) 1.0.2
- [pkg-config](https://npm.io/package/pkg-config.md) 1.1.0
- [babel-eslint](https://npm.io/package/babel-eslint.md) 8.2.1
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.5.1

## Recent versions

- 1.3.3 (latest) — 2018-03-15
- 1.3.2 — 2018-01-05
- 1.3.1 — 2017-08-22
- 1.2.1 — 2017-08-22
- 1.3.0 — 2017-08-18
- 1.2.0 — 2017-07-20
- 1.1.0 — 2017-06-27
- 1.0.2 — 2017-06-19
- 1.0.1 — 2017-05-24

## README

# LFESLINT

## Overview
Linter for Livefyre Javascript projects

## Install
Drop it into your ``package.json``

or install via ``npm install git+ssh://git@github.com/Livefyre/lfeslint.git``

## Usage
Running ``lfeslint`` will run the linter recurisvely in the current directory. It will skip certain directories by default.

To run on a certain path
```bash
lfeslint ./src
```

### Command line options
```bash
-e  --env       Environment prefixes: browser, mocha, node, commonjs, es6 (defaults to all)
-F  --fix       Automatically fix some issues
-f  --formatter Output results as different format types
-g  --global    Declare global variable
-v  --version   Show current version
-h, --help      Show usage information
-i, --ignore    Ignore certain paths
```

### Ignoring Files
Certain paths - including `node_modules/**` and `*.min.js` - are ignored by default.

To add more directories to ignore, place the following in your package.json

```json
"lfeslint": {
  "ignore": [
    "**/out/**",
    "**/lib/select2/**",
    "**/lib/ckeditor/**"
  ]
}
```

### Hiding Warnings
This project uses [`ESlint`](http://eslint.org/). All of the ESlint directives will work - for example: `/*eslint-disable*/`

### Defining Globals in a project's package.json
Certain projects will need globals present to operate correctly.

```json
{
  "lfeslint": {
    "global": ["var1", "Q"]
  }
}
```

### Configuring environments
A complete list of available environments can be found in the [`Specifying Environments`](http://eslint.org/docs/user-guide/configuring#specifying-environments) section of the ESLint docs.

```json
{
  "lfeslint": {
    "env": ["mocha", "es6"]
  }
}
```

### Choosing a formatter
A complete list of available formatters can be found in the [`ESLint Formatters`](http://eslint.org/docs/user-guide/formatters/) section of the ESLint docs

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