Merge branch 'master' into emimunoz/luis

Author: munozemilio

Internal-Hackathon-Oct-18-2019.md

@@ -0,0 +1,99 @@
+# Internal Hackathon for SDK 4.6 release
+
+Where: Kitchen
+When: October 18, 2019 10:00am to noon
+Who: You :)
+
+**Goal**: Get team’s assistance in flushing out last minute items to support smooth transition from legacy tools to new and improved BF CLI.
+
+
+Please file issues here: https://github.com/microsoft/botframework-cli/issues
+
+## Instructions
+* Download and install from: **TBD:Emilio**
+* Ensure Telemetry is enabled:  **TBD:Emilio**
+* Hack it: Use to create/manage bots
+* Hack it challenge: Use with Virtual Assistant
+
+For any questions and feedback please talk to us!
+
+_Eyal, Emilio, Axel, and Jonathan_
+
+## Example Hack Objectives
+
+### Global / Foundation
+Owner: **Emilio + Eyal**
+* Ensure documentation quality in MS DOCS and READMEs (links: a, b, c)
+* Ensure command line consistency across all tools
+* Ensure foundation & all command groups align to Contributing.md guideline (common flags, I/O ops, logging)
+* Ensure npm Installation paths, messaging (link)
+* Ensure deprecation messages on corresponding legacy tools
+* Ensure telemetry accuracy
+* Ensure configuration management 
+* Enable/Disable telemetry & verify accuracy in telemetry logging
+* Security/Privacy pass complete (not hackathon per se)
+
+### Chatdown
+Owner: **Jonathan**
+* Ensure commands and flags work as expected, testing instructions below
+
+### qnamaker
+Owner: **Emilio**
+
+### Ludown
+Owner: **Emilio**
+ 
+### LuisGen
+Owner: **Axel**
+
+* Generate file with no specific name (use class name)
+* Generate file with specific name different than class name
+* Generate file with no specific name and target name already exists
+* Generate file with specific name and target name already exists
+* Generate file with no specific name, target name already exists and send force flag
+* Generate file with specific name, target name already exists and send force flag
+
+## Example Scenarios
+
+* Convert chatdown script from Emulator (?)
+* QnAMaker: Prepare, create, train, publish, delete KB
+* Luis: convert .lu / .luis files
+* Challenge: Create & run a Virtual Assistant script  (that's what the VA team will do after Ignite if you didn't do it for them :))
+
+## Other Suggestions
+
+### Chatdown
+
+Run the following commands and ensure the results match the expectations, indicated in square brackets:
+	
+bf chatdown
+bf chatdown -h
+[should display the help contents]
+	
+(echo bot=jon) | ./bin/run chatdown
+[should display transcript in console]
+	
+bf chatdown --in ./test/utils/cli.sample.chat
+bf chatdown --in 'C:\Projects\cli\botframework-cli\packages\chatdown\test\utils\cli.sample.chat' [absolute path to file]
+[should output transcipt file to console]
+	
+bf chatdown --in ./test/utils/cli.sample.chat --prefix
+[should output transcipt file to console, prefixed with the package name]
+	
+bf chatdown --in ./test/utils/cli.doesntexist.chat 
+[should display an error message: 'no such file or directory']
+	
+bf chatdown --in ./test/utils/cli.sample.chat --out ./test/testout 
+[should output transcipt file to specified dir]
+	
+bf chatdown --in ./test/utils/cli.sample.chat --out 'C:\Projects\cli\botframework-cli\packages\chatdown\test\utils\testout' [absolute path to directory]
+[should output transcipt file to specified dir]
+	
+bf chatdown --in ./test/utils/cli.sample.chat --out ./test/doesntexist
+[should create a dir that doesnt exist and output transcipt file there ]
+
+---
+<img src="https://github.com/microsoft/botframework-cli/blob/esbfclispec2/BF%20CLI%20Hackathon%20Flyer.jpg"
+     alt="Bot Framework CLI Hackathon"
+     style="float: left; margin-right: 10px;" />
+     

README.md

