Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atomlinter/linter-eslint
ESLint plugin for Atom Linter
https://github.com/atomlinter/linter-eslint
atom eslint eslint-extension linter-eslint
Last synced: 3 months ago
JSON representation
ESLint plugin for Atom Linter
- Host: GitHub
- URL: https://github.com/atomlinter/linter-eslint
- Owner: AtomLinter
- Archived: true
- Created: 2014-06-26T14:19:58.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T18:34:35.000Z (over 1 year ago)
- Last Synced: 2024-09-27T11:41:44.629Z (3 months ago)
- Topics: atom, eslint, eslint-extension, linter-eslint
- Language: JavaScript
- Homepage: https://atom.io/packages/linter-eslint
- Size: 2.16 MB
- Stars: 585
- Watchers: 6
- Forks: 140
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# linter-eslint
[](https://github.com/AtomLinter/linter-eslint/actions/workflows/CI.yml)
[](https://david-dm.org/AtomLinter/linter-eslint)
This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides
an interface to [eslint](http://eslint.org) versions 7 and below. It will be used with files that
have the "JavaScript" syntax.
**For linting in projects that use ESLint v8 and above, install [linter-eslint-node](https://atom.io/packages/linter-eslint-node).**
## Installation
```ShellSession
apm install linter-eslint
```
`linter-eslint` will look for a version of `eslint` local to your project and
use it if it's available. If none is found it will fall back to the version it
ships with.
Let's say you depend on a specific version of `eslint`. Maybe it has unreleased
features or maybe it's newer than what `linter-eslint` ships with. If
`your-project/node_modules/eslint` exists `linter-eslint` will be used.
This package requires an `eslint` of at least v1.0.0.
If you do not have the `linter` package installed, it will be
installed
for you. If you are using an alternative `linter-*` consumer,
the `linter` package can be disabled.
If you wish to lint files in JavaScript-derivative languages (like Typescript,
Flow) with ESLint, you must add the scope name for that grammar to the
`List of scopes to run ESLint on` option in `linter-eslint` Settings. For
example, to lint TypeScript files, add `source.ts` to the list.
## Use with plugins
You have two options:
* Install locally to your project `eslint` and the plugin
* `$ npm i --save-dev eslint [eslint-plugins]`
* Install globally `eslint` and plugins
* `$ npm i -g eslint [eslint-plugins]`
* Activate `Use Global Eslint` package option
* (Optional) Set `Global Node Path` with `$ npm config get prefix`
## Using ESLint
Note that recent versions of ESLint do not use any rules by default. This
means you have to specify a configuration file for your project!
To do this in a straightforward way run this:
```ShellSession
eslint --init
```
Alternatively you can create the `.eslintrc` file by yourself. It is a good
idea to have a look at the [ESLint documentation](http://eslint.org/docs/user-guide/configuring),
including the [list of rules](http://eslint.org/docs/rules/).
## A Note About Settings
If Use Global is on, Atom will use the global ESLint. The path to it is figured out by running `npm get prefix`. If this fails for any reason, you can set the global path manually in Global Node Installation Path.
If Use Global is off, Atom will try to find a local installation in the project folder, look if there's ESLint in `${PROJECT_ROOT}/node_modules` and use it if found.
The path to the local node_modules folder can be a path relative to the project or an absolute path and should end in `/node_modules/`. This path is used if the other methods of discovery have failed.
If there is no local installation Atom will use the built-in ESLint in the linter-eslint package itself.
## Contributing
See the [contributing guidelines](./CONTRIBUTING.md) to get started.