feat: Use plugin metadata for flat config serialization #16992

nzakas · 2023-03-15T21:14:56Z

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
[x] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Updates FlatConfigArray to look for meta information on plugins when serializing a config.

Fixes #16284

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

Does the plugin name/version string format make sense?

netlify · 2023-03-15T21:15:02Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`1c4a613`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/6414ae8a76f9b4000830acde

snitin315

LGTM. One minor suggestion.

docs/src/extend/plugins.md

mdjermanovic

Code LGTM. But if we merge this as is, I believe the tests will fail because of parser: "@/espree". It might be best to rebase.

nzakas · 2023-03-16T20:29:34Z

@mdjermanovic oops, good call. I could have sworn that I rebased before pushing.

mdjermanovic · 2023-03-17T09:40:16Z

There are merge conflicts now, and the commit history on this branch looks weird like something went wrong with the rebase.

Updates `FlatConfigArray` to look for meta information on plugins when serializing a config. Fixes #16284

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

nzakas · 2023-03-17T18:17:02Z

Hmmm, no idea what the problem could be. The rebase was clean locally before I pushed. I'll try again.

mdjermanovic

LGTM, thanks! For some reason, I didn't get a notification that this was updated.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.36.0` -> `8.37.0`](https://renovatebot.com/diffs/npm/eslint/8.36.0/8.37.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.37.0`](https://github.com/eslint/eslint/releases/tag/v8.37.0) [Compare Source](eslint/eslint@v8.36.0...v8.37.0) #### Features - [`b6ab8b2`](eslint/eslint@b6ab8b2) feat: `require-unicode-regexp` add suggestions ([#17007](eslint/eslint#17007)) (Josh Goldberg) - [`10022b1`](eslint/eslint@10022b1) feat: Copy getScope() to SourceCode ([#17004](eslint/eslint#17004)) (Nicholas C. Zakas) - [`1665c02`](eslint/eslint@1665c02) feat: Use plugin metadata for flat config serialization ([#16992](eslint/eslint#16992)) (Nicholas C. Zakas) - [`b3634f6`](eslint/eslint@b3634f6) feat: docs license ([#17010](eslint/eslint#17010)) (Samuel Roldan) - [`892e6e5`](eslint/eslint@892e6e5) feat: languageOptions.parser must be an object. ([#16985](eslint/eslint#16985)) (Nicholas C. Zakas) #### Bug Fixes - [`619f3fd`](eslint/eslint@619f3fd) fix: correctly handle `null` default config in `RuleTester` ([#17023](eslint/eslint#17023)) (Brad Zacher) - [`1fbf118`](eslint/eslint@1fbf118) fix: `getFirstToken`/`getLastToken` on comment-only node ([#16889](eslint/eslint#16889)) (Francesco Trotta) - [`129e252`](eslint/eslint@129e252) fix: Fix typo in `logical-assignment-operators` rule description ([#17000](eslint/eslint#17000)) (Francesco Trotta) #### Documentation - [`75339df`](eslint/eslint@75339df) docs: fix typos and missing info in id-match docs ([#17029](eslint/eslint#17029)) (Ed Lucas) - [`ec2d830`](eslint/eslint@ec2d830) docs: Fix typos in the `semi` rule docs ([#17012](eslint/eslint#17012)) (Andrii Lundiak) - [`e39f28d`](eslint/eslint@e39f28d) docs: add back to top button ([#16979](eslint/eslint#16979)) (Tanuj Kanti) - [`721c717`](eslint/eslint@721c717) docs: Custom Processors cleanup and expansion ([#16838](eslint/eslint#16838)) (Ben Perlmutter) - [`d049f97`](eslint/eslint@d049f97) docs: 'How ESLint is Maintained' page ([#16961](eslint/eslint#16961)) (Ben Perlmutter) - [`5251a92`](eslint/eslint@5251a92) docs: Describe guard options for guard-for-in ([#16986](eslint/eslint#16986)) (alope107) - [`6157d81`](eslint/eslint@6157d81) docs: Add example to guard-for-in docs. ([#16983](eslint/eslint#16983)) (alope107) - [`fd47998`](eslint/eslint@fd47998) docs: update `Array.prototype.toSorted` specification link ([#16982](eslint/eslint#16982)) (Milos Djermanovic) - [`3e1cf6b`](eslint/eslint@3e1cf6b) docs: Copy edits on Maintain ESLint docs ([#16939](eslint/eslint#16939)) (Ben Perlmutter) #### Chores - [`c67f299`](eslint/eslint@c67f299) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).37.0 ([#17033](eslint/eslint#17033)) (Milos Djermanovic) - [`ee9ddbd`](eslint/eslint@ee9ddbd) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`dddb475`](eslint/eslint@dddb475) chore: upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@2](https://github.com/2).0.2 ([#17032](eslint/eslint#17032)) (Milos Djermanovic) - [`522431e`](eslint/eslint@522431e) chore: upgrade espree@9.5.1 ([#17031](eslint/eslint#17031)) (Milos Djermanovic) - [`f5f9a88`](eslint/eslint@f5f9a88) chore: upgrade eslint-visitor-keys@3.4.0 ([#17030](eslint/eslint#17030)) (Milos Djermanovic) - [`4dd8d52`](eslint/eslint@4dd8d52) ci: bump actions/stale from 7 to 8 ([#17026](eslint/eslint#17026)) (dependabot\[bot]) - [`ad9dd6a`](eslint/eslint@ad9dd6a) chore: remove duplicate scss, ([#17005](eslint/eslint#17005)) (Strek) - [`ada6a3e`](eslint/eslint@ada6a3e) ci: unpin Node 19 ([#16993](eslint/eslint#16993)) (Milos Djermanovic) - [`c3da975`](eslint/eslint@c3da975) chore: Remove triage label from template ([#16990](eslint/eslint#16990)) (Nicholas C. Zakas) - [`69bc0e2`](eslint/eslint@69bc0e2) ci: pin Node 19 to 19.7.0 ([#16987](eslint/eslint#16987)) (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/1834 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>