@@ -3,7 +3,9 @@
 [![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/CLI/Botframework-CLI-CI-PR?branchName=master)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=537&branchName=master)
 [![Coverage Status](https://img.shields.io/coveralls/github/microsoft/botframework-cli/master)](https://coveralls.io/github/microsoft/botframework-cli?branch=master)
 
-As part of the effort to improve Bot Framework SDK toolset we are happy to announce the introduction of a new Command Line Interface tool which will eventually replace the suite of tools currently used during Bot development. The new CLI, called BF is being released as an early preview. We have migrated Chatdown as a first proof of concept plugin. The new Chatdown plugin is fully functional and identical to the standalone tool (with some minor usage bug fixes). Early adopters are welcome to switch to the new CLI. In the meantime the old and new tools will exist side by side for at least a full release cycle.
+The new BF Command Line Interface (CLI) tool replaces the collection of standalone tools used to manage Bot Framework bots and related services. We have ported most tools and are in process of porting the rest. The new BF CLI aggregates the collection of cross-platform tools into one cohesive and consistent interface.
+
+The old tools will be deprecated in subsequent releases. All new investments, bug fixes, and new features will be implemented in the new consolided BF CLI alone.
 
 ## Available Commands
 The following commands are currently available:
@@ -12,6 +14,14 @@ The following commands are currently available:
 * [Config](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-config)
 * [Luis](https://github.com/microsoft/botframework-cli/tree/emimunoz/luis/packages/cli#bf-luis)
 
+### Future Commands
+The following commands will be ported in upcoming releases:
+* LUIS (API)
+* Dispatch
+
+See [Porting Map](https://github.com/microsoft/botframework-cli/blob/master/PortingMap.md) for a mapping reference between old and new tools
+
+
 ## Plugin Architecture
 BF CLI is based on [OClif](https://github.com/oclif/oclif) Framework and inherits its command line parsing style, and plugin architecture. 
 
@@ -39,10 +49,7 @@ Privacy is very important to us. BF CLI contains optional instrumentation that i
 * Command group calls
 * Flags used **excluding** specific values (i.e. if used parameter _--folder:name_, we will only gather the use of _--folder_ but will not capture _name_).
 
-At any time you may disable data collection by changing the configuration using command:
-~~~ 
-bf config:telemetry:disable
-~~~
+To disable data collection see the  __*bf config*__ command.
 
 Please refer to [Microsoft Privacy Statement](https://privacy.microsoft.com/en-US/privacystatement) for more details.  
 

packages/chatdown/README.md

@@ -26,18 +26,22 @@ OPTIONS
 
   -h, --help                   Chatdown command help
 
-  -o, --out=out  Path to the directory where the output of the multiple chat file processing (-o) will be
+  -o, --out=out                Path to the directory where the output of the multiple chat file processing (-o) will be
                                placed.
 
   -p, --prefix                 Prefix stdout with package name.
 
   -s, --static                 Use static timestamps when generating timestamps on activities.
 
-EXAMPLE
+EXAMPLES
 
      $ bf chatdown
-     $ bf chatdown --in=./path/to/file/sample.chat
-     $ bf chatdown --in ./test/utils/*.sample.chat -o ./
+     $ bf chatdown -h
+     $ bf chatdown --in ./path/to/file/sample.chat
+     $ bf chatdown --in ./path/to/file/sample.chat --out ./
+     $ bf chatdown --in=./path/to/file/sample.chat --out=./
+     $ bf chatdown -i ./path/to/file/*.sample.chat -o ./
+     $ bf chatdown -i=./path/to/file/*.sample.chat -o=./
      $ (echo user=Joe && [ConversationUpdate=MembersAdded=Joe]) | bf chatdown --static
 ```
 

packages/chatdown/src/commands/chatdown.ts

@@ -58,6 +58,8 @@ export default class Chatdown extends Command {
           if (typeof writeConfirmation === 'string') {
             process.stdout.write(`${chalk.green('Successfully wrote file:')}  ${writeConfirmation}\n`)
           }
+        } else if (flags.in && !fileContents) {
+          throw new CLIError('No file contents found in: ' + flags.in)
         } else {
           return this._help()
         }