Stop depending on old oclif libs and migrate to @oclif/core directly #2671
Conversation
otaviojacobi
changed the title
otaviojacobi
force-pushed
the
stop-depending-on-old-oclif-libs
branch
4 times, most recently
from
efbfbf0
to
5e25d7b
Compare
| @@ -26,26 +27,6 @@ import { | |||
| } from '../../utils/messages'; | |||
| import type { BalenaSDK, PineDeferred } from 'balena-sdk'; | |||
|
|
|||
| interface FlagsDef { | |||
There was a problem hiding this comment.
@thgreasi @myarmolinsky This is one example of one of the big wins in this new version. the static "flags" types now are inffered from what you added on your flags so you get type checking working fine on your flags ("options") without manually needing to cast to what are the types of the flags
| help: void; | ||
| service?: string; // service name | ||
| } | ||
| type FlagsDef = Interfaces.InferredFlags<typeof EnvsCmd.flags>; |
There was a problem hiding this comment.
@thgreasi @myarmolinsky Also here is one example in case we need to create a function that receives the parsed type of the flags we can use the new (and very userfull) Interfaces.InferredFlags instead of manually mantaining types, we let oclif do the dirty job for us.
otaviojacobi
force-pushed
the
stop-depending-on-old-oclif-libs
branch
4 times, most recently
from
88048c5
to
7900b3c
Compare
Change-type: patch
Change-type: patch
otaviojacobi
force-pushed
the
stop-depending-on-old-oclif-libs
branch
from
7900b3c
to
77906c4
Compare
| @@ -78,6 +78,6 @@ export async function disambiguateReleaseParam( | |||
| /** | |||
| * Convert to lowercase if looks like slug | |||
| */ | |||
| export function lowercaseIfSlug(s: string) { | |||
| export async function lowercaseIfSlug(s: string) { | |||
There was a problem hiding this comment.
Do custom parsers need to be async and fail otherwise?
There was a problem hiding this comment.
Exactly. The new interface expects the return of a parse function to be a Promise
|
LGTM |
Change-type: major
Context on this PR: We are currently using @oclif/command @oclif/config and @oclif/parser libs which were all deprecated in favor of @oclif/core there are several things we get from bumping our version such as improved CLI performance and a much much better support to Typescript (which allowed us to drop several interfaces we had to manually keep).
This PR moves us away from using deprecated code. 99% of it is done following this migration guide which changes
flagstoFlagsand the whole structure ofArguments.The patches we did on @oclif/parser have been ported to @oclif/core patch. The patch on @oclif/config could be dropped as this was fixed upstream and also we could also remove one patch on oclif itself as support for windows --targets build was fixed on upstream oclif/oclif#1181 too.
There are no changes to any of the tests. There is one small change in order to make the tests run with the new @oclif/core format here
Please check the CONTRIBUTING.md file for relevant information and some
guidance. Keep in mind that the CLI is a cross-platform application that runs
on Windows, macOS and Linux. Tests will be automatically run by balena CI on
all three operating systems, but this will only help if you have added test
code that exercises the modified or added feature code.
Note that each commit message (currently only the first line) will be
automatically copied to the CHANGELOG.md file, so try writing it in a way
that describes the feature or fix for CLI users.
If there isn't a linked issue or if the linked issue doesn't quite match the
PR, please add a PR description to explain its purpose or the features that it
implements. Adding PR comments to blocks of code that aren't self explanatory
usually helps with the review process.
If the PR introduces security considerations or affects the development, build
or release process, please be sure to highlight this in the PR description.
Thank you very much for your contribution!