Skip to content

Commit 7ec733a

Browse files
authored
docs: Fix typos and grammar in glossary (#21095)
* docs: Fix typos and grammar in glossary * docs: Include TypeScript config file extensions in glossary
1 parent e23fafe commit 7ec733a

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ ESLint [rules](#rule) are given an AST and may produce [violations](#violation)
2727

2828
A file containing preferences for how ESLint should parse files and run [rules](#rule).
2929

30-
ESLint config files are named like `eslint.config.(c|m)js`.
30+
ESLint config files are named like `eslint.config.(c|m)?(j|t)s`.
3131
Each config file exports a [config array](#config-array) containing [config objects](#config-object).
3232

3333
For example, this `eslint.config.js` file enables the `prefer-const` [rule](#rule) at the _error_ [severity](#severity):
@@ -124,7 +124,7 @@ Rule violations may also include file changes that are unsafe and not automatica
124124

125125
The current configuration file format for ESLint.
126126

127-
Flat config files are named in the format `eslint.config.(c|m)?js`.
127+
Flat config files are named in the format `eslint.config.(c|m)?(j|t)s`.
128128
"Flat" config files are named as such because all nesting must be done in one configuration file.
129129
In contrast, the ["Legacy" config format](#legacy-config) allowed nesting configuration files in sub-directories within a project.
130130

@@ -220,9 +220,9 @@ Note that a _linter_ is separate from [formatters](#formatter-tool) and [type ch
220220

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

223-
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)).
223+
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)).
224224

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

227227
## N
228228

@@ -233,7 +233,7 @@ A section of code within an [AST](#abstract-syntax-tree-ast).
233233
Each node represents a type of syntax found in source code.
234234
For example, the `1 + 2` in the AST for `1 + 2;` is a _BinaryExpression_.
235235

236-
See [#esquery](#esquery) for the library ESLint uses to parse [selectors](#selector) that allow [rules](#rule) to search for nodes.
236+
See [ESQuery](#esquery) for the library ESLint uses to parse [selectors](#selector) that allow [rules](#rule) to search for nodes.
237237

238238
## O
239239

@@ -297,7 +297,7 @@ A part of a plugin that extracts JavaScript code from other kinds of files, then
297297

298298
For example, [`@eslint/markdown`](https://github.com/eslint/markdown) includes a processor that converts the text of <code>```</code> code blocks in Markdown files into code that can be linted.
299299

300-
For more information on configuring processor, see [Plugins > Specify a Processor](../configure/plugins#specify-a-processor).
300+
For more information on configuring processors, see [Plugins > Specify a Processor](../configure/plugins#specify-a-processor).
301301

302302
## R
303303

@@ -339,7 +339,7 @@ For documentation on configuring rules, see [Configure Rules](../configure/rules
339339

340340
### Shareable Config (Configuration)
341341

342-
A module that provides a predefined [config file](#config-file-configuration-file) configurations.
342+
A module that provides predefined [config file](#config-file-configuration-file) configurations.
343343

344344
Shareable configs can configure all the same information from config files, including [plugins](#plugin) and [rules](#rule).
345345

@@ -380,7 +380,7 @@ For more information, see [Changes to our rules policies](https://eslint.org/blo
380380
An optional augmentation to a [rule](#rule) [violation](#violation) that describes how one may manually adjust the code to address the violation.
381381

382382
Suggestions are not generally safe to apply automatically because they cause code behavior changes.
383-
ESLint does not apply suggestions directly but does provide suggestion to integrations that may choose to apply suggestions (such as an editor extension).
383+
ESLint does not apply suggestions directly but does provide suggestions to integrations that may choose to apply suggestions (such as an editor extension).
384384

385385
Rule violations may also include file changes that are safe and may be automatically applied in the form of [fixes](#fix).
386386

@@ -394,13 +394,13 @@ Type checkers are generally slower and more comprehensive than linters.
394394
Whereas linters traditionally operate only on a single file's or snippet's [AST](#abstract-syntax-tree-ast) at a time, type checkers understand cross-file dependencies and types.
395395

396396
[TypeScript](https://typescriptlang.org) is the most common type checker for JavaScript.
397-
The [typescript-eslint](https://typescript-eslint.io) project provides integrations that allow using type checker in lint rules.
397+
The [typescript-eslint](https://typescript-eslint.io) project provides integrations that allow using type checkers in lint rules.
398398

399399
## V
400400

401401
### Violation
402402

403403
An indication from a [rule](#rule) that an area of code doesn't meet the expectation of the rule.
404404

405-
Rule violations indicate a range in source code and error message explaining the violation.
405+
Rule violations indicate a range in source code and an error message explaining the violation.
406406
Violations may also optionally include a [fix](#fix) and/or [suggestions](#suggestion) that indicate how to improve the violating code.

0 commit comments

Comments
 (0)