Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Clarify Linter vs ESLint in node.js api docs (fixes #14953) #14995

Merged
merged 4 commits into from Aug 31, 2021
Merged

Docs: Clarify Linter vs ESLint in node.js api docs (fixes #14953) #14995

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2c0962
Improve clarity on the usage of the Linter class
Aug 30, 2021
1a09312
Fix MD issue
Aug 30, 2021
9610b39
Add line break for readability
Aug 30, 2021
53e0420
Update docs/developer-guide/nodejs-api.md
nzakas Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/developer-guide/nodejs-api.md
View file
Open in desktop
Expand Up @@ -458,7 +458,8 @@ const codeLines = SourceCode.splitLines(code);

## Linter

The `Linter` object does the actual evaluation of the JavaScript code. It doesn't do any filesystem operations, it simply parses and reports on the code. In particular, the `Linter` object does not process configuration objects or files.
The `Linter` object does the actual evaluation of the JavaScript code. It doesn't do any filesystem operations, it simply parses and reports on the code. In particular, the `Linter` object does not process configuration objects or files. Unless you are working in the browser, you probably want to use the [ESLint class](#eslint-class) class instead.

The `Linter` is a constructor, and you can create a new instance by passing in the options you want to use. The available options are:

* `cwd` - Path to a directory that should be considered as the current working directory. It is accessible to rules by calling `context.getCwd()` (see [The Context Object](./working-with-rules.md#the-context-object)). If `cwd` is `undefined`, it will be normalized to `process.cwd()` if the global `process` object is defined (for example, in the Node.js runtime) , or `undefined` otherwise.
Expand Down