Make editorconfig-checker exclude regexes explicit #139
Conversation
This file contains hidden or 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
The repository doesn't have any project-specific configurations for the editorconfig-checker tool, so the stock "template" `.ecrc` file can be used. This should be kept in sync automatically via the `config:sync` task and the "Check Configuration Files Sync" workflow.
The `Exclude` array in the `.ecrc` configuration file contains the regular expressions of paths that should be excluded from checking by the editorconfig-checker tool. Previously, the "template" file contained a list of filenames that should always be ignored. Although it did work, it was not really correct because the `.` in the filename is actually a regex wildcard, which is not what was intended. Although a false match was unlikely, this also might mislead users adding project-specific exclusions to the file regarding the nature of the exclude patterns. Changing to very explicit patterns avoids any chance of false matches and also makes it clear that these are regexes.
per1234
added
type: imperfection
umbynos
approved these changes
Aug 16, 2021
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.
The
Excludearray in the.ecrcconfiguration file contains the regular expressions of paths that should be excluded from checking by the editorconfig-checker tool.Previously, the "template" file contained a list of filenames that should always be ignored. Although it worked, it was not really correct because the
.in the filename is actually a regex wildcard, which is not what was intended. Although a false match was unlikely, this also might mislead users adding project-specific exclusions to the file regarding the nature of the exclude patterns. Changing to very explicit patterns avoids any chance of false matches and also makes it clear that these are regexes.