https://github.com/eslint/eslint-cli

The local eslint executor.
https://github.com/eslint/eslint-cli

cli cli-command eslint npm npm-module npm-package

Last synced: 3 months ago
JSON representation

The local eslint executor.

• Host: GitHub
• URL: https://github.com/eslint/eslint-cli
• Owner: eslint
• License: mit
• Archived: true
• Created: 2015-09-20T18:59:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-11-22T02:49:30.000Z (about 3 years ago)
• Last Synced: 2024-04-14T07:42:14.247Z (8 months ago)
• Topics: cli, cli-command, eslint, npm, npm-module, npm-package
• Language: JavaScript
• Size: 42 KB
• Stars: 57
• Watchers: 15
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
:warning: This package is no longer necessary. Use the built-in [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) command instead.

```sh

npm install --save-dev eslint

npx eslint src

```

---

# eslint-cli

[![npm version](https://img.shields.io/npm/v/eslint-cli.svg)](https://www.npmjs.com/package/eslint-cli)

[![Downloads/month](https://img.shields.io/npm/dm/eslint-cli.svg)](http://www.npmtrends.com/eslint-cli)

[![Dependency Status](https://david-dm.org/eslint/eslint-cli.svg)](https://david-dm.org/eslint/eslint-cli)

The local [ESLint] executor.

## ⤴️ Motivation

ESLint recommends that we install ESLint into project-local rather than global.

    $ npm install --save-dev eslint

In that case, there are many merits, but `eslint` CLI command is not available.

    # This is error:

    $ eslint src

    # So you have to use:

    $ ./node_modules/.bin/eslint src

It's inconvenient a bit. This package gives you `eslint` CLI command which runs local installed ESLint.

## 💿 Installation

Use [npm] to install.

    $ npm install -g eslint-cli

**Note:**

- The `eslint` package must not be installed into global.

- This package must be installed into global.

## 📖 Usage

First, install the `eslint` package into project-local.

    $ npm install --save-dev eslint

Next, use `eslint` CLI command.

    $ eslint src

The command runs the global-installed `eslint-cli`, then it finds and runs the local-installed `eslint`.

That's all. Enjoy!

## 📰 Change logs

- See [GitHub releases](https://github.com/eslint/eslint-cli/releases)

## 🍻 Contributing

Contributing is welcome!

Please use issues/PRs of GitHub.

[eslint]: http://eslint.org/

[npm]: https://www.npmjs.com/