@microsoft/bf-generate

Generate Bot Framework Adaptive Dialogs from JSON schema.

Relevant docs

• Full documentation
• Setup & get started

Commands

• Relevant docs
• Commands
  • bf dialog:generate SCHEMA
  • bf dialog:generate:swagger PATH
  • bf dialog:generate:test TRANSCRIPT DIALOG

bf dialog:generate SCHEMA

[PREVIEW] Generate localized .lu, .lg, .qna and .dialog assets to define a bot based on a schema using templates.

[PREVIEW] Generate localized .lu, .lg, .qna and .dialog assets to define a bot based on a schema using templates.

USAGE
  $ bf dialog:generate SCHEMA

ARGUMENTS
  SCHEMA  JSON Schema file used to drive generation.

OPTIONS
  -f, --force                Force overwriting generated files.
  -h, --help                 show CLI help
  -l, --locale=locale        Locales to generate. [default: en-us]
  -o, --output=output        [default: .] Output path for where to put generated .lu, .lg, .qna and .dialog files.
  -p, --prefix=prefix        Prefix to use for generated files. [default: schema name]
  -s, --schema=schema        Path to your app.schema file.

  -t, --templates=templates  Directory with templates to use for generating assets.  With multiple directories, the
                             first definition found wins.  To include the standard templates, just use
                             "template:standard" as a template directory name.

  --debug                    Show extra debugging information including templates.

  --merge                    Merge generated results into output directory.

  --verbose                  Output verbose logging of files as they are processed

EXAMPLE

         $ bf dialog:generate sandwich.form --output c:/tmp

See code: src/commands/dialog/generate.ts

bf dialog:generate:swagger PATH

[PREVIEW] Generate JSON schema given swagger file.

[PREVIEW] Generate JSON schema given swagger file.

USAGE
  $ bf dialog:generate:swagger PATH

ARGUMENTS
  PATH  The path to the swagger file

OPTIONS
  -m, --method=method  (required) [default: GET] API method.
  -n, --name=name      (required) Define schema name.
  -o, --output=output  [default: .] Output path for generated swagger schema files. [default: .]
  -r, --route=route    (required) Route to the specific api.
  --verbose            Output verbose logging of files as they are processed.

EXAMPLE

         $ bf dialog:generate:swagger ./petSwagger.json -o . -r /store/order -m post -p dialog.response -n 
  petSearch.form

See code: src/commands/dialog/generate/swagger.ts

bf dialog:generate:test TRANSCRIPT DIALOG

[PREVIEW] Generate a .dialog test file from a .transcript file.

[PREVIEW] Generate a .dialog test file from a .transcript file.

USAGE
  $ bf dialog:generate:test TRANSCRIPT DIALOG

ARGUMENTS
  TRANSCRIPT  Transcript file to use for generating .dialog file
  DIALOG      Dialog to test.

OPTIONS
  -m, --mock           If specified, mock HttpRequest calls.
  -o, --output=output  [default: .] Output path for <transcriptName>.dialog test file.
  -s, --schema=schema  Path to app.schema file.

EXAMPLE

         $ bf dialog:test bot.transcript myBot.dialog

See code: src/commands/dialog/generate/test.ts