refactor: clean up helper functions and types #377
Merged
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
🦋 Changeset detectedLatest commit: 629bb60 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Sitlintac
approved these changes
Aug 16, 2022
* make the `Sorting` interface generic, dependent on the type of the object being sorted (this was the key to removing the need for the `ts-ignore` comments in `command-util.ts`) * changed type of `primaryKeyName` and `sortingKeyName` for `Sorting` interface to constrain them to string keys from the object being sorted * this also necessitated adding types to `config` instances throughout the CLI passed into these functions and a bit of other type-related updates to some commands * add `extends object` constraint to objects handled by command helper functions * rename `outputListing` to `outputItemOrList` and `outputListingGeneric` to `outputItemOrListGeneric` (updated note about renaming them to a note about combining them) * update/add config types for command helper functions with consistent naming (`InputAndOutputItemConfig` for `inputAndOutputItem`, `FormatAndWriteItemConfig` for `formatAndWriteItem`, etc.)
rossiam
force-pushed
the
helper-function-cleanup
branch
from
1234578 to
629bb60
Compare
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.
Sortinginterface generic, dependent on the type of the object being sorted (this was the key to removing the need for thets-ignorecomments incommand-util.ts)primaryKeyNameandsortingKeyNameforSortinginterface to constrain them to string keys from the object being sortedconfiginstances throughout the CLI passed into these functions and a bit of other type-related updates to some commandsextends objectconstraint to objects handled by command helper functionsoutputListingtooutputItemOrListandoutputListingGenerictooutputItemOrListGeneric(updated note about renaming them to a note about combining them)InputAndOutputItemConfigforinputAndOutputItem,FormatAndWriteItemConfigforformatAndWriteItem, etc.)Checklist
npm run lintproduces no warnings/errors)