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

Commit b40236a

Browse files
Eyalmunozemilio
authored andcommitted
Update DialogDevSpec.md (#324)
1 parent 80d3f49 commit b40236a

File tree

1 file changed

+19
-26
lines changed

1 file changed

+19
-26
lines changed

specs/DialogDevSpec.md

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,14 @@ Depends on Dialog / adaptive library.
2424
Here's a brief sample of usage cases:
2525

2626
$ bf dialog
27-
$ bf dialog:merge
27+
$ bf dialog:merge ./dialogs/*
2828
$ bf dialog:verify
2929
$ bf dialog:merge -o app.schema
3030

3131

3232
## Design Specifications
3333
The command supports the adaptive dialog files in use by Composer and the rest of the adaptive dialog system. It merges disparate dialog files based on provided schema files into a single cohesive and self-referential file. Secondly, it supports validation pass to ensure the integrity of the merged file.
3434

35-
#### Glob Pattern
36-
37-
Wild card and recursive file pattern specifications do not follow common guidelines, instead, we're using the [glob (programming)](https://en.wikipedia.org/wiki/Glob_(programming)) pattern. Note: this is an exceptional pattern to the standard BF CLI. **TBD**: Can we avoid this exception and follow standard BF CLI patterns?
38-
3935
The dialog command is based on the adaptive dialog library.
4036

4137
## `bf dialog:merge [FILE]`
@@ -50,37 +46,34 @@ The dialog:verify command is used to validate that all of the .dialog file resou
5046

5147
If there are "lint" errors, the command will display detailed error information or return successful confirmation.
5248

53-
### Command Line Form
54-
USAGE
49+
#### Glob Pattern
5550

56-
$ bf
51+
Wild card and recursive file pattern specifications do not follow common guidelines, instead, we're using the [glob (programming)](https://en.wikipedia.org/wiki/Glob_(programming)) pattern. Note: this is an exceptional pattern to the standard BF CLI. **TBD**: Can we avoid this exception and follow standard BF CLI patterns?
5752

58-
​ Respects all global flags based on [Contributing Guide](https://github.com/microsoft/botframework-cli/blob/master/CONTRIBUTING.md#general-guidelines) with exception of file pattern per exception section.
53+
Otherwise, with exception of Glob file pattern, `bf dialg` respects all global flags based on [Contributing Guide](https://github.com/microsoft/botframework-cli/blob/master/CONTRIBUTING.md#general-guidelines) .
5954

6055

56+
### Command Line Form
6157

62-
$ bf dialog:merge \<options\> \<FileSpec\>
58+
```
59+
$ bf
60+
Operates on Adaptive Dialog assetts, merges, and verifies integrity of .dialog, and .schema files.
6361
64-
​ Creates a .schema file by merging component schemas and the SDK schemas
62+
$ bf dialog:merge <options> <FileSpec>
63+
Creates a .schema file by merging component schemas and the SDK schemas
6564
66-
\<options\>
65+
Where <options>:
66+
-o, --output=output Specify output path and filename for merged schema. [default: app.schema]
67+
-u, --update Update and regenerates .schema file.
6768
69+
$ bf dialog:verify <options> <FileSpec>
70+
Verifies that all of the .dialog file resources are valid based on the application schema specifications
6871
```
69-
<FileSpec> = GLOB1 [GLOB2] [GLOB3] [GLOB4] [GLOB5] [GLOB6] [GLOB7] [GLOB8] [GLOB9] where GLOB is a glob pattern
70-
-o, --output=output Specify output path and filename for merged schema. [default: app.schema]
71-
-u, --update Update and regenerates .schema file.
7272
```
73+
Where <options> include all global options (e.g. help, version)
7374
74-
75-
76-
$ bf dialog:verify \<options\> \<FileSpec\>
77-
78-
​ Verifies that all of the .dialog file resources are valid based on the application schema specifications
79-
80-
\<options\>
81-
82-
```
83-
<FileSpec> = GLOB1 [GLOB2] [GLOB3] [GLOB4] [GLOB5] [GLOB6] [GLOB7] [GLOB8] [GLOB9] where GLOB is a glob pattern
75+
Where FileSpec:
76+
GLOB1 [GLOB2] [GLOB3] [GLOB4] [GLOB5] [GLOB6] [GLOB7] [GLOB8] [GLOB9] where GLOB is a glob pattern
8477
8578
```
8679

@@ -96,4 +89,4 @@ $ bf dialog:verify \<options\> \<FileSpec\>
9689

9790
## References
9891

99-
\<any references of relevance\>
92+
\<any references of relevance\>

0 commit comments

Comments
 (0)