Skip to content

docs: how to author plugins with configs that extend other configs#18753

Merged
nzakas merged 3 commits intoeslint:mainfrom
alecgibson:plugin-migration-docs
Aug 7, 2024
Merged

docs: how to author plugins with configs that extend other configs#18753
nzakas merged 3 commits intoeslint:mainfrom
alecgibson:plugin-migration-docs

Conversation

@alecgibson
Copy link
Copy Markdown
Contributor

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)

It's not immediately clear from the current documentation how authors should migrate configs that extend other configs.

According to the full documentation, an array is actually expected, which isn't clear in the migration documentation.

This change updates the documentation to include an array example, and links back to the full documentation.

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

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

4 participants