docs: Document extending plugin with new config #16394

bpmutter · 2022-10-07T02:15:13Z

Document how to extend a plugin configuration using the new ESLint configuration file type system.

Note that I included a comment in the example coming how extending a plugin works in the new config files compared to the old ones. I did this b/c I think that there's a significant enough change in behavior here for a critical feature that it's worth an explicit call out.

Fixes #16310

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)

Document extending plugin for new ESLint config file type (eslint.config.js)

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

netlify · 2022-10-07T02:15:19Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`4fa599b`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/6341d9f744c5db000983b8a5
😎 Deploy Preview	https://deploy-preview-16394--docs-eslint.netlify.app/user-guide/configuring/configuration-files-new
📱 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.

Document how to extend a plugin configuration using the new ESLint configuration file type system. Fixes eslint#16310

kecrily

LGTM, thank you

nzakas

Thanks for this, I just left a few comments on ways I think we can make things clearer.

nzakas · 2022-10-07T19:11:21Z

docs/src/user-guide/configuring/configuration-files-new.md

+    // ... other configuration objects
+];
+/*
+The above code is equivalent to the following configuration using the legacy .eslintrc


I don’t think we should refer to the old way of doing this at all because they are not actually equivalent. They accomplish the same thing in a very narrow way but there are subtle differences that I think will confuse people if we say they’re equivalent.

nzakas · 2022-10-07T19:12:41Z

docs/src/user-guide/configuring/configuration-files-new.md

+
+export default [
+    jsdoc.configs.recommended,
+    // ... other configuration objects


I think it’s important to include an actual config object here as an example. It can be fairly simple, just setting a jsdoc rule to “warn” would suffice.

nzakas · 2022-10-07T19:14:08Z

docs/src/user-guide/configuring/configuration-files-new.md

+*/
+```
+
+#### Using plugin rules


I’d suggest flipping the order of these two sections so using plugin rules comes first. That way, you can show how you can include a config from a plugin and also override the config’s default rule options with another config object in the array.

bpmutter · 2022-10-08T20:14:18Z

@nzakas incorporated your feedback. ready for re-review!

mdjermanovic

LGTM, thanks!

nzakas

LGTM. Thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.25.0` -> `8.26.0`](https://renovatebot.com/diffs/npm/eslint/8.25.0/8.26.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.26.0`](https://github.com/eslint/eslint/releases/tag/v8.26.0) [Compare Source](eslint/eslint@v8.25.0...v8.26.0) #### Features - [`4715787`](eslint/eslint@4715787) feat: check `Object.create()` in getter-return ([#16420](eslint/eslint#16420)) (Yuki Hirasawa) - [`28d1902`](eslint/eslint@28d1902) feat: `no-implicit-globals` supports `exported` block comment ([#16343](eslint/eslint#16343)) (Sosuke Suzuki) - [`e940be7`](eslint/eslint@e940be7) feat: Use ESLINT_USE_FLAT_CONFIG environment variable for flat config ([#16356](eslint/eslint#16356)) (Tomer Aberbach) - [`dd0c58f`](eslint/eslint@dd0c58f) feat: Swap out Globby for custom globbing solution. ([#16369](eslint/eslint#16369)) (Nicholas C. Zakas) #### Bug Fixes - [`df77409`](eslint/eslint@df77409) fix: use `baseConfig` constructor option in FlatESLint ([#16432](eslint/eslint#16432)) (Milos Djermanovic) - [`33668ee`](eslint/eslint@33668ee) fix: Ensure that glob patterns are matched correctly. ([#16449](eslint/eslint#16449)) (Nicholas C. Zakas) - [`740b208`](eslint/eslint@740b208) fix: ignore messages without a `ruleId` in `getRulesMetaForResults` ([#16409](eslint/eslint#16409)) (Francesco Trotta) - [`8f9759e`](eslint/eslint@8f9759e) fix: `--ignore-pattern` in flat config mode should be relative to `cwd` ([#16425](eslint/eslint#16425)) (Milos Djermanovic) - [`325ad37`](eslint/eslint@325ad37) fix: make `getRulesMetaForResults` return a plain object in trivial case ([#16438](eslint/eslint#16438)) (Francesco Trotta) - [`a2810bc`](eslint/eslint@a2810bc) fix: Ensure that directories can be unignored. ([#16436](eslint/eslint#16436)) (Nicholas C. Zakas) - [`35916ad`](eslint/eslint@35916ad) fix: Ensure unignore and reignore work correctly in flat config. ([#16422](eslint/eslint#16422)) (Nicholas C. Zakas) #### Documentation - [`651649b`](eslint/eslint@651649b) docs: Core concepts page ([#16399](eslint/eslint#16399)) (Ben Perlmutter) - [`631cf72`](eslint/eslint@631cf72) docs: note --ignore-path not supported with flat config ([#16434](eslint/eslint#16434)) (Andy Edwards) - [`1692840`](eslint/eslint@1692840) docs: fix syntax in examples for new config files ([#16427](eslint/eslint#16427)) (Milos Djermanovic) - [`d336cfc`](eslint/eslint@d336cfc) docs: Document extending plugin with new config ([#16394](eslint/eslint#16394)) (Ben Perlmutter) #### Chores - [`e917a9a`](eslint/eslint@e917a9a) ci: add node v19 ([#16443](eslint/eslint#16443)) (Koichi ITO) - [`4b70b91`](eslint/eslint@4b70b91) chore: Add VS Code issues link ([#16423](eslint/eslint#16423)) (Nicholas C. Zakas) - [`232d291`](eslint/eslint@232d291) chore: suppress a Node.js deprecation warning ([#16398](eslint/eslint#16398)) (Koichi ITO) </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, click this checkbox. --- 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/1599 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 Oct 7, 2022

docs: Document extending plugin with new config

0ab69e0

Document how to extend a plugin configuration using the new ESLint configuration file type system. Fixes eslint#16310

bpmutter force-pushed the new_config_plugin_usage branch from e9a8dfc to 0ab69e0 Compare October 7, 2022 02:19

kecrily approved these changes Oct 7, 2022

View reviewed changes

nzakas requested changes Oct 7, 2022

View reviewed changes

incorporate @nzakas feedback

4fa599b

mdjermanovic 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 Oct 10, 2022

mdjermanovic approved these changes Oct 10, 2022

View reviewed changes

nzakas approved these changes Oct 12, 2022

View reviewed changes

nzakas merged commit d336cfc into eslint:main Oct 12, 2022

eslint-github-bot bot locked and limited conversation to collaborators Apr 11, 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 Apr 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Document extending plugin with new config #16394

docs: Document extending plugin with new config #16394

bpmutter commented Oct 7, 2022 •

edited

netlify bot commented Oct 7, 2022 •

edited

kecrily left a comment

nzakas left a comment

nzakas Oct 7, 2022

nzakas Oct 7, 2022

nzakas Oct 7, 2022

bpmutter commented Oct 8, 2022

mdjermanovic left a comment

nzakas left a comment

docs: Document extending plugin with new config #16394

docs: Document extending plugin with new config #16394

Conversation

bpmutter commented Oct 7, 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 Oct 7, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

kecrily left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

nzakas Oct 7, 2022

Choose a reason for hiding this comment

nzakas Oct 7, 2022

Choose a reason for hiding this comment

nzakas Oct 7, 2022

Choose a reason for hiding this comment

bpmutter commented Oct 8, 2022

mdjermanovic left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

bpmutter commented Oct 7, 2022 •

edited

netlify bot commented Oct 7, 2022 •

edited