You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 15, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: specs/DialogDevSpec.md
+19-26Lines changed: 19 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,18 +24,14 @@ Depends on Dialog / adaptive library.
24
24
Here's a brief sample of usage cases:
25
25
26
26
$ bf dialog
27
-
$ bf dialog:merge
27
+
$ bf dialog:merge ./dialogs/*
28
28
$ bf dialog:verify
29
29
$ bf dialog:merge -o app.schema
30
30
31
31
32
32
## Design Specifications
33
33
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.
34
34
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
-
39
35
The dialog command is based on the adaptive dialog library.
40
36
41
37
## `bf dialog:merge [FILE]`
@@ -50,37 +46,34 @@ The dialog:verify command is used to validate that all of the .dialog file resou
50
46
51
47
If there are "lint" errors, the command will display detailed error information or return successful confirmation.
52
48
53
-
### Command Line Form
54
-
USAGE
49
+
#### Glob Pattern
55
50
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?
57
52
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) .
59
54
60
55
56
+
### Command Line Form
61
57
62
-
$ bf dialog:merge\<options\>\<FileSpec\>
58
+
```
59
+
$ bf
60
+
Operates on Adaptive Dialog assetts, merges, and verifies integrity of .dialog, and .schema files.
63
61
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
65
64
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.
67
68
69
+
$ bf dialog:verify <options> <FileSpec>
70
+
Verifies that all of the .dialog file resources are valid based on the application schema specifications
68
71
```
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.
72
72
```
73
+
Where <options> include all global options (e.g. help, version)
73
74
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
0 commit comments