Update: Implement FlatConfigArray (refs #13481) #14321

nzakas · 2021-04-13T17:49:02Z

Prerequisites checklist

I have read the contributing guidelines.

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

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:

Implements FlatConfigArray (refs #13481)

What changes did you make? (Give an overview)

I added FlatConfigArray class and associated tests to make sure everything is working okay. FlatConfigArray is not referenced anywhere while running ESLint currently, as implementing FlatConfigArray is meant to be a standalone task. In the next task, I'll work on using it when eslint.config.js is found.

Merging this does not result in any end-user-facing changes. It will result in FlatConfigArray tests being run with npm test

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

Are there any cases I missed?
Is the code easy enough to follow? (The old config system was so complicated that the code was hard to follow, I want this version to be easier for people to look at and figure out what's going on.)

eslint-github-bot · 2021-04-13T17:49:06Z

Hi @nzakas!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag must be one of the following:

The Tag is one of the following:
- Fix - for a bug fix.
- Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
- New - implements a new feature.
- Breaking - for a backwards-incompatible enhancement or feature.
- Docs - changes to documentation only.
- Build - changes to build process only.
- Upgrade - for a dependency upgrade.
- Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).
You can use the labels of the issue you are working on to determine the best tag.
There should be a space following the initial tag and colon, for example 'New: Message'.

Read more about contributing to ESLint here

eslint-github-bot · 2021-04-13T17:49:33Z

Hi @nzakas!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag must be one of the following:

The Tag is one of the following:
- Fix - for a bug fix.
- Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
- New - implements a new feature.
- Breaking - for a backwards-incompatible enhancement or feature.
- Docs - changes to documentation only.
- Build - changes to build process only.
- Upgrade - for a dependency upgrade.
- Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).
You can use the labels of the issue you are working on to determine the best tag.
There should be a space following the initial tag and colon, for example 'New: Message'.
The first letter of the tag should be in uppercase

Read more about contributing to ESLint here

btmills

I am pleasantly surprised by how much less is going on here than in the existing config system. Outsourcing all of the file path matching to @humanwhocodes/config-array nicely separates the "what needs to be merged" logic from the "what are the rules for merging each field" logic. It's great to see the vision of a simpler config coming together 🎉

tests/lib/config/flat-config-array.js

lib/config/flat-config-schema.js

lib/config/default-config.js

lib/config/flat-config-schema.js

nzakas · 2021-04-19T18:14:01Z

I believe everything has been addressed, but let me know if I missed anything.

btmills

I just did a thorough pass through the schema to make sure everything matches up. I'm excited that we'll be able to alert users to invalid configurations as close to the source as possible with some of the checks you've added. There were a few particularly helpful ones that aren't covered by a test, so I pointed those out in case you'd like to add those. LGTM either way.

lib/config/flat-config-schema.js

lib/config/flat-config-array.js

nzakas · 2021-04-23T00:38:49Z

Nice! I’ll plan on adding tests for those.

btmills

Nice! Sorry about the false positive on a couple of those.

mdjermanovic · 2021-04-26T12:40:43Z

lib/config/default-config.js

+                rules: defaultRulesConfig
+            }
+        },
+        ignores: ["node_modules/**"],


Is this now a glob pattern, or a .gitignore-style pattern as it used to be with ignorePatterns?

If it's a glob, should it be **/node_modules/*, as an equivalent to the actual default ignore pattern /**/node_modules/*?

Also, ignoring files in the RFC specifies .git directories. Should we add a pattern for them here?

These are all glob patterns now. I’ll update them to match the current defaults.

Does it also mean that we'll interpret the content of .eslintignore file differently, depending on the format of the found eslint configuration file:

as a list of .gitignore patterns (actual behavior) if the config is .eslintrc.*.

as a list of glob patterns if the config is eslint.config.js

No. There is no change to how .eslintignore will be interpreted. It will be read and compiled into a function that is then included in a flat config ignores key. (Can be either a glob pattern or a function.)

lib/config/flat-config-array.js

lib/config/flat-config-schema.js

nzakas · 2021-04-28T17:38:04Z

Comments addressed.

mdjermanovic · 2021-04-29T12:40:04Z

@nzakas regarding #14321 (comment), isn't it the opposite (writable - correct, writeable - misspelling)?

Our documentation uses "writable", and says that "writeable" can be used for historical reasons.

lib/config/default-config.js

lib/config/flat-config-schema.js

lib/config/rule-validator.js

lib/config/flat-config-schema.js

lib/config/rule-validator.js

lib/config/flat-config-schema.js

lib/config/default-config.js

lib/config/flat-config-array.js

lib/config/rule-validator.js

nzakas · 2021-05-03T19:01:02Z

I think I've fixed everything. @mdjermanovic thanks for the amazing level of detail in your comments.

tests/lib/config/flat-config-array.js

lib/config/flat-config-schema.js

nzakas · 2021-05-07T19:00:14Z

Should be set now (hopefully).

lib/config/flat-config-schema.js

lib/config/default-config.js

lib/config/flat-config-array.js

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

mdjermanovic

LGTM!

I'm not sure if the feature of unignoring files that are ignored in the base config (or a shared config) is supported, but we can discuss that when we start integrating.

nzakas 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 feature This change adds a new feature to ESLint labels Apr 13, 2021

