Added JSDoc to @codemod-utils/files #77
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
ijlee2
added
enhance: documentation
This was referenced Oct 5, 2023
Merged
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
I added JSDoc to
@codemod-utils/filesso that end-developers have an additional source for learning, besides the package'sREADME.mdand tests (both are unavailable offline) as well as its provided types (requires some familiarity with TypeScript). In addition, I updated theREADME.mdto show more simple examples.Note, the
breakinglabel is due tounionize()being deprecated (it will be removed later).Screenshots
Before:
After: