Merge pull request #1 from microsoft/emimunoz/cli-tools

chatdown plugin and bf cli

Author: cleemullins

.gitignore

@@ -59,3 +59,5 @@ typings/
 
 # next.js build output
 .next
+
+.DS_Store

lerna.json

@@ -0,0 +1,6 @@
+{
+  "packages": [
+    "packages/*"
+  ],
+  "version": "0.0.0"
+}

package.json

@@ -0,0 +1,7 @@
+{
+  "name": "root",
+  "private": true,
+  "devDependencies": {
+    "lerna": "^3.13.4"
+  }
+}

packages/.DS_Store

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

packages/chatdown/.DS_Store

@@ -0,0 +1,8 @@
+*-debug.log
+*-error.log
+/.nyc_output
+/dist
+/lib
+/tmp
+/yarn.lock
+node_modules

packages/chatdown/.editorconfig

@@ -0,0 +1,254 @@
+bf-chatdown
+========
+
+Tool for parsing chat files and outputting replayable activities
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/chatdown.svg)](https://npmjs.org/package/bf-chatdown)
+[![Downloads/week](https://img.shields.io/npm/dw/chatdown.svg)](https://npmjs.org/package/bf-chatdown)
+[![License](https://img.shields.io/npm/l/chatdown.svg)](https://github.com/Microsoft/chatdown/blob/master/package.json)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g chatdown
+$ bf COMMAND
+running command...
+$ bf (-v|--version|version)
+chatdown/1.2.3 darwin-x64 node-v12.1.0
+$ bf --help [COMMAND]
+USAGE
+  $ bf COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`bf chatdown [chat]`](#bf-chatdown-chat)
+
+## `bf chatdown [chat]`
+
+Chatdown is a transcript generator which consumes a .chat file to generate mock transcripts. Generated mock transcript files are output to stdout.
+
+A good bot, just like any successful application or a website, starts with clarity on supported scenarios. Creating mockups of conversations between bot and user is useful for:
+
+Framing the scenarios supported by the bot.
+Business decision makers to review, provide feedback.
+Defining a "happy path" (as well as other paths) through conversational flows between a user and a bot
+.chat file format helps you create mockups of conversations between a user and a bot. Chatdown CLI tool converts .chat files into conversation transcripts (.transcript files) that can be viewed in the Bot Framework Emulator.
+
+```
+USAGE
+  $ bf chatdown [CHAT]
+
+ARGUMENTS
+  CHAT  The path of the chat file to be parsed. If omitted, stdin will be used.
+
+OPTIONS
+  -h, --help  show CLI help
+  --static    Use static timestamps when generating timestamps on activities.
+```
+## .chat File Format
+
+Here's an example `.chat` file:
+
+```markdown
+user=Joe
+bot=LulaBot
+
+bot: Hi!
+user: yo!
+bot: [Typing][Delay=3000]
+Greetings!
+What would you like to do?
+* update - You can update your account
+* List - You can list your data
+* help - you can get help
+
+user: I need the bot framework logo.
+
+bot:
+Here you go.
+[Attachment=bot-framework.png]
+[Attachment=http://yahoo.com/bot-framework.png]
+[AttachmentLayout=carousel]
+
+user: thanks
+bot:
+Here's a form for you
+[Attachment=card.json adaptivecard]
+
+```
+
+> See the [Examples](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/Chatdown/Examples) folder for more samples.
+
+
+Chat files are markdown files that contain 2 parts:
+- Header that defines who the participants are in the conversation
+- Back and forth conversation between a user and a bot
+
+### Header
+The header defines who the participants are in the conversation and defines other options.
+
+|Option               |Description|
+|---------------------|------------------------------|
+|`user=<user>` |This option tells chatdown that a user message will begin with `<user>` followed by a colon. For example, `user=Joe` instructs chatdown that lines beginning with `Joe:` or `user:` are the start of a message from the user Joe. |
+|`users=<user1>,<user2>,<user3>` |This option tells chatdown that there are multiple users in the conversation. |
+|`bot=<bot>` | This options tells chatdown that a bot message will begin with `<bot>` followed by a colon.  For example, `bot=LulaBot` instructs chadown that lines beginning with `LulaBot:` or `bot:` are the start of a message from the bot Lulabot. |
+| `channelId=<channelID>`| This option tells chatdown to use the specified `channelID` for each activity.|
+
+Once the configuration options for `users` and `bot` are defined, the rest of the conversation can use the alias prefixes `user:` and `bot:` or the names directly.  Chatdown will correctly make the associations to the specified names for you.
+
+> The Bot will default to sending to the first user in the users list or  the last user it received a message from, unless you directly specify a target user by using the bot->user: syntax.
+
+For example:
+```markdown
+users=Joe,Fred
+
+bot: This will go to Joe, because he's first in the list
+Fred: What about me?
+bot: This will go to Fred, because he's the latest user to talk to the bot
+bot->Joe: This will always go to Joe
+bot->Fred: This will always go to Fred
+```
+
+### Conversation
+The conversation between the user and the bot with markdown support for bot's responses. Every time a `user:` or `bot:`  is found at the beginning of the line, a new activity will be inserted into the transcript.  Inside the markdown, you can insert commands to generate richer transcripts:
+
+### Activity commands
+| Command        | Description                                                |
+| --------------- | ------------------------------------------------------------ |
+|`[Typing]` | Inserts a typing activity into the transcript to signify that a user or a bot is typing. |
+|`[Delay=<milliseconds>]` | Delays the transcript by `<milliseconds>`. |
+|`[ConversationUpdate=]` | Sends a conversationUpdate, with membersAdded= and membersRemoved= values|
+
+Example ConversationUpdate message
+```markdown
+[ConversationUpdate=
+    MembersAdded=Joe,Susan]
+bot->Joe: Hi Joe!
+bot->Susan: Hi Susan!
+```
+
+### Message commands
+When sending a message there are a number of commands for controlling layout.
+
+|Command           | Description                                               |
+|------------------|-----------------------------------------------------------|
+|<code>[Suggestions=<Option 1>&#124;<Option 2>&#124;<Option 3>]</code> | Add suggested action buttons, delimited by <code>&#124;</code> |
+|`[AttachmentLayout=LayoutType]`| Specify how multiple attachments would be displayed. Layout types are `carousel` or `list`|
+
+
+#### Message Cards 
+You can add cards using simple commands as well.  Currently we support a number of cards:
+
+| description | card name                                                    |
+| ----------- | ------------------------------------------------------------ |
+| HeroCard    | A simple card with single large image, title, subtitle, text and buttons |
+| ThumbnailCard | Same as herocard, but image is much smaller |
+| AudioCard | send audio card for playing back an audio url |
+| VideoCard | send an video player card for playing back a video file |
+| AnimationCard | send a animated gif card |
+| MediaCard | send arbitrary media with transport control |
+| SigninCard | send a signin card |
+| OauthCard | send an oauth card which uses azure bot service oauth flow 
+
+```markdown
+Bot: 
+[Herocard   
+    title=Cheese gromit!
+    subtitle=Hero Card
+    text=This is some text describing the card, it's cool because it's cool
+    image=https://memegenerator.net/img/instances/500x/73055378/cheese-gromit.jpg
+    buttons=Option 1| Option 2| Option 3]
+
+Bot: 
+[ThumbnailCard
+    title=Cheese gromit!
+    subtitle=Thumbnail Card
+    text=This is some text describing the card, it's cool because it's cool
+    image=https://memegenerator.net/img/instances/500x/73055378/cheese-gromit.jpg
+    buttons=Option 1| Option 2| Option 3]
+```
+The properties that are supported are
+
+| property | description |
+|----|----|
+| title | The title of the card|
+| subtitle| a subtitle for the card with less emphasis|
+| text | a generic text property which can contain longer text describing the card|
+| image | image url to use for the card |
+| buttons | a set of button labels separated by `|`|
+
+
+####  Message Attachments
+To add an attachment, you use `[Attachment=path contentPath]`.  The path can be a URL or a local path (either absolute or relative to `.chat` file).  The content type is optional and if not passed, will be inferred from the file extension. You can also pass it using a shortcut or full mime type.
+
+```markdown
+[Attachment=path contentType]
+```
+
+The following examples illustrates sending a carousel of photos:
+```markdown
+Enjoy these pictures!
+[AttachmentLayout=carousel]
+[Attachment=http://4.bp.blogspot.com/--cFa6t-x4qY/UAqEgUvPd2I/AAAAAAAANIg/pMLE080Zjh4/s1600/turtle.jpg]
+[Attachment=http://viagemempauta.com.br/wp-content/uploads/2015/09/2_All-Angle-By-Andreza-dos-Santos_FTS_2914-344-620x415.jpg]
+[Attachment=http://images.fineartamerica.com/images-medium-large/good-morning-turtles-freund-gloria.jpg]
+[Attachment=http://4.bp.blogspot.com/--cFa6t-x4qY/UAqEgUvPd2I/AAAAAAAANIg/pMLE080Zjh4/s1600/turtle.jpg]
+[Attachment=image.png]
+```
+
+This example sends a local adaptive card using a content type shortcut:
+```markdown
+[Attachment=folder/sample.json "adaptivecard"]
+```
+
+#### Attachment content type shortcuts
+Some of the content types have shortcuts:
+
+| ContentType Shortcuts | Description                                |
+| ----------------------|--------------------------------------------|
+| animation             | `application/vnd.microsoft.card.animation` |
+| audio                 | `application/vnd.microsoft.card.audio`     |
+| hero                  | `application/vnd.microsoft.card.hero`      |
+| receipt               | `application/vnd.microsoft.card.receipt`   |
+| thumbnail             | `application/vnd.microsoft.card.thumbnail` |
+| signin                | `application/vnd.microsoft.card.signin`    |
+| video                 | `application/vnd.microsoft.card.video`     |
+| adaptivecard          | `application/vnd.microsoft.card.adaptive`  |
+| *application/custom*  | `application/custom`                       |
+
+
+
+## CLI Examples
+
+### Basic usage
+In the simplest form, a chatdown command looks like the following:
+```bash
+bf chatdown sample.chat > sample.transcript
+```
+This will consume `sample.chat` and output `sample.transcript`.
+
+### Using stdin
+stdin can be used as an alternative to specifying an input file.
+```bash
+(echo user=Joe && echo bot=LulaBot && echo Joe: 'Hi!' && echo LulaBot: 'Hi there!') | bf chatdown > sample.transcript
+```
+
+### Using stdout
+stdout can be used as an alternative to specifying the output file.
+```bash
+bf chatdown sample.chat
+```
+or 
+```bash
+bf chatdown sample.chat > joe.transcript
+```
+The transcript will be piped to stdout.
+_See code: [src/commands/chatdown.ts](https://github.com/Microsoft/chatdown/blob/v1.2.3/src/commands/chatdown.ts)_
+<!-- commandsstop -->

packages/chatdown/.gitignore

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+require('@oclif/command').run()
+.catch(require('@oclif/errors/handle'))

packages/chatdown/README.md

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*