Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit 4b0678c

Browse files
authored
Update config plugin help flags (#276)
* Adding description to config help flags * Updating readme.md files * Fixing chatdown description
1 parent 3c30d69 commit 4b0678c

File tree

11 files changed

+36
-33
lines changed

11 files changed

+36
-33
lines changed

packages/chatdown/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ OPTIONS
2424
-h, --help Chatdown command help
2525
```
2626

27-
_See code: [src\commands\chatdown\index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/chatdown/src/commands/chatdown/index.ts)_
27+
_See code: [src/commands/chatdown/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/chatdown/src/commands/chatdown/index.ts)_
2828

2929
## `bf chatdown:convert`
3030

31-
Converts chat dialog files in <filename>.chat format into transcript file. Writes corresponding <filename>.transcript for each .chat file
31+
Converts chat dialog files in <filename>.chat format into transcript files. Writes corresponding <filename>.transcript for each .chat file.
3232

3333
```
3434
USAGE
@@ -46,7 +46,7 @@ OPTIONS
4646
4747
-p, --prefix Prefix stdout with package name.
4848
49-
-s, --static Use static timestamps when generating timestamps on activities.
49+
-s, --stamp Use static timestamps when generating timestamps on activities.
5050
5151
EXAMPLE
5252
@@ -56,5 +56,5 @@ EXAMPLE
5656
$ (echo user=Joe && [ConversationUpdate=MembersAdded=Joe]) | bf chatdown --static
5757
```
5858

59-
_See code: [src\commands\chatdown\convert.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/chatdown/src/commands/chatdown/convert.ts)_
59+
_See code: [src/commands/chatdown/convert.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/chatdown/src/commands/chatdown/convert.ts)_
6060
<!-- commandsstop -->

packages/chatdown/src/commands/chatdown/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import {Command, flags} from '@microsoft/bf-cli-command'
77

88
export default class ChatdownIndex extends Command {
9-
static description = 'Converts chat dialog files in <filename>.chat format into transcript file. Writes corresponding <filename>.transcript for each .chat file'
9+
static description = 'Converts chat dialog files in <filename>.chat format into transcript files. Writes corresponding <filename>.transcript for each .chat file.'
1010

1111
static flags: flags.Input<any> = {
1212
help: flags.help({char: 'h', description: 'Chatdown command help'})

packages/cli/README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ $ npm install -g @microsoft/botframework-cli
5858

5959
## `bf chatdown`
6060

61-
Converts chat dialog files in <filename>.chat format into transcript file. Writes corresponding <filename>.transcript for each .chat file
61+
Converts chat dialog files in <filename>.chat format into transcript files. Writes corresponding <filename>.transcript for each .chat file.
6262

6363
```
6464
USAGE
@@ -72,7 +72,7 @@ _See code: [@microsoft/bf-chatdown](https://github.com/microsoft/botframework-cl
7272

7373
## `bf chatdown:convert`
7474

75-
Converts chat dialog files in <filename>.chat format into transcript file. Writes corresponding <filename>.transcript for each .chat file
75+
Converts chat dialog files in <filename>.chat format into transcript files. Writes corresponding <filename>.transcript for each .chat file.
7676

7777
```
7878
USAGE
@@ -90,7 +90,7 @@ OPTIONS
9090
9191
-p, --prefix Prefix stdout with package name.
9292
93-
-s, --static Use static timestamps when generating timestamps on activities.
93+
-s, --stamp Use static timestamps when generating timestamps on activities.
9494
9595
EXAMPLE
9696
@@ -104,14 +104,14 @@ _See code: [@microsoft/bf-chatdown](https://github.com/microsoft/botframework-cl
104104

105105
## `bf config`
106106

107-
The config plugin allows users to configure various settings within the cli.
107+
Configure various settings within the cli.
108108

109109
```
110110
USAGE
111111
$ bf config
112112
113113
OPTIONS
114-
-h, --help show CLI help
114+
-h, --help config help
115115
```
116116

117117
_See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/index.ts)_
@@ -125,6 +125,7 @@ USAGE
125125
$ bf config:set:qnamaker
126126
127127
OPTIONS
128+
-h, --help config:set:qnamaker help
128129
--endpointKey=endpointKey QnAMaker endpointKey to be set
129130
--hostname=hostname QnAMaker hostname to be set
130131
--kbId=kbId QnAMaker kbId to be set
@@ -153,7 +154,7 @@ USAGE
153154
OPTIONS
154155
-d, --disable Disable tlemetry
155156
-e, --enable Enable tlemetry
156-
-h, --help show CLI help
157+
-h, --help config:set:telemetry help
157158
```
158159

159160
_See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/set/telemetry.ts)_
@@ -167,7 +168,7 @@ USAGE
167168
$ bf config:show
168169
169170
OPTIONS
170-
-h, --help show CLI help
171+
-h, --help config:show help
171172
```
172173

173174
_See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show.ts)_
@@ -181,7 +182,7 @@ USAGE
181182
$ bf config:show:qnamaker
182183
183184
OPTIONS
184-
-h, --help show CLI help
185+
-h, --help config:show:qnamaker help
185186
```
186187

187188
_See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show/qnamaker.ts)_
@@ -195,7 +196,7 @@ USAGE
195196
$ bf config:show:telemetry
196197
197198
OPTIONS
198-
-h, --help show CLI help
199+
-h, --help config:show:telemetry help
199200
```
200201

201202
_See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show/telemetry.ts)_
@@ -219,14 +220,14 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6
219220

220221
## `bf luis`
221222

222-
Convert, translate luis/lu files or generate source code
223+
Converts, translates luis/lu files or generates source code.
223224

224225
```
225226
USAGE
226227
$ bf luis
227228
228229
OPTIONS
229-
-h, --help Display Luis available commnads
230+
-h, --help Display Luis available commands
230231
```
231232

232233
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/tree/master/packages/lu/src/commands/luis/index.ts)_
@@ -324,7 +325,7 @@ USAGE
324325
$ bf qnamaker
325326
326327
OPTIONS
327-
-h, --help Display QnA Maker CLI available commnads
328+
-h, --help Display QnA Maker CLI available commands
328329
```
329330

