# run-eslint-async

> [![LICENSE: MIT](https://img.shields.io/npm/l/run-eslint-async?style=flat-square)](./LICENSE.md) [![npm: run-eslint-async](https://img.shields.io/npm/v/run-eslint-async?color=blue&style=flat-square)](https://www.npmjs.com/package/run-eslint-async)

Latest version **0.0.2** (published 2021-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install run-eslint-async
pnpm add run-eslint-async
yarn add run-eslint-async
bun add run-eslint-async
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-06-21 |
| First published | 2021-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | brodybits |

## Links

- npm: https://www.npmjs.com/package/run-eslint-async
- Repository: https://github.com/brodybits/run-eslint-async
- Homepage: https://github.com/brodybits/run-eslint-async#readme
- Issues: https://github.com/brodybits/run-eslint-async/issues
- npm.io page: https://npm.io/package/run-eslint-async

## Dependencies (1)

- [stylish](https://npm.io/package/stylish.md) ^1.0.0

## Recent versions

- 0.0.2 (latest) — 2021-06-21
- 0.0.1 — 2021-06-21

## README

# run-eslint-async

[![LICENSE: MIT](https://img.shields.io/npm/l/run-eslint-async?style=flat-square)](./LICENSE.md)
[![npm: run-eslint-async](https://img.shields.io/npm/v/run-eslint-async?color=blue&style=flat-square)](https://www.npmjs.com/package/run-eslint-async)

Run ESLint with a quick-and-easy API

## Requirements

- ESLint 7.x (peer dependency)

## demo

```js
const meow = require('meow')

const run = require('run-eslint-async')

const cli = meow(`
  Usage
  $ demo files
`)

const files = cli.input

if (files.length === 0) {
  console.error('ERROR: need some files')
  cli.showHelp()
}

console.log(`INFO: linting files: ${files}`)

const baseConfig = {
  extends: 'eslint:recommended',
  parserOptions: {
    ecmaVersion: 2020
  },
  rules: {
    quotes: [2, 'single'],
    semi: [2, 'never']
  }
}

run(files, baseConfig)
  .catch((e) => {
    console.error(e)
    process.exit(1)
  })
  .then(() => {
    console.log('lint ok')
  })
```

## see also

- <https://github.com/shinnn/run-eslint> - seems to be better tested, unfortunately works with outdated ESLint version

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