Tests - Generic/ESLint: fix test #436
Merged
Conversation
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
ESLint has released a new major which no longer supports the `.eslintrc.json` config format by default.
To still allow for that format, an `ESLINT_USE_FLAT_CONFIG` environment variable has to be set to `false`.
This change is causing the tests for the `Generic.Debug.ESLint` sniff to fail.
Setting the environment variable fixes this.
This is a test-only change for the following reasons:
* If end-users use this sniff, they are responsible for using the correct configuration for the version of ESLint they are using.
* The sniff is deprecated and preferably end-users should move away from using the sniff and run the tool directly.
* As the sniff is deprecated, no time has been spend to add support for the new ESLint configuration format to the sniff.
A simple patch to add this support would be accepted as long as PHPCS 4.0 has not been released yet, but maintainers will not spend time on this as the sniff will be removed sooner rather than later.
As an alternative, it was considered to limit the version of `ESLint` being installed in the GH Actions workflow to version 8 of ESlint, but the change as made now is better IMO as it proves that the ESLint sniff does still work on 9, even though only for the old configuration formats.
Refs:
* https://eslint.org/blog/2024/04/eslint-v9.0.0-released/#flat-config-is-now-the-default-and-has-some-changes
* https://eslint.org/docs/latest/use/migrate-to-9.0.0#-new-default-config-format-eslintconfigjs
|
Note that the old configuration format is scheduled to be removed completely in version 10 of eslint, so this change only works for v9 and under. |
|
@fredden Good point, though I really, really, really am hoping that we'll have PHPCS 4.0 released by that time in which these type of sniffs will be removed anyhow. ;-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
ESLint has released a new major which no longer supports the
.eslintrc.jsonconfig format by default.To still allow for that format, an
ESLINT_USE_FLAT_CONFIGenvironment variable has to be set tofalse.This change is causing the tests for the
Generic.Debug.ESLintsniff to fail.Setting the environment variable fixes this.
This is a test-only change for the following reasons:
As an alternative, it was considered to limit the version of
ESLintbeing installed in the GH Actions workflow to version 8 of ESlint, but the change as made now is better IMO as it proves that the ESLint sniff does still work on 9, even though only for the old configuration formats.Refs:
Suggested changelog entry
Maybe a note that ESLint >= 9.0 is not supported unless the "old" ESLint configuration formats are being used in combination with setting
ESLINT_USE_FLAT_CONFIG=false?