docs: Configuring Plugins page intro, page tweaks, and rename #16534

bpmutter · 2022-11-11T02:13:49Z

Prerequisites checklist

I have read the contributing guidelines.

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)

renamed 'Configuring Plugins' page to 'Configuring Plugins & Parsers' b/c plugins separate from parsers
- note: didn't change page name b/c didn't want to break the existing URL path before we have redirects set up
added intro section to page
small copy edits throughout page
move section order to make clear that processors are part of plugins, whereas parsers are separate.
also moved up the docs on configuring plugins b/c that is the more commonly used feature.

Part of #16473

Is there anything you'd like reviewers to focus on?

netlify · 2022-11-11T02:13:54Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`20286ce`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/63854da1f71c450008022828
😎 Deploy Preview	https://deploy-preview-16534--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

docs/src/user-guide/configuring/plugins.md

snitin315

Looks good. A few suggestions:

docs/src/user-guide/configuring/plugins.md

snitin315

LGTM. Thank you.

docs/src/user-guide/configuring/plugins.md

Co-authored-by: Nitin Kumar <snitin315@gmail.com>

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

amareshsm

LGTM

nzakas · 2022-11-22T19:17:23Z

docs/src/user-guide/configuring/index.md

 * [Configuring Plugins](./plugins#configuring-plugins)
+* [Specifying Processor](./plugins#specifying-processor)
+* [Configuring Parsers](./plugins#configuring-parsers)


I believe this should be singular to avoid breaking the link and for consistency.

Suggested change

* [Configuring Parsers](./plugins#configuring-parsers)

* [Configuring Parser](./plugins#configuring-parser)

changed all to be plural, consistent w other similar links on the page.

also updated the #anchor-links to match updated page anchors that don't use "-ing" form (see this comment for context)

Sounds good. I ❤️ consistency. 😄

docs/src/user-guide/configuring/plugins.md

nzakas · 2022-11-22T19:20:37Z

docs/src/user-guide/configuring/plugins.md

+
+ESLint checks the file path of named code blocks then ignores those if any `overrides` entry didn't match the file path. Be sure to add an `overrides` entry if you want to lint named code blocks other than `*.js`.
+
+## Configuring Parsers


Keeping everything singular

Suggested change

## Configuring Parsers

## Configuring Parser

made singular and removed the "-ing" form on all section headers on the page.

in future PR, should update all section headings across entire docs set to be not "-ing" form of word to align w the pages names in the new IA.

bpmutter · 2022-11-27T17:34:56Z

@nzakas readded the changes per your suggestions. ready for re-review. (not sure why didn't get added before, presumably some form of PEBCAK.)

docs/src/user-guide/configuring/index.md

docs/src/user-guide/configuring/plugins.md

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic

LGTM, thanks!

harish-sethuraman · 2022-11-30T20:02:54Z

docs/src/user-guide/configuring/plugins.md

+* [@babel/eslint-parser](https://www.npmjs.com/package/@babel/eslint-parser) - A wrapper around the [Babel](https://babeljs.io) parser that makes it compatible with ESLint.
+* [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser) - A parser that converts TypeScript into an ESTree-compatible form so it can be used in ESLint.
+
+Note that when using a custom parser, the `parserOptions` configuration property is still required for ESLint to work properly with features not in ECMAScript 5 by default. Parsers are all passed `parserOptions` and may or may not use them to determine which features to enable.


Parsers are all passed `parserOptions` and may or may not use them to determine which features to enable.

I feel this part to be quite confusing 😅

I think this wording is fine and shouldn't hold up this PR. We can continue tweaking later.

nzakas · 2022-11-30T21:23:07Z

docs/src/user-guide/configuring/index.md

-* [Specifying Parser](./plugins#specifying-parser)
-* [Specifying Processor](./plugins#specifying-processor)
-* [Configuring Plugins](./plugins#configuring-plugins)
+* [Configuring Plugins](./plugins#configure-plugins)


We still have this inconsistency of "Configuring Plugins" in the link but then it links to "Configure Plugins". The same for the following three links. Can we make these consistent?

i kept these as they are to match the other heading links on this page, which are all in "-ing" form. was going to change em all as part of #16578

can do these ones now if that's your preference

Ah okay. As long as we're tracking that task, we don't need to do them as part of this PR. 👍

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.28.0` -> `8.29.0`](https://renovatebot.com/diffs/npm/eslint/8.28.0/8.29.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.29.0`](https://github.com/eslint/eslint/releases/tag/v8.29.0) [Compare Source](eslint/eslint@v8.28.0...v8.29.0) #### Features - [`49a07c5`](eslint/eslint@49a07c5) feat: add `allowParensAfterCommentPattern` option to no-extra-parens ([#16561](eslint/eslint#16561)) (Nitin Kumar) - [`e6a865d`](eslint/eslint@e6a865d) feat: `prefer-named-capture-group` add suggestions ([#16544](eslint/eslint#16544)) (Josh Goldberg) - [`a91332b`](eslint/eslint@a91332b) feat: In no-invalid-regexp validate flags also for non-literal patterns ([#16583](eslint/eslint#16583)) (trosos) #### Documentation - [`0311d81`](eslint/eslint@0311d81) docs: Configuring Plugins page intro, page tweaks, and rename ([#16534](eslint/eslint#16534)) (Ben Perlmutter) - [`57089b1`](eslint/eslint@57089b1) docs: add a property assignment example for camelcase rule ([#16605](eslint/eslint#16605)) (Milos Djermanovic) - [`b6ab030`](eslint/eslint@b6ab030) docs: add docs codeowners ([#16601](eslint/eslint#16601)) (Strek) - [`6380c87`](eslint/eslint@6380c87) docs: fix sitemap and feed ([#16592](eslint/eslint#16592)) (Milos Djermanovic) - [`ade621d`](eslint/eslint@ade621d) docs: perf debounce the search query ([#16586](eslint/eslint#16586)) (Shanmughapriyan S) - [`fbcf3ab`](eslint/eslint@fbcf3ab) docs: fix searchbar clear button ([#16585](eslint/eslint#16585)) (Shanmughapriyan S) - [`f894035`](eslint/eslint@f894035) docs: HTTPS link to yeoman.io ([#16582](eslint/eslint#16582)) (Christian Oliff) - [`de12b26`](eslint/eslint@de12b26) docs: Update configuration file pages ([#16509](eslint/eslint#16509)) (Ben Perlmutter) - [`1ae9f20`](eslint/eslint@1ae9f20) docs: update correct code examples for `no-extra-parens` rule ([#16560](eslint/eslint#16560)) (Nitin Kumar) #### Chores - [`7628403`](eslint/eslint@7628403) chore: add discord channel link ([#16590](eslint/eslint#16590)) (Amaresh S M) - [`f5808cb`](eslint/eslint@f5808cb) chore: fix rule doc headers check ([#16564](eslint/eslint#16564)) (Milos Djermanovic) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1667 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Nov 11, 2022

bpmutter commented Nov 13, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

bpmutter commented Nov 13, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

bpmutter commented Nov 13, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

bpmutter marked this pull request as ready for review November 13, 2022 19:04

snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Nov 15, 2022

snitin315 reviewed Nov 15, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

docs/src/user-guide/configuring/plugins.md Show resolved Hide resolved

mdjermanovic reviewed Nov 17, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

snitin315 approved these changes Nov 18, 2022

View reviewed changes

harish-sethuraman reviewed Nov 18, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

bpmutter and others added 7 commits November 21, 2022 20:31

docs: plugins config intro + tweaks

eda62c6

refactor intro/page name

8f94e76

refactor page to reflect parsers separate from plugins

4f2de6c

copy edits

0a3b275

Apply suggestions from code review

7a0c4bd

Co-authored-by: Nitin Kumar <snitin315@gmail.com>

Apply suggestions from code review

ffa3c30

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

Update docs/src/user-guide/configuring/plugins.md

3ef40fb

bpmutter force-pushed the config_plugins_tweaks branch from c385dfa to 3ef40fb Compare November 22, 2022 01:32

amareshsm approved these changes Nov 22, 2022

View reviewed changes

nzakas requested changes Nov 22, 2022

View reviewed changes

bpmutter requested a review from nzakas November 23, 2022 19:49

bpmutter added 2 commits November 27, 2022 12:30

change titles to non gerund + inline links

fb138fd

add custom environments bullet point

40cd2fd

mdjermanovic reviewed Nov 28, 2022

View reviewed changes

docs/src/user-guide/configuring/index.md Show resolved Hide resolved

mdjermanovic reviewed Nov 28, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

mdjermanovic reviewed Nov 28, 2022

View reviewed changes

docs/src/user-guide/configuring/plugins.md Outdated Show resolved Hide resolved

bpmutter and others added 2 commits November 28, 2022 19:05

Apply suggestions from code review

60d23ad

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

update anchor links

20286ce

mdjermanovic approved these changes Nov 29, 2022

View reviewed changes

harish-sethuraman reviewed Nov 30, 2022

View reviewed changes

nzakas reviewed Nov 30, 2022

View reviewed changes

nzakas approved these changes Dec 2, 2022

View reviewed changes

nzakas merged commit 0311d81 into eslint:main Dec 2, 2022

bpmutter mentioned this pull request Dec 3, 2022

Overviews & copy tweaks in user documentation pages #16473

Closed

1 task

github-actions bot mentioned this pull request May 2, 2023

Upgraded some dependencies - Attempt 2 AurorNZ/report-updated-dependencies#638

Merged

eslint-github-bot bot locked and limited conversation to collaborators Jun 1, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jun 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Configuring Plugins page intro, page tweaks, and rename #16534

docs: Configuring Plugins page intro, page tweaks, and rename #16534

bpmutter commented Nov 11, 2022 •

edited

netlify bot commented Nov 11, 2022 •

edited

snitin315 left a comment

snitin315 left a comment

amareshsm left a comment

nzakas Nov 22, 2022

bpmutter Nov 23, 2022 •

edited

nzakas Nov 23, 2022

bpmutter Nov 23, 2022

nzakas Nov 22, 2022

bpmutter Nov 23, 2022

bpmutter commented Nov 27, 2022

mdjermanovic left a comment

harish-sethuraman Nov 30, 2022

nzakas Nov 30, 2022

nzakas Nov 30, 2022

bpmutter Nov 30, 2022 •

edited

nzakas Dec 2, 2022

	* [Configuring Parsers](./plugins#configuring-parsers)
	* [Configuring Parser](./plugins#configuring-parser)


		ESLint checks the file path of named code blocks then ignores those if any `overrides` entry didn't match the file path. Be sure to add an `overrides` entry if you want to lint named code blocks other than `*.js`.

		## Configuring Parsers

docs: Configuring Plugins page intro, page tweaks, and rename #16534

docs: Configuring Plugins page intro, page tweaks, and rename #16534

Conversation

bpmutter commented Nov 11, 2022 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Nov 11, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

snitin315 left a comment

Choose a reason for hiding this comment

snitin315 left a comment

Choose a reason for hiding this comment

amareshsm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpmutter Nov 23, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpmutter commented Nov 27, 2022

mdjermanovic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpmutter Nov 30, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpmutter commented Nov 11, 2022 •

edited

netlify bot commented Nov 11, 2022 •

edited

bpmutter Nov 23, 2022 •

edited

bpmutter Nov 30, 2022 •

edited