Skip to content

Commit b959a7a

Browse files
gonzaloriestragonzaloriestra
authored
Merge pull request #5324 from Shopify/upgrade-oclif
Upgrade oclif
2 parents 9cbdfb7 + 71155f4 commit b959a7a

File tree

11 files changed

+838
-1353
lines changed

11 files changed

+838
-1353
lines changed

‎docs-shopify.dev/commands/commands.doc.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
33

44
const data: ReferenceEntityTemplateSchema = {
55
name: 'commands',
6-
description: `list all the commands`,
7-
overviewPreviewDescription: `list all the commands`,
6+
description: `List all <%= config.bin %> commands.`,
7+
overviewPreviewDescription: `List all <%= config.bin %> commands.`,
88
type: 'command',
99
isVisualComponent: false,
1010
defaultExample: {

‎docs-shopify.dev/commands/interfaces/commands.interface.ts‎

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
11
// This is an autogenerated file. Don't edit this file manually.
22
export interface commands {
33
/**
4-
* only show provided columns (comma-separated)
4+
* Only show provided columns (comma-separated).
55
*
66
*/
7-
'--columns <value>'?: string
7+
'-c, --columns <value>'?: string
88

99
/**
10-
* output is csv format [alias: --output=csv]
11-
*
12-
*/
13-
'--csv'?: ''
14-
15-
/**
16-
* show deprecated commands
10+
* Show deprecated commands.
1711
*
1812
*/
1913
'--deprecated'?: ''
2014

2115
/**
22-
* show extra columns
16+
* Show extra columns.
2317
*
2418
*/
2519
'-x, --extended'?: ''
2620

2721
/**
28-
* filter property by partial string matching, ex: name=foo
29-
*
30-
*/
31-
'--filter <value>'?: string
32-
33-
/**
34-
* Show CLI help.
35-
*
36-
*/
37-
'-h, --help'?: ''
38-
39-
/**
40-
* show hidden commands
22+
* Show hidden commands.
4123
*
4224
*/
4325
'--hidden'?: ''
@@ -49,31 +31,19 @@ export interface commands {
4931
'--json'?: ''
5032

5133
/**
52-
* hide table header from output
53-
*
54-
*/
55-
'--no-header'?: ''
56-
57-
/**
58-
* do not truncate output to fit screen
34+
* Do not truncate output.
5935
*
6036
*/
6137
'--no-truncate'?: ''
6238

6339
/**
64-
* output in a more machine friendly format
65-
*
66-
*/
67-
'--output <value>'?: string
68-
69-
/**
70-
* property to sort by (prepend '-' for descending)
40+
* Property to sort by.
7141
*
7242
*/
7343
'--sort <value>'?: string
7444

7545
/**
76-
* show tree of commands
46+
* Show tree of commands.
7747
*
7848
*/
7949
'--tree'?: ''

‎docs-shopify.dev/generated/generated_docs_data.json‎

Lines changed: 12 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2332,8 +2332,8 @@
23322332
},
23332333
{
23342334
"name": "commands",
2335-
"description": "list all the commands",
2336-
"overviewPreviewDescription": "list all the commands",
2335+
"description": "List all <%= config.bin %> commands.",
2336+
"overviewPreviewDescription": "List all <%= config.bin %> commands.",
23372337
"type": "command",
23382338
"isVisualComponent": false,
23392339
"defaultExample": {
@@ -2359,44 +2359,20 @@
23592359
"name": "commands",
23602360
"description": "",
23612361
"members": [
2362-
{
2363-
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
2364-
"syntaxKind": "PropertySignature",
2365-
"name": "--columns <value>",
2366-
"value": "string",
2367-
"description": "only show provided columns (comma-separated)",
2368-
"isOptional": true
2369-
},
2370-
{
2371-
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
2372-
"syntaxKind": "PropertySignature",
2373-
"name": "--csv",
2374-
"value": "\"\"",
2375-
"description": "output is csv format [alias: --output=csv]",
2376-
"isOptional": true
2377-
},
23782362
{
23792363
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
23802364
"syntaxKind": "PropertySignature",
23812365
"name": "--deprecated",
23822366
"value": "\"\"",
2383-
"description": "show deprecated commands",
2384-
"isOptional": true
2385-
},
2386-
{
2387-
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
2388-
"syntaxKind": "PropertySignature",
2389-
"name": "--filter <value>",
2390-
"value": "string",
2391-
"description": "filter property by partial string matching, ex: name=foo",
2367+
"description": "Show deprecated commands.",
23922368
"isOptional": true
23932369
},
23942370
{
23952371
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
23962372
"syntaxKind": "PropertySignature",
23972373
"name": "--hidden",
23982374
"value": "\"\"",
2399-
"description": "show hidden commands",
2375+
"description": "Show hidden commands.",
24002376
"isOptional": true
24012377
},
24022378
{
@@ -2407,64 +2383,48 @@
24072383
"description": "Format output as json.",
24082384
"isOptional": true
24092385
},
2410-
{
2411-
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
2412-
"syntaxKind": "PropertySignature",
2413-
"name": "--no-header",
2414-
"value": "\"\"",
2415-
"description": "hide table header from output",
2416-
"isOptional": true
2417-
},
24182386
{
24192387
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
24202388
"syntaxKind": "PropertySignature",
24212389
"name": "--no-truncate",
24222390
"value": "\"\"",
2423-
"description": "do not truncate output to fit screen",
2424-
"isOptional": true
2425-
},
2426-
{
2427-
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
2428-
"syntaxKind": "PropertySignature",
2429-
"name": "--output <value>",
2430-
"value": "string",
2431-
"description": "output in a more machine friendly format",
2391+
"description": "Do not truncate output.",
24322392
"isOptional": true
24332393
},
24342394
{
24352395
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
24362396
"syntaxKind": "PropertySignature",
24372397
"name": "--sort <value>",
24382398
"value": "string",
2439-
"description": "property to sort by (prepend '-' for descending)",
2399+
"description": "Property to sort by.",
24402400
"isOptional": true
24412401
},
24422402
{
24432403
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
24442404
"syntaxKind": "PropertySignature",
24452405
"name": "--tree",
24462406
"value": "\"\"",
2447-
"description": "show tree of commands",
2407+
"description": "Show tree of commands.",
24482408
"isOptional": true
24492409
},
24502410
{
24512411
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
24522412
"syntaxKind": "PropertySignature",
2453-
"name": "-h, --help",
2454-
"value": "\"\"",
2455-
"description": "Show CLI help.",
2413+
"name": "-c, --columns <value>",
2414+
"value": "string",
2415+
"description": "Only show provided columns (comma-separated).",
24562416
"isOptional": true
24572417
},
24582418
{
24592419
"filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
24602420
"syntaxKind": "PropertySignature",
24612421
"name": "-x, --extended",
24622422
"value": "\"\"",
2463-
"description": "show extra columns",
2423+
"description": "Show extra columns.",
24642424
"isOptional": true
24652425
}
24662426
],
2467-
"value": "export interface commands {\n /**\n * only show provided columns (comma-separated)\n *\n */\n '--columns <value>'?: string\n\n /**\n * output is csv format [alias: --output=csv]\n *\n */\n '--csv'?: ''\n\n /**\n * show deprecated commands\n *\n */\n '--deprecated'?: ''\n\n /**\n * show extra columns\n *\n */\n '-x, --extended'?: ''\n\n /**\n * filter property by partial string matching, ex: name=foo\n *\n */\n '--filter <value>'?: string\n\n /**\n * Show CLI help.\n *\n */\n '-h, --help'?: ''\n\n /**\n * show hidden commands\n *\n */\n '--hidden'?: ''\n\n /**\n * Format output as json.\n *\n */\n '--json'?: ''\n\n /**\n * hide table header from output\n *\n */\n '--no-header'?: ''\n\n /**\n * do not truncate output to fit screen\n *\n */\n '--no-truncate'?: ''\n\n /**\n * output in a more machine friendly format\n *\n */\n '--output <value>'?: string\n\n /**\n * property to sort by (prepend '-' for descending)\n *\n */\n '--sort <value>'?: string\n\n /**\n * show tree of commands\n *\n */\n '--tree'?: ''\n}"
2427+
"value": "export interface commands {\n /**\n * Only show provided columns (comma-separated).\n *\n */\n '-c, --columns <value>'?: string\n\n /**\n * Show deprecated commands.\n *\n */\n '--deprecated'?: ''\n\n /**\n * Show extra columns.\n *\n */\n '-x, --extended'?: ''\n\n /**\n * Show hidden commands.\n *\n */\n '--hidden'?: ''\n\n /**\n * Format output as json.\n *\n */\n '--json'?: ''\n\n /**\n * Do not truncate output.\n *\n */\n '--no-truncate'?: ''\n\n /**\n * Property to sort by.\n *\n */\n '--sort <value>'?: string\n\n /**\n * Show tree of commands.\n *\n */\n '--tree'?: ''\n}"
24682428
}
24692429
}
24702430
}

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"liquidjs": "10.20.1",
6969
"node-fetch": "^3.3.2",
7070
"nx": "19.8.14",
71-
"oclif": "4.6.1",
71+
"oclif": "4.11.3",
7272
"octokit-plugin-create-pull-request": "^3.12.2",
7373
"pathe": "1.1.1",
7474
"pin-github-action": "^1.8.0",

‎packages/cli/README.md‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -771,33 +771,29 @@ DESCRIPTION
771771

772772
## `shopify commands`
773773

774-
list all the commands
774+
List all shopify commands.
775775

776776
```
777777
USAGE
778-
$ shopify commands [--columns <value> | -x] [--deprecated] [--filter <value>] [-h] [--hidden] [--json]
779-
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>] [--tree]
778+
$ shopify commands [-c id|plugin|summary|type | --tree] [--deprecated] [-x | ] [--hidden] [--json]
779+
[--no-truncate | ] [--sort id|plugin|summary|type | ]
780780
781781
FLAGS
782-
-h, --help Show CLI help.
783-
-x, --extended show extra columns
784-
--columns=<value> only show provided columns (comma-separated)
785-
--csv output is csv format [alias: --output=csv]
786-
--deprecated show deprecated commands
787-
--filter=<value> filter property by partial string matching, ex: name=foo
788-
--hidden show hidden commands
789-
--no-header hide table header from output
790-
--no-truncate do not truncate output to fit screen
791-
--output=<option> output in a more machine friendly format
792-
<options: csv|json|yaml>
793-
--sort=<value> property to sort by (prepend '-' for descending)
794-
--tree show tree of commands
782+
-c, --columns=<option>... Only show provided columns (comma-separated).
783+
<options: id|plugin|summary|type>
784+
-x, --extended Show extra columns.
785+
--deprecated Show deprecated commands.
786+
--hidden Show hidden commands.
787+
--no-truncate Do not truncate output.
788+
--sort=<option> [default: id] Property to sort by.
789+
<options: id|plugin|summary|type>
790+
--tree Show tree of commands.
795791
796792
GLOBAL FLAGS
797793
--json Format output as json.
798794
799795
DESCRIPTION
800-
list all the commands
796+
List all shopify commands.
801797
```
802798

803799
## `shopify config autocorrect off`
@@ -1559,6 +1555,7 @@ FLAGS
15591555
15601556
DESCRIPTION
15611557
Links a plugin into the CLI for development.
1558+
15621559
Installation of a linked plugin will override a user-installed or core plugin.
15631560
15641561
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'

0 commit comments

Comments
 (0)