Skip to content

Commit 9c7789b

Browse files
committed
docs: document combinable and only options
1 parent 3c73789 commit 9c7789b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/flags.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,16 @@ static flags = {
5959
dependsOn: ['extra-flag'], // this flag requires another flag
6060
exclusive: ['extra-flag'], // this flag cannot be specified alongside this other flag
6161
exactlyOne: ['extra-flag', 'another-flag'], // exactly one of these flags must be provided
62+
compatible: ['extra-flag'], // this flag can ONLY be used in combination with the provided flags
6263
relationships: [ // define complex relationships between flags
6364
// Make this flag dependent on all of these flags
6465
{type: 'all', flags: ['flag-one', 'flag-two']}
6566
// Make this flag dependent on at least one of these flags
6667
{type: 'some', flags: ['flag-three', 'flag-four']}
6768
// Make this flag exclusive of all these flags
6869
{type: 'none', flags: ['flag-five', 'flag-six']}
70+
// Make this only compatible with these flags
71+
{type: 'only', flags: ['flag-one', 'flag-two']}
6972

7073
// Make this flag dependent on all of these flags
7174
{type: 'all', flags: [

0 commit comments

Comments
 (0)