Skip to content

Commit 1b0077f

Browse files
authored
docs: add glossary page (#1090)
1 parent 3694426 commit 1b0077f

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Glossary"
3+
description: "A collection of terms and concepts used in the ESLint React."
4+
---
5+
6+
## L
7+
8+
### Language Config (Configuration)
9+
10+
The configuration file for Language Features and Language Servers.
11+
12+
Language Configs are typically used by IDEs and editors to provide language features such as hover information, auto completion, jump to definition, error checking, formatting, refactoring, and more.
13+
14+
ESLint React uses the Language Config to provide information (e.g. [JSX Transform](/docs/configuration/configure-language-config#jsx-transform), [Type Information](/docs/configuration/configure-language-config#rules-that-need-type-information)) about the code it is linting.
15+
16+
For TypeScript or JavaScript files, the Language Config are typically named `tsconfig.json` or `jsconfig.json` and are located in the root of a project.
17+
18+
For MDX files, the Language Config is the `"mdx"` property in the `tsconfig.json` file.
19+
20+
### Language Preference
21+
22+
Language Preference is a set of rules that represents the user's preference for how code should be formatted.
23+
24+
ESLint React provides a way to customize the code style used in the internal fixer's output through Language Preference.

apps/website/content/docs/meta.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
"title": "Documentation",
33
"pages": [
44
"getting-started",
5+
"---Core Concepts---",
6+
"glossary",
57
"---Core Reference---",
68
"rules",
79
"presets",

0 commit comments

Comments
 (0)