7cc5c4f330d47060/tiktok-sparo
1
0
Fork 0
mirror of https://github.com/tiktok/sparo.git synced 2024-11-14 19:35:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: improve sparo checkout help text

Browse source
This commit is contained in:
Cheng Liu 2024-05-24 14:13:40 -07:00
parent 08a6647636
commit ca8f0a7bf8
No known key found for this signature in database
GPG key ID: EEC8452F7DB85CD6
2 changed files with 27 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
apps/sparo-lib/src/cli/commands/checkout.ts
View file

@ -70,10 +70,23 @@ export class CheckoutCommand implements ICommand<ICheckoutCommandOptions> {
description:
'Create a new branch and start it at <start-point>; if it already exists, reset it to <start-point>'
})
.array('profile')
.default('profile', [])
.array('add-profile')
.default('add-profile', [])
.option('profile', {
describe:
'Checkout projects by specified profile(s). The profiles will be recorded and reused by other sparo commands. For example, running "sparo checkout <branch>" sparse checkout based on the reused profiles after running "git checkout"',
default: [],
type: 'array'
})
.option('add-profile', {
describe:
'Checkout projects with recorded profile(s) and the specified added profile(s). Adds the specified added profile(s) to sparo recorded profiles',
default: [],
type: 'array'
})
.option('no-profile', {
hidden: false,
describe: 'Checkout projects without any profiles and clear all recorded profiles',
type: 'boolean'
})
.option('to', {
type: 'array',
default: [],

12
build-tests/sparo-output-test/etc/checkout-help.txt
View file

@ -19,6 +19,16 @@ Options:
-b Create a new branch and start it at <start-point> [boolean]
-B Create a new branch and start it at <start-point>; if it
already exists, reset it to <start-point> [boolean]
--profile Checkout projects by specified profile(s). The profiles
will be recorded and reused by other sparo commands. For
example, running "sparo checkout <branch>" sparse checkout
based on the reused profiles after running "git checkout"
[array] [default: []]
--add-profile Checkout projects with recorded profile(s) and the
specified added profile(s). Adds the specified added
profile(s) to sparo recorded profiles [array] [default: []]
--no-profile Checkout projects without any profiles and clear all
recorded profiles [boolean]
--to Checkout projects up to (and including) project <to..>, can
be used together with option --profile/--add-profile to
form a union selection of the two options. The projects
@ -30,5 +40,3 @@ Options:
union selection of the two options. The projects selectors
here will never replace what have been checked out by
profiles [array] [default: []]
--profile [array] [default: []]
--add-profile [array] [default: []]