Re-export as Stubscape from shescape/testing
#1308
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
Simplify importing the default stub implementation of Shescape as `Stubscape` by re-exporting it under that name. As of writing, I'm not sure whether exporting this stub as `Shescape` or `Stubscape` is better. I think both have pros and cons. In any case, the export named `Shescape` can't just be removed because that would be a breaking change.
github-actions
bot
added
documentation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1308 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 16 16
Lines 1492 1507 +15
=========================================
+ Hits 1492 1507 +15
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Avoid vetting error by knip by marking `Stubscape` as an alias of `Shescape` in its documentation. Besides making knip happy, this also makes the re-export more explicit and hopefully clear in context. To support this, `Shescape` was renamed to `Stubscape` and `Shescape` now re-exports `Shescape`. This makes semantic sense (I want `Stubscape` to be the "correct" export, and `Shescape` an alias for backwards compatibility), but is also required as the (at)alias tag needs to be on the re-exporting expression for knip to accept it.
Add `Stubscape` export to testing.d.ts and align documentation with corresponding testing.js code.
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.
Relates to #710
Summary
Simplify importing the default stub implementation of Shescape as
Stubscapeby re-exporting it under that name.As of writing, I'm not sure whether exporting this stub as
ShescapeorStubscapeis better. I think both have pros and cons. In any case, the export namedShescapecan't just be removed because that would be a breaking change.