snitin315 · 2023-06-10T03:27:32Z

Re-submitted the docs in #17268

nzakas requested a review from a team as a code owner March 15, 2023 21:14

eslint-github-bot bot added triage An ESLint team member will look at this issue soon feature This change adds a new feature to ESLint labels Mar 15, 2023

snitin315 added core Relates to ESLint's core APIs and features 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 Mar 16, 2023

snitin315 approved these changes Mar 16, 2023

View reviewed changes

docs/src/extend/plugins.md Outdated Show resolved Hide resolved

mdjermanovic reviewed Mar 16, 2023

View reviewed changes

nzakas and others added 3 commits March 17, 2023 11:16

feat: Use plugin metadata for flat config serialization

6bd0e2e

Updates `FlatConfigArray` to look for meta information on plugins when serializing a config. Fixes #16284

Update docs/src/extend/plugins.md

3cc5d68

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

Rebase

1c4a613

nzakas force-pushed the issue16284 branch from 9af9e83 to 1c4a613 Compare March 17, 2023 18:16

mdjermanovic approved these changes Mar 23, 2023

View reviewed changes

mdjermanovic merged commit 1665c02 into main Mar 23, 2023
17 checks passed

mdjermanovic deleted the issue16284 branch March 23, 2023 19:47

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

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

Merged

mdjermanovic mentioned this pull request May 27, 2023

Bug: Documentation licensed under non-OSS compatible license #17225

Closed

snitin315 mentioned this pull request Jun 10, 2023

docs: resubmit Create Plugins documentation #17268

Merged

1 task

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Use plugin metadata for flat config serialization #16992

feat: Use plugin metadata for flat config serialization #16992

nzakas commented Mar 15, 2023

netlify bot commented Mar 15, 2023 •

edited

snitin315 left a comment

mdjermanovic left a comment

nzakas commented Mar 16, 2023

mdjermanovic commented Mar 17, 2023

nzakas commented Mar 17, 2023

mdjermanovic left a comment

snitin315 commented Jun 10, 2023

feat: Use plugin metadata for flat config serialization #16992

feat: Use plugin metadata for flat config serialization #16992

Conversation

nzakas commented Mar 15, 2023

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 Mar 15, 2023 • edited

✅ Deploy Preview for docs-eslint canceled.

snitin315 left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

nzakas commented Mar 16, 2023

mdjermanovic commented Mar 17, 2023

nzakas commented Mar 17, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

snitin315 commented Jun 10, 2023

netlify bot commented Mar 15, 2023 •

edited