Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Better error message for flat config plugins (#17399)
* feat: Better error message for flat config plugins Refs #17370 * Update docs/src/use/configure/migration-guide.md Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update extended error message * Update docs/src/use/configure/migration-guide.md Co-authored-by: Francesco Trotta <github@fasttime.org> --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> Co-authored-by: Francesco Trotta <github@fasttime.org>
- Loading branch information
1 parent
6d6dc51
commit 8ca8b50
Showing
4 changed files
with
93 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
"use strict"; | ||
|
||
module.exports = function({ plugins }) { | ||
|
||
const isArrayOfStrings = typeof plugins[0] === "string"; | ||
|
||
return ` | ||
A config object has a "plugins" key defined as an array${isArrayOfStrings ? " of strings" : ""}. | ||
Flat config requires "plugins" to be an object in this form: | ||
{ | ||
plugins: { | ||
${isArrayOfStrings && plugins[0] ? plugins[0] : "namespace"}: pluginObject | ||
} | ||
} | ||
Please see the following page for information on how to convert your config object into the correct format: | ||
https://eslint.org/docs/latest/use/configure/migration-guide#importing-plugins-and-custom-parsers | ||
If you're using a shareable config that you cannot rewrite in flat config format, then use the compatibility utility: | ||
https://eslint.org/docs/latest/use/configure/migration-guide#using-eslintrc-configs-in-flat-config | ||
`; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters