This repository has been archived by the owner on Nov 20, 2023. It is now read-only.
feat(options): Allow include to be an object
#299
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
AbhiPrasad
approved these changes
Aug 3, 2021
lobsterkatie
added a commit
that referenced
this pull request
Aug 5, 2021
…pes (#302) There are three places where this plugin is more permissive in its option types than its underlying `@sentry/cli` dependency: - `include` option: Can be given as a single path (either in string or descriptor object form) here, but must be an array for `@sentry/cli` - `ignore` option: Can be given as a single path (a string) here, but must be an array for `@sentry/cli` - `ignore` option in `include` descriptor object: Can be given as a single path (a string) here, but must be an array for `@sentry/cli` In other words, any of the following would. be fine for this plugin, but none would be okay for `@sentry/cli`: ``` const options = { include: "This needs to be wrapped in an array", ignore: "So does this", }; const differentOptions = { include: { paths: ["This whole object needs to be wrapped in an array"] }, }; const evenMoreOptions = { include: [ { paths: ["This overall `include` option is fine"], ignore: "But this `ignore` option needs wrapping", }, ], }; ``` To compensate for this, we normalize the plugin options, fixing each of the problems detailed in the example, before we pass them to `@sentry/cli`. At least, that's what we're supposed to do. The possible problems and combinations of problems got more complicated when descriptor object `include` values were introduced in #299, and some of them were overlooked. This should fix that problem, as well as expand the tests to cover all scenarios. There also is currently a (related) problem with our types, which predates the aforementioned PR. In the types file here, we've been inheriting the `include` and `ignore` types from `@sentry/cli`, even though those types are (theoretically) more permissive here than they are there. This also fixes that problem, redefining those types to include the looser options.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 mirrors the change in getsentry/sentry-cli#1001, which allows for path-specific options to be passed as part of the
includeoption value. Specifically, this:includeoption to account for the new possibility of it being an object, and of theignoreoption within that objecttoArray()so that falsy (but defined) values aren't ignored. We don't actually ever use it in a way which would make this an issue, but it seemed silly to leave the bug in place when the fix was so simple.