330331
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/index.ts)_
@@ -384,7 +385,7 @@ _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cl
384385

385386
## `bf qnamaker:convert`
386387

387-
Convert .lu file(s) to a QnA application JSON model or vice versa
388+
Converts .lu file(s) to QnA application JSON models or vice versa.
388389

389390
```
390391
USAGE

packages/config/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@
1717

1818
## `bf config`
1919

20-
Allows users to configure various settings within the cli.
20+
Configure various settings within the cli.
2121

2222
```
2323
USAGE
2424
$ bf config
2525
2626
OPTIONS
27-
-h, --help show CLI help
27+
-h, --help config help
2828
```
2929

3030
_See code: [src/commands/config/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/index.ts)_
@@ -38,6 +38,7 @@ USAGE
3838
$ bf config:set:qnamaker
3939
4040
OPTIONS
41+
-h, --help config:set:qnamaker help
4142
--endpointKey=endpointKey QnAMaker endpointKey to be set
4243
--hostname=hostname QnAMaker hostname to be set
4344
--kbId=kbId QnAMaker kbId to be set
@@ -66,7 +67,7 @@ USAGE
6667
OPTIONS
6768
-d, --disable Disable tlemetry
6869
-e, --enable Enable tlemetry
69-
-h, --help show CLI help
70+
-h, --help config:set:telemetry help
7071
```
7172

7273
_See code: [src/commands/config/set/telemetry.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/set/telemetry.ts)_
@@ -80,7 +81,7 @@ USAGE
8081
$ bf config:show
8182
8283
OPTIONS
83-
-h, --help show CLI help
84+
-h, --help config:show help
8485
```
8586

8687
_See code: [src/commands/config/show.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show.ts)_
@@ -94,7 +95,7 @@ USAGE
9495
$ bf config:show:qnamaker
9596
9697
OPTIONS
97-
-h, --help show CLI help
98+
-h, --help config:show:qnamaker help
9899
```
99100

100101
_See code: [src/commands/config/show/qnamaker.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show/qnamaker.ts)_
@@ -108,7 +109,7 @@ USAGE
108109
$ bf config:show:telemetry
109110
110111
OPTIONS
111-
-h, --help show CLI help
112+
-h, --help config:show:telemetry help
112113
```
113114

114115
_See code: [src/commands/config/show/telemetry.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/show/telemetry.ts)_

packages/config/src/commands/config/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export default class ConfigIndex extends Command {
99
static description = 'Configure various settings within the cli.'
1010

1111
static flags = {
12-
help: flags.help({char: 'h'}),
12+
help: flags.help({char: 'h', description: 'config help'})
1313
}
1414

1515
async run() {

packages/config/src/commands/config/set/qnamaker.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export default class ConfigSetQnamaker extends Command {
1414
subscriptionKey: flags.string({description: 'QnAMaker subscriptionkey to be set'}),
1515
hostname: flags.string({description: 'QnAMaker hostname to be set'}),
1616
endpointKey: flags.string({description: 'QnAMaker endpointKey to be set'}),
17+
help: flags.help({char: 'h', description: 'config:set:qnamaker help'})
1718
}
1819

1920
static examples = [`

packages/config/src/commands/config/set/telemetry.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ export default class ConfigSetTelemetry extends Command {
1010
static description = 'Enable or disable anonymous data collection to improve the products. (Command group calls and flags usage)'
1111

1212
static flags = {
13-
help: flags.help({char: 'h'}),
1413
disable: flags.boolean({char: 'd', description: 'Disable tlemetry'}),
15-
enable: flags.boolean({char: 'e', description: 'Enable tlemetry'})
14+
enable: flags.boolean({char: 'e', description: 'Enable tlemetry'}),
15+
help: flags.help({char: 'h', description: 'config:set:telemetry help'})
1616
}
1717

1818
async run() {

packages/config/src/commands/config/show.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default class ConfigShow extends Command {
1010
static description = 'Displays the config file'
1111

1212
static flags = {
13-
help: flags.help({char: 'h'}),
13+
help: flags.help({char: 'h', description: 'config:show help'})
1414
}
1515

1616
async run() {

packages/config/src/commands/config/show/qnamaker.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default class ConfigShowQnamaker extends Command {
1010
static description = 'Display QnAMaker settings'
1111

1212
static flags = {
13-
help: flags.help({char: 'h'}),
13+
help: flags.help({char: 'h', description: 'config:show:qnamaker help'})
1414
}
1515

1616
async run() {

packages/config/src/commands/config/show/telemetry.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default class ConfigShowTelemetry extends Command {
1010
static description = 'Display telemetry settings'
1111

1212
static flags = {
13-
help: flags.help({char: 'h'}),
13+
help: flags.help({char: 'h', description: 'config:show:telemetry help'})
1414
}
1515

1616
async run() {

0 commit comments

Comments
 (0)