docs: add Glossary page #18187
docs: add Glossary page #18187
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JoshuaKGoldberg
force-pushed
the
docs-glossary
branch
from
0f99bb3
to
7c4b01f
Compare
Co-authored-by: Tanuj Kanti <86398394+Tanujkanti4441@users.noreply.github.com>
|
How about if we also add information about recommended rules, code paths, code path analysis, eslint directive comments to enable or disable any rule, espree, sourceCode, estraverse, rule-tester, scope, scope-manager (these are just suggestions). |
There was a problem hiding this comment.
Thanks for looking at this! I'm happy to have a place to start rationalizing our naming of things.
One thing I think we should do: don't treat eslintrc like an equal partner to flat config. Let's write this as if eslintrc is a piece of the past, so we don't need to explain how to use it or how to configure it. We should assume flat config is THE config system and go from there.
|
|
||
| A file containing settings for how ESLint should parse files into and run [rules](#rule). | ||
|
|
||
| ESLint currently supports two file systems: |
There was a problem hiding this comment.
- I think you meant "config systems" rather than "file systems"?
- At this point, I don't think we need to say ESLint supports two config systems. Let's just pretend flat config is the only config system.
There was a problem hiding this comment.
Rewording to just mention the current config system here.
I think it'd still be good to have explicit mentions of "flat" and "legacy" as terms. Other writers have already written a lot of resources that refer to those terms for configs, and users will be coming to this page to learn what they mean. Are you opposed to having ### Flat Config and ### Legacy Config entries?
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com> Co-authored-by: Tanuj Kanti <86398394+Tanujkanti4441@users.noreply.github.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
mdjermanovic
added
the
accepted
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Adds a
/use/core-concepts/glossarypage underneath the existing Core Concepts page.Fixes #17987.
Is there anything you'd like reviewers to focus on?
I'd originally had sections for general JS concepts (closures, scope, etc.) and common AST nodes (blocks, expressions, etc.) but found it to be a lot of clutter. I'm not confident I got the right balance of what info is useful vs. overkill.