Fix issue #498 - c8 CLI doesn't work properly when executed in a sub-directory of the project #539
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
bcoe
reviewed
Jun 26, 2024
| output.toString('utf8').should.matchSnapshot() | ||
| }) | ||
| }) | ||
| describe('--all', () => { |
There was a problem hiding this comment.
I'm concerned about removing so many tests in this PR.
|
@ericmorand I understand where you're coming from, but this breaking change would be pretty drastic, and I don't have the time to put into open source these days to support it. Could we instead figure out how to make |
|
@bcoe , your point is fair and I actually agree that this is too much of a drastic change, even for a breaking change: this is like a different product. I'll probably end up proposing a dedicated package - heavily inspired by your great work. I think we can close this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR fixes the issue #498...and also change the philosophy of c8.
The fix
This PR makes c8 consider the
includeandexcludepatterns as relative to the configuration file location, if any, or the current working directory, otherwise. By applying such a change, c8 can be executed from any subdirectory of the project and will always resolve sources to include and exclude regardless of the current working directory, if a configuration file is present.The philosophy shift
c8 philosophy seems to have been heavily inspired by nyc, which means that it inherits from nyc debatable (and arguably archaic) design decisions. These decisions can be summarized this way:
Options
src,include,exclude,extension,excludeNodeModules,allowExternalandallare overlapping and can be reduced to onlyincludeandexcludewithout removing any feature.This PR removes all the mentioned options except
includeandexclude, and updates the logic so that all the removed options are organically available through theincludeandexcludeoptions.Let's see how it goes.
--src
This option is overlapping with the
includeoption, which is the declaration of the files that we want to be covered by the tests:--extension
This option is overlapping with the
includeoption, which is the declaration of the files that we want to be covered by the tests:Or:
--allowExternal
This option is overlapping with the
includeoption, which is the declaration of the files that we want to be covered by the tests:--excludeNodeModules
This option is overlapping with the
excludeoption, which is the declaration of the files that we don't want to be covered by the tests:--all
This option is overlapping with the
includeandexcludeoptions, would we want to not include all of them, it is possible through a combination ofincludeandexclude:This is obviously a breaking change.