You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/extend/ways-to-extend.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ This page explains the ways to extend ESLint, and how these extensions all fit t
15
15
16
16
Plugins let you add your own ESLint custom rules and custom processors to a project. You can publish a plugin as an npm module.
17
17
18
-
Plugins are useful because your project may require some ESLint configuration that isn't included in the core `eslint` package. For example, if you're using a frontend JavaScript library like React or framework like Vue, these tools have some features that require custom rules outside the scope of the ESLint core rules.
18
+
Plugins are useful because your project may require some ESLint configuration that isn't included in the core `eslint` package. For example, if you're using a frontend JavaScript library like [React](https://react.dev/) or framework like [Vue](https://vuejs.org/), these tools have some features that require custom rules outside the scope of the ESLint core rules.
19
19
20
20
Often a plugin is paired with a configuration for ESLint that applies a set of features from the plugin to a project. You can include configurations in a plugin as well.
21
21
@@ -35,15 +35,15 @@ ESLint shareable configs are pre-defined configurations for ESLint that you can
35
35
36
36
You can either publish a shareable config independently or as part of a plugin.
37
37
38
-
For example, a popular shareable config is [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb), which contains a variety of rules in addition to some [parser options](../use/configure/language-options#specifying-parser-options). This is a set of rules for ESLint that is designed to match the style guide used by the [Airbnb JavaScript style guide](https://github.com/airbnb/javascript). By using the `eslint-config-airbnb` shareable config, you can automatically enforce the Airbnb style guide in your project without having to manually configure each rule.
38
+
For example, a popular shareable config is [`eslint-config-airbnb`](https://www.npmjs.com/package/eslint-config-airbnb), which contains a variety of rules in addition to some [parser options](../use/configure/language-options#specifying-parser-options). This is a set of rules for ESLint that is designed to match the style guide used by the [Airbnb JavaScript style guide](https://github.com/airbnb/javascript). By using the `eslint-config-airbnb` shareable config, you can automatically enforce the Airbnb style guide in your project without having to manually configure each rule.
39
39
40
-
To learn more about creating a shareable config, refer to [Share Configuration](shareable-configs).
40
+
To learn more about creating a shareable config, refer to [Share Configurations](shareable-configs).
41
41
42
42
## Custom Formatters
43
43
44
44
Custom formatters take ESLint linting results and output the results in a format that you define. Custom formatters let you display linting results in a format that best fits your needs, whether that's in a specific file format, a certain display style, or a format optimized for a particular tool. You only need to create a custom formatter if the [built-in formatters](../use/formatters/) don't serve your use case.
45
45
46
-
For example, the custom formatter [eslint-formatter-gitlab](https://www.npmjs.com/package/eslint-formatter-gitlab) can be used to display ESLint results in GitLab code quality reports.
46
+
For example, the custom formatter [eslint-formatter-gitlab](https://www.npmjs.com/package/eslint-formatter-gitlab) can be used to display ESLint results in [GitLab](https://about.gitlab.com/) code quality reports.
47
47
48
48
To learn more about creating a custom formatter, refer to [Custom Formatters](custom-formatters).
Copy file name to clipboardExpand all lines: docs/src/integrate/nodejs-api.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ While ESLint is designed to be run on the command line, it's possible to use ESL
15
15
16
16
The `ESLint` class is the primary class to use in Node.js applications.
17
17
18
-
This class depends on the Node.js `fs` module and the file system, so you cannot use it in browsers. If you want to lint code on browsers, use the [Linter](#linter) class instead.
18
+
This class depends on the Node.js [`fs`](https://nodejs.org/api/fs.html) module and the file system, so you cannot use it in browsers. If you want to lint code on browsers, use the [`Linter`](#linter) class instead.
19
19
20
20
Here's a simple example of using the `ESLint` class:
ESLint comes with several built-in formatters to control the appearance of the linting results, and supports third-party formatters as well.
12
12
13
-
You can specify a formatter using the `--format` or `-f` flag in the CLI. For example, `--format json` uses the `json` formatter.
13
+
You can specify a formatter using the [`--format`](../command-line-interface#-f---format) or [`-f`](../command-line-interface#-f---format) flag in the CLI. For example, `--format json` uses the `json` formatter.
14
14
15
15
The built-in formatter options are:
16
16
@@ -20,7 +20,7 @@ The built-in formatter options are:
20
20
21
21
## Example Source
22
22
23
-
Examples of each formatter were created from linting `fullOfProblems.js` using the `.eslintrc.json` configuration shown below.
23
+
Examples of each formatter were created from linting `fullOfProblems.js` using the `eslint.config.js` configuration shown below.
0 commit comments