refactor: reuse command types/utils across packages #6441
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
nflaig
commented
Feb 16, 2024
| @@ -49,6 +49,7 @@ | |||
| "devDependencies": { | |||
| "@types/js-yaml": "^4.0.5", | |||
| "@types/triple-beam": "^1.3.2", | |||
| "@types/yargs": "^17.0.24", | |||
There was a problem hiding this comment.
I added yargs types as dev dependency to the package as I want to avoid having this as a dependency but this might lead to the case where yargs types result in any if the consuming project does not install them.
e.g. something like this would not throw an type error
registerCommandToYargs({}, { command: "", describe: "" });but if you install @types/yargs as dependency in that project it will complain that first param is not correct
Argument of type '{}' is not assignable to parameter of type 'Argv<{}>'.
Type '{}' is missing the following properties from type 'Argv<{}>': alias, argv, array, boolean, and 66 more.ts(2345Since this is just an edge use case and all our packages have the types installed, I opted for not adding types as a dependency.
There was a problem hiding this comment.
It's find to add types as dev dependency. If we are reexporting the types from this package then we may try duplicating those for now in our source.
There was a problem hiding this comment.
I don't think duplicating types for this use case makes sense, and consumers can always install the types if they want to.
nazarhussain
requested changes
Feb 16, 2024
| @@ -2,6 +2,7 @@ export * from "./yaml/index.js"; | |||
| export * from "./assert.js"; | |||
| export * from "./base64.js"; | |||
| export * from "./bytes.js"; | |||
| export * from "./command.js"; | |||
There was a problem hiding this comment.
The @lodestar/utils package is integral to be used in lightclient and prover. So would be nice if it remains browser compatible and adding yargs and CLI utils may break the bundlers.
We should try to export Node.js specific utils from a different names export and avoid from default export. May be @lodestar/utils/cli could be an option.
There was a problem hiding this comment.
These are just types, and a utils function which takes in yargs as an argument. I don't see a reason why we would have to export this separately
There was a problem hiding this comment.
We should try to export Node.js specific utils from a different names export and avoid from default export. May be @lodestar/utils/cli could be an option.
I do agree that this is something we should consider, we already use this pattern in the api package.
But for the changes in this PR it is not relevant as it only adds shared types, there is no risk of breaking browser compatibility
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6441 +/- ##
============================================
+ Coverage 61.70% 61.72% +0.01%
============================================
Files 553 554 +1
Lines 57848 57939 +91
Branches 1829 1829
============================================
+ Hits 35696 35763 +67
- Misses 22115 22139 +24
Partials 37 37 |
nflaig
commented
Feb 16, 2024
| @@ -51,7 +52,6 @@ export const exportCmd: CliCommand<ExportArgs, ISlashingProtectionArgs & Account | |||
|
|
|||
| handler: async (args) => { | |||
| const {file} = args; | |||
| if (!file) throw new YargsError("must provide file arg"); | |||
There was a problem hiding this comment.
demandOption: true already ensures that a file arg is provided
| @@ -49,6 +49,7 @@ | |||
| "devDependencies": { | |||
| "@types/js-yaml": "^4.0.5", | |||
| "@types/triple-beam": "^1.3.2", | |||
| "@types/yargs": "^17.0.24", | |||
There was a problem hiding this comment.
I don't think duplicating types for this use case makes sense, and consumers can always install the types if they want to.
| @@ -2,6 +2,7 @@ export * from "./yaml/index.js"; | |||
| export * from "./assert.js"; | |||
| export * from "./base64.js"; | |||
| export * from "./bytes.js"; | |||
| export * from "./command.js"; | |||
There was a problem hiding this comment.
We should try to export Node.js specific utils from a different names export and avoid from default export. May be @lodestar/utils/cli could be an option.
I do agree that this is something we should consider, we already use this pattern in the api package.
But for the changes in this PR it is not relevant as it only adds shared types, there is no risk of breaking browser compatibility
Performance Report✔️ no performance regression detected Full benchmark results
|
nazarhussain
approved these changes
Feb 22, 2024
|
🎉 This PR is included in v1.17.0 🎉 |
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.
Motivation
Noticed we copy-pasted command types/utils in different packages but we only really maintain the ones in the CLI package.
This PR aims to consolidate types by moving those into the utils package to improve consistency and reduce future maintenance.
Description
@lodestar/utilspackagedemandOption: true) if arg must be provided instead of checking separately