nzakas changed the title ~~Flat config array~~ Update: Implement FlatConfigArray (refs #13481) Apr 13, 2021

nzakas changed the title ~~Update: Implement FlatConfigArray (refs #13481)~~ Update: Implement FlatConfigArray (refs #13481) Apr 13, 2021

nzakas requested a review from a team April 13, 2021 18:44

btmills reviewed Apr 19, 2021

View reviewed changes

nzakas requested a review from mdjermanovic April 22, 2021 00:30

btmills approved these changes Apr 22, 2021

View reviewed changes

lib/config/flat-config-schema.js Show resolved Hide resolved

lib/config/flat-config-schema.js Show resolved Hide resolved

lib/config/flat-config-schema.js Show resolved Hide resolved

lib/config/flat-config-array.js Show resolved Hide resolved

btmills approved these changes Apr 24, 2021

View reviewed changes

mdjermanovic reviewed Apr 26, 2021

View reviewed changes

mdjermanovic reviewed Apr 27, 2021

View reviewed changes

lib/config/flat-config-array.js Show resolved Hide resolved

mdjermanovic reviewed Apr 28, 2021

View reviewed changes

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

mdjermanovic reviewed Apr 28, 2021

View reviewed changes

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

mdjermanovic reviewed Apr 29, 2021

View reviewed changes

mdjermanovic reviewed Apr 30, 2021

View reviewed changes

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

lib/config/rule-validator.js Outdated Show resolved Hide resolved

mdjermanovic reviewed Apr 30, 2021

View reviewed changes

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

lib/config/default-config.js Outdated Show resolved Hide resolved

lib/config/flat-config-array.js Show resolved Hide resolved

lib/config/rule-validator.js Show resolved Hide resolved

mdjermanovic reviewed May 5, 2021

View reviewed changes

tests/lib/config/flat-config-array.js Outdated Show resolved Hide resolved

mdjermanovic reviewed May 6, 2021

View reviewed changes

lib/config/flat-config-schema.js Outdated Show resolved Hide resolved

lib/config/flat-config-schema.js Show resolved Hide resolved

stephenwade reviewed May 8, 2021

View reviewed changes

lib/config/flat-config-schema.js Show resolved Hide resolved

stephenwade mentioned this pull request May 11, 2021

Chore: Remove lodash #14287

Merged

1 task

mysticatea reviewed May 11, 2021

View reviewed changes

lib/config/default-config.js Show resolved Hide resolved

lib/config/flat-config-array.js Show resolved Hide resolved

nzakas and others added 23 commits June 25, 2021 11:18

fix test

0bfe125

Update tests/lib/config/flat-config-array.js

12df97b

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

Update tests/lib/config/flat-config-array.js

c8ce1aa

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

Update tests/lib/config/flat-config-array.js

e7f7dbc

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

Update tests/lib/config/flat-config-array.js

48025f2

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

Update tests

905a5d4

fix test

b99f3af

Allow old-style plugin names

1117b31

Fix reportUnusedDisableDirectives and add JSDoc

10343ad

Add more tests

40fe618

address review comments

70af1ec

Ignore only .git directory

acabd01

Allow null for global settings

c0bbff6

writeable -> writable

210e792

Remove incorrect comment

6ba32a6

Validate severity-only rule options

b2dcefa

Add key to global error message

0ce35cf

deeply merge parserOptions and settings

553b931

Rename defaultResultConfig

adf4f2f

Normalize and fix rule validations

751352d

Fix rule options merging

b260002

Fix various errors

9acd1c2

Rebase onto master

7b66408

nzakas force-pushed the flat-config-array branch from 5986e58 to 7b66408 Compare June 25, 2021 18:27

mdjermanovic approved these changes Jun 26, 2021

View reviewed changes

mdjermanovic merged commit b08170b into master Jun 26, 2021

mdjermanovic deleted the flat-config-array branch June 26, 2021 11:33

G-Rath mentioned this pull request Sep 25, 2021

feat(expect-expect): support additionalTestBlockFunctions option jest-community/eslint-plugin-jest#850

Merged

eslint-github-bot bot locked and limited conversation to collaborators Dec 24, 2021

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 Dec 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update: Implement FlatConfigArray (refs #13481) #14321

Update: Implement FlatConfigArray (refs #13481) #14321

nzakas commented Apr 13, 2021

eslint-github-bot bot commented Apr 13, 2021

eslint-github-bot bot commented Apr 13, 2021

btmills left a comment

nzakas commented Apr 19, 2021

btmills left a comment

nzakas commented Apr 23, 2021

btmills left a comment

mdjermanovic Apr 26, 2021

nzakas Apr 27, 2021

mdjermanovic Apr 27, 2021

nzakas Apr 28, 2021

nzakas commented Apr 28, 2021

mdjermanovic commented Apr 29, 2021

nzakas commented May 3, 2021

nzakas commented May 7, 2021

mdjermanovic left a comment

Update: Implement FlatConfigArray (refs #13481) #14321

Update: Implement FlatConfigArray (refs #13481) #14321

Conversation

nzakas commented Apr 13, 2021

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?

eslint-github-bot bot commented Apr 13, 2021

eslint-github-bot bot commented Apr 13, 2021

btmills left a comment

Choose a reason for hiding this comment

nzakas commented Apr 19, 2021

btmills left a comment

Choose a reason for hiding this comment

nzakas commented Apr 23, 2021

btmills left a comment

Choose a reason for hiding this comment

mdjermanovic Apr 26, 2021

Choose a reason for hiding this comment

nzakas Apr 27, 2021

Choose a reason for hiding this comment

mdjermanovic Apr 27, 2021

Choose a reason for hiding this comment

nzakas Apr 28, 2021

Choose a reason for hiding this comment

nzakas commented Apr 28, 2021

mdjermanovic commented Apr 29, 2021

nzakas commented May 3, 2021

nzakas commented May 7, 2021

mdjermanovic left a comment

Choose a reason for hiding this comment