@gewoonmaarten/dialogtracker v1.0.0-preview

NOTE: This is a preview tool and breaking changes may happen before it is released.

This tool is for working with Bot Framework SDK 4.5 preview .dialog files

DialogTracker

This library allows reading, validating, indexing, modifying and writing Bot Framework .schema, .dialog and .lg files utilizing an in-memory cache. It reads in dialog files and captures errors in them so that they can be presented as issues to be fixed. It also provides indexing to help tools maniuplate the information in the files. It builds an index of .dialog components and how they relate to each other using $type, $role, $id and $copy. It captures:

• Missing $type: A valid component must include a $type.
• Multiple $id definitions: There should be only one definition for a $id.
• Incompatible types between $copy and $id:
• Undefined $id
• Schema validation: Reports JSON schema validation errors.
• Malformed JSON: Reports files which do not contain valid JSON.
• Multiple definitions of .lg template references: References to definitions show up in this format TYPE[ID](file#/path).

Using

The main class is the DialogTracker class which supports reading, updating, writing and indexing dialog files with both schema and semantic validation. The DialogLint tool shows an example of how to use the tracker to read in files and report various kinds of errors.

Prerequisite

• Node.js version 8.5 or higher

Installation

To install using npm:

npm install -g dialogLint

This will install dialogLint into your global path.

To uninstall using npm:

npm uninstall -g dialogLint

Nightly builds

Nightly builds are based on the latest development code which means they may or may not be stable and probably won't be documented. These builds are better suited for more experienced users and developers although everyone is welcome to give them a shot and provide feedback.

You can get the latest nightly build of DialogLint from the BotBuilder MyGet feed. To install the nightly -

npm config set registry https://botbuilder.myget.org/F/botbuilder-tools-daily/npm/

Install using npm:

npm i -g msbot

To reset registry:

npm config set registry https://registry.npmjs.org/