Skip to content

Commit 52f5b7a

Browse files
authored
docs: fix minor typos and add links (#19743)
1 parent 0f49329 commit 52f5b7a

File tree

8 files changed

+19
-18
lines changed

8 files changed

+19
-18
lines changed

docs/src/maintain/manage-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ All of ESLint's issues and pull requests, across all GitHub repositories, are ma
4444
- **Implementing**: There is an open pull request for each of these issues or this is a pull request that has been approved.
4545
- **Second Review Needed**: Pull requests that already have one approval and the approver is requesting a second review before merging.
4646
- **Merge Candidates**: Pull requests that already have at least one approval and at least one approver believes the pull request is ready to merge into the next release but would still like a TSC member to verify.
47-
- **Completed**: The issue has been closed (either via pull request merge or by the team manually closing the issue).
47+
- **Complete**: The issue has been closed (either via pull request merge or by the team manually closing the issue).
4848

4949
We make every attempt to automate movement between as many columns as we can, but sometimes moving issues needs to be done manually.
5050

docs/src/use/configure/configuration-files.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ module.exports = defineConfig([
6565

6666
Each configuration object contains all of the information ESLint needs to execute on a set of files. Each configuration object is made up of these properties:
6767

68-
- `name` - A name for the configuration object. This is used in error messages and config inspector to help identify which configuration object is being used. ([Naming Convention](#configuration-naming-conventions))
68+
- `name` - A name for the configuration object. This is used in error messages and [config inspector](https://github.com/eslint/config-inspector) to help identify which configuration object is being used. ([Naming Convention](#configuration-naming-conventions))
6969
- `files` - An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files matched by any other configuration object.
7070
- `ignores` - An array of glob patterns indicating the files that the configuration object should not apply to. If not specified, the configuration object applies to all files matched by `files`. If `ignores` is used without any other keys in the configuration object, then the patterns act as [global ignores](#globally-ignoring-files-with-ignores) and it gets applied to every configuration object.
7171
- `extends` - An array of strings, configuration objects, or configuration arrays that contain additional configuration to apply.
@@ -284,7 +284,7 @@ export default defineConfig([
284284
ignores: [".config/", "dist/", "tsconfig.json"] // acts as global ignores, due to the absence of other properties
285285
},
286286
{ ... }, // ... other configuration object, inherit global ignores
287-
{ ... }, // ... other configuration object inherit global ignores
287+
{ ... }, // ... other configuration object, inherit global ignores
288288
]);
289289

290290
// Example of non-global ignores
@@ -310,7 +310,7 @@ import { defineConfig, globalIgnores } from "eslint/config";
310310
export default defineConfig([
311311
globalIgnores([".config/", "dist/", "tsconfig.json"]),
312312
{ ... }, // ... other configuration object, inherit global ignores
313-
{ ... }, // ... other configuration object inherit global ignores
313+
{ ... }, // ... other configuration object, inherit global ignores
314314
]);
315315

316316
// Example of non-global ignores
@@ -357,7 +357,7 @@ export default defineConfig([
357357
]);
358358
```
359359

360-
Using this configuration, all JavaScript files define a custom global object defined called `MY_CUSTOM_GLOBAL` while those JavaScript files in the `tests` directory have `it` and `describe` defined as global objects in addition to `MY_CUSTOM_GLOBAL`. For any JavaScript file in the tests directory, both configuration objects are applied, so `languageOptions.globals` are merged to create a final result.
360+
Using this configuration, all JavaScript files define a custom global object defined called `MY_CUSTOM_GLOBAL` while those JavaScript files in the `tests` directory have `it` and `describe` defined as global objects in addition to `MY_CUSTOM_GLOBAL`. For any JavaScript file in the `tests` directory, both configuration objects are applied, so `languageOptions.globals` are merged to create a final result.
361361

362362
### Configuring Linter Options
363363

@@ -582,7 +582,7 @@ export default defineConfig([
582582
]);
583583
```
584584

585-
Here, the `js/recommended` predefined configuration is applied first and then another configuration object adds the desired configuration for `no-unused-vars`.
585+
Here, the `js/recommended` predefined configuration is applied first and then another configuration object adds the desired configuration for [`no-unused-vars`](../../rules/no-unused-vars).
586586

587587
For more information on how to combine predefined configs with your preferences, please see [Combine Configs](combine-configs).
588588

docs/src/use/configure/rules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ In this example, [`eqeqeq`](../../rules/eqeqeq) is turned off and [`curly`](../.
4141
/* eslint eqeqeq: 0, curly: 2 */
4242
```
4343

44-
This example is the same as the last example, only it uses the numeric codes instead of the string values. The `eqeqeq` rule is off and the `curly` rule is set to be an error.
44+
This example is the same as the last example, only it uses the numeric codes instead of the string values. The [`eqeqeq`](../../rules/eqeqeq) rule is off and the [`curly`](../../rules/curly) rule is set to be an error.
4545

4646
If a rule has additional options, you can specify them using array literal syntax, such as:
4747

4848
```js
4949
/* eslint quotes: ["error", "double"], curly: 2 */
5050
```
5151

52-
This comment specifies the "double" option for the [`quotes`](../../rules/quotes) rule. The first item in the array is always the rule severity (number or string).
52+
This comment specifies the `"double"` option for the [`quotes`](../../rules/quotes) rule. The first item in the array is always the rule severity (number or string).
5353

5454
#### Configuration Comment Descriptions
5555

docs/src/use/core-concepts/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ You can let ESLint know which global variables your code uses with [global decla
187187
A source code comment that configures a rule to a different severity and/or set of options.
188188

189189
Inline configs use similar syntax as [config files](#config-file-configuration-file) to specify any number of rules by name, their new severity, and optionally new options for the rules.
190-
For example, the following inline config comment simultaneously disables the `eqeqeq` rule and sets the `curly` rule to `"error"`:
190+
For example, the following inline config comment simultaneously disables the [`eqeqeq`](../../rules/eqeqeq) rule and sets the [`curly`](../../rules/curly) rule to `"error"`:
191191

192192
```js
193193
/* eslint eqeqeq: "off", curly: "error" */
@@ -218,7 +218,7 @@ Note that a _linter_ is separate from [formatters](#formatter-tool) and [type ch
218218

219219
A [rule](#rule) that inspects how code operates to find problems.
220220

221-
Many logical rules look for likely crashes (e.g. [`no-undef`](../../rules/no-undef)), unintended behavior (e.g. [`no-sparse-arrays`](../../rules/no-sparse-arrays)), and unused code (e.g [`no-unused-vars`](../../rules/no-unused-vars)),
221+
Many logical rules look for likely crashes (e.g. [`no-undef`](../../rules/no-undef)), unintended behavior (e.g. [`no-sparse-arrays`](../../rules/no-sparse-arrays)), and unused code (e.g [`no-unused-vars`](../../rules/no-unused-vars)).
222222

223223
You can see the full list of logical rules that ship with ESLint under [Rules > Possible Problems](../../rules/#possible-problems)
224224

docs/src/use/core-concepts/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ Shareable configurations are ESLint configurations that are shared via npm.
5252

5353
Often shareable configurations are used to enforce style guides using ESLint's built-in rules. For example the sharable configuration [eslint-config-airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base) implements the popular Airbnb JavaScript style guide.
5454

55-
For more information, refer to [Using a shareable configuration package](../configure/configuration-files#using-a-shareable-configuration-package).
55+
For more information, refer to [Using a Shareable Configuration Package](../configure/configuration-files#using-a-shareable-configuration-package).
5656

5757
## Plugins
5858

59-
An ESLint plugin is an npm module that can contain a set of ESLint rules, configurations, processors, and languages. Often plugins include custom rules. Plugins can be used to enforce a style guide and support JavaScript extensions (like TypeScript), libraries (like React), and frameworks (Angular).
59+
An ESLint plugin is an npm module that can contain a set of ESLint rules, configurations, processors, and languages. Often plugins include custom rules. Plugins can be used to enforce a style guide and support JavaScript extensions (like [TypeScript](https://www.typescriptlang.org)), libraries (like [React](https://react.dev)), and frameworks (like [Angular](https://angular.dev)).
6060

6161
A popular use case for plugins is to enforce best practices for a framework. For example, [@angular-eslint/eslint-plugin](https://www.npmjs.com/package/@angular-eslint/eslint-plugin) contains best practices for using the Angular framework.
6262

docs/src/use/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ export default defineConfig([
8787

8888
The names `"no-unused-vars"` and `"no-undef"` are the names of [rules](../rules) in ESLint. The first value is the error level of the rule and can be one of these values:
8989

90-
- "off" or 0 - turn the rule off
91-
- "warn" or 1 - turn the rule on as a warning (doesn’t affect exit code)
92-
- "error" or 2 - turn the rule on as an error (exit code will be 1)
90+
- `"off"` or `0` - turn the rule off
91+
- `"warn"` or `1` - turn the rule on as a warning (doesn’t affect exit code)
92+
- `"error"` or `2` - turn the rule on as an error (exit code will be 1)
9393

9494
The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the configuration docs).
9595

@@ -118,7 +118,7 @@ Before you begin, you must already have a `package.json` file. If you don't, mak
118118

119119
{{ npm_tabs({
120120
command: "install",
121-
packages: ["eslint", "@eslint/js"],
121+
packages: ["eslint@latest", "@eslint/js@latest"],
122122
args: ["--save-dev"]
123123
}) }}
124124

packages/eslint-config-eslint/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@ export default defineConfig([eslintConfigESLint]);
4343
In your `eslint.config.js` file, add:
4444

4545
```js
46+
const { defineConfig } = require("eslint/config");
4647
const eslintConfigESLintCJS = require("eslint-config-eslint/cjs");
4748

48-
module.exports = [...eslintConfigESLintCJS];
49+
module.exports = defineConfig([eslintConfigESLintCJS]);
4950
```
5051

5152
### Base config

tools/update-readme.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ const readme = fs.readFileSync(README_FILE_PATH, "utf8");
3636

3737
/**
3838
* Fetches the latest sponsors from the website.
39-
* @returns {Promise<string>}} Prerendered sponsors markdown.
39+
* @returns {Promise<string>} Prerendered sponsors markdown.
4040
*/
4141
async function fetchSponsorsMarkdown() {
4242
return got(SPONSORS_URL).text();

0 commit comments

Comments
 (0)