Merge branch 'master' into scheyal-patch-3

Author: Eyal

README.md

@@ -1,15 +1,16 @@
 # BF Command Line Interface
 
 [![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://coveralls.io/repos/github/microsoft/botframework-cli/badge.svg?branch=master)](https://coveralls.io/github/microsoft/botframework-cli?branch=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.
 
 ## Available Commands
 The following commands are currently available:
 * [Chatdown](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-chatdown) 
-* [QnAMaker (Preview)](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-qnamaker)
+* [QnAMaker](https://github.com/microsoft/botframework-cli/tree/master/packages/cli#bf-qnamaker)
 * [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)
 
 ## Plugin Architecture
 BF CLI is based on [OClif](https://github.com/oclif/oclif) Framework and inherits its command line parsing style, and plugin architecture. 

packages/chatdown/README.md

@@ -4,9 +4,8 @@
 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://www.npmjs.com/package/@microsoft/bf-chatdown)
-[![Downloads/week](https://img.shields.io/npm/dw/chatdown.svg)](https://www.npmjs.com/package/@microsoft/bf-chatdown)
-[![License](https://img.shields.io/npm/l/chatdown.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/chatdown/package.json)
+[![Version](https://img.shields.io/npm/v/@microsoft/bf-chatdown)](https://www.npmjs.com/package/@microsoft/bf-chatdown)
+
 
 # Commands
 <!-- commands -->
@@ -27,7 +26,7 @@ OPTIONS
 
   -h, --help                   Chatdown command help
 
-  -o, --out=out  Path to the directory where the output of the multiple chat file processing (-f) 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.

packages/chatdown/src/commands/chatdown.ts

@@ -37,12 +37,11 @@ export default class Chatdown extends Command {
         })
       }
 
+      let outputDir = flags.out ? path.resolve(flags.out) : null
+
       if (inputIsDirectory) {
         let inputDir = flags.in ? flags.in.trim() : ''
-        let outputDir = (flags.out) ? flags.out.trim() : './'
-        if (outputDir.substr(0, 2) === './') {
-          outputDir = path.resolve(process.cwd(), outputDir.substr(2))
-        }
+
         const len = await this.processFiles(inputDir, outputDir)
         if (len === 0) {
           throw new CLIError('No chat files found at: ' + flags.in)
@@ -51,9 +50,10 @@ export default class Chatdown extends Command {
         return
       } else {
         const fileContents = await this.getInput(flags.in)
+        const fileName = flags.in ? this.getFileName(flags.in) : ''
         if (fileContents) {
           const activities = await chatdown(fileContents, flags)
-          const writeConfirmation = await this.writeOut(activities)
+          const writeConfirmation = await this.writeOut(activities, fileName, outputDir)
           /* tslint:disable:strict-type-predicates */
           if (typeof writeConfirmation === 'string') {
             process.stdout.write(`${chalk.green('Successfully wrote file:')}  ${writeConfirmation}\n`)
@@ -91,21 +91,20 @@ export default class Chatdown extends Command {
     }
   }
 
+  private getFileName(file: any) {
+    let fileName = path.basename(file, path.extname(file))
+    return fileName
+  }
+
   private async processFiles(inputDir: any, outputDir: any) {
     return new Promise(async (resolve, reject) => {
       let files = glob.sync(inputDir, {ignore: ['**/node_modules/**']})
       /* tslint:disable:prefer-for-of */
       for (let i = 0; i < files.length; i++) {
         try {
-          let fileName = files[i]
-          if (files[i].lastIndexOf('/') !== -1) {
-            fileName = files[i].substr(files[i].lastIndexOf('/'))
-          }
-          fileName = fileName.split('.')[0]
+          const fileName = this.getFileName(files[i])
           let activities = await chatdown(await utils.readTextFile(files[i]))
-          let writeFile = `${outputDir}/${fileName}.transcript`
-          await fs.ensureFile(writeFile)
-          await fs.writeJson(writeFile, activities, {spaces: 2})
+          await this.writeOut(activities, fileName, outputDir)
         } catch (e) {
           if (e.message.match(/no such file or directory/)) {
             reject(new CLIError(e.message))
@@ -119,7 +118,13 @@ export default class Chatdown extends Command {
     })
   }
 
-  private async writeOut(activities: any) {
+  private async writeOut(activities: any, fileName: string, outputDir: any) {
+    if (fileName && outputDir) {
+      let writeFile = path.join(outputDir, `${fileName}.transcript`)
+      await fs.ensureFile(writeFile)
+      await fs.writeJson(writeFile, activities, {spaces: 2})
+      return writeFile
+    }
     const output = JSON.stringify(activities, null, 2)
     await new Promise(done => process.stdout.write(output, 'utf-8', () => done()))
     return true

packages/chatdown/test/commands/chatdown.test.ts

@@ -44,7 +44,7 @@ describe('chatdown', () => {
     });
 
     it('should read from file when chat file is passed as an argument', done => {
-        cp.exec(`node ./bin/run chatdown --in ${path.join(__dirname, '../utils/cli.sample.chat')}`, (error, stdout) => {
+        cp.exec(`node ./bin/run chatdown --in ./test/utils/cli.sample.chat`, (error, stdout) => {
             assert.doesNotThrow(() => JSON.parse(stdout));
             done();
         });

packages/cli/README.md

@@ -1,27 +1,18 @@
 botframework-cli
 ================
 
-
-
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/botframework-cli.svg)](https://www.npmjs.com/package/@microsoft/botframework-cli)
-[![Downloads/week](https://img.shields.io/npm/dw/botframework-cli.svg)](https://www.npmjs.com/package/@microsoft/botframework-cli)
-[![License](https://img.shields.io/npm/l/botframework-cli.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
+[![Version](https://img.shields.io/npm/v/@microsoft/botframework-cli)](https://www.npmjs.com/package/@microsoft/botframework-cli)
+[![Downloads](https://img.shields.io/npm/dt/@microsoft/botframework-cli)](https://github.com/microsoft/botframework-cli)
+[![License](https://img.shields.io/npm/l/@microsoft/botframework-cli)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
 
 # Usage
-<!-- usage -->
+
 ```sh-session
 $ npm install -g @microsoft/botframework-cli
-$ bf COMMAND
-running command...
-$ bf (-v|--version|version)
-@microsoft/botframework-cli/1.0.0 darwin-x64 node-v12.1.0
-$ bf --help [COMMAND]
-USAGE
-  $ bf COMMAND
-...
+
 ```
-<!-- usagestop -->
+
 # Commands
 <!-- commands -->
 * [`bf `](#bf-)
@@ -33,6 +24,7 @@ USAGE
 * [`bf config:show:qnamaker`](#bf-configshowqnamaker)
 * [`bf config:show:telemetry`](#bf-configshowtelemetry)
 * [`bf help [COMMAND]`](#bf-help-command)
+* [`bf luis`](#bf-luis)
 * [`bf luis:convert`](#bf-luisconvert)
 * [`bf luis:generate:cs`](#bf-luisgeneratecs)
 * [`bf luis:generate:ts`](#bf-luisgeneratets)
@@ -154,6 +146,7 @@ USAGE
 
 OPTIONS
   -d, --disable  Disable tlemetry
+  -e, --enable   Enable tlemetry
   -h, --help     show CLI help
 ```
 
@@ -218,6 +211,20 @@ OPTIONS
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
 
+## `bf luis`
+
+Convert, translate luis/lu files or generate source code
+
+```
+USAGE
+  $ bf luis
+
+OPTIONS
+  -h, --help  Display Luis available commnads
+```
+
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/index.ts)_
+
 ## `bf luis:convert`
 
 Convert .lu file(s) to a LUIS application JSON model or vice versa
@@ -239,7 +246,7 @@ OPTIONS
   --versionid=versionid          Version ID of the LUIS application
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/convert.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/convert.ts)_
 
 ## `bf luis:generate:cs`
 
@@ -250,13 +257,13 @@ USAGE
   $ bf luis:generate:cs
 
 OPTIONS
-  --className=className  Name of the class
-  --force                If --in flag provided with the path to an existing file, overwrites it
-  --in=in                Source .lu file(s) or LUIS application JSON model
+  --className=className  Name of the autogenerated class (can include namespace)
+  --force                If --in flag is provided with the path to an existing file, overwrites that file
+  --in=in                Path to the file containing the LUIS application JSON model
   --out=out              Output file or folder name. If not specified stdout will be used as output
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/cs.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/cs.ts)_
 
 ## `bf luis:generate:ts`
 
@@ -267,13 +274,13 @@ USAGE
   $ bf luis:generate:ts
 
 OPTIONS
-  --className=className  Name of the class
-  --force                If --in flag provided with the path to an existing file, overwrites it
-  --in=in                Source .lu file(s) or LUIS application JSON model
+  --className=className  Name of the autogenerated class
+  --force                If --in flag is provided with the path to an existing file, overwrites that file
+  --in=in                Path to the file containing the LUIS application JSON model
   --out=out              Output file or folder name. If not specified stdout will be used as output
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/ts.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/ts.ts)_
 
 ## `bf luis:translate`
 
@@ -284,17 +291,17 @@ USAGE
   $ bf luis:translate
 
 OPTIONS
-  --in=in                                    (required) Source .lu file(s) or LUIS application JSON model
-  --out=out                                  Output folder name. If not specified stdout will be used as output
-  --recurse                                  Indicates if sub-folders need to be considered to file .lu file(s)
-  --srclang=srclang                          Source lang code. Auto detect if missing.
-  --tgtlang=tgtlang                          (required) Comma separated list of target languages.
-  --translate_comments=translate_comments    When set, machine translate comments found in .lu or .qna file
-  --translate_link_text=translate_link_text  When set, machine translate link description in .lu or .qna file
-  --translatekey=translatekey                (required) Machine translation endpoint key.
+  --in=in                      Source .lu file(s) or LUIS application JSON model
+  --out=out                    Output folder name. If not specified stdout will be used as output
+  --recurse                    Indicates if sub-folders need to be considered to file .lu file(s)
+  --srclang=srclang            Source lang code. Auto detect if missing.
+  --tgtlang=tgtlang            (required) Comma separated list of target languages.
+  --translate_comments         When set, machine translate comments found in .lu file
+  --translate_link_text        When set, machine translate link description in .lu file
+  --translatekey=translatekey  (required) Machine translation endpoint key.
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
 
 ## `bf plugins`
 
@@ -437,15 +444,15 @@ USAGE
 
 OPTIONS
   --alterations  Indicates if files is QnA Alterations
-  --in=in        (required) Source .qna file(s) or QnA KB JSON file
+  --in=in        Source .qna file(s) or QnA KB JSON file
   --log          Enables log messages
   --name=name    Name of the QnA KB
   --out=out      Output file or folder name. If not specified stdout will be used as output
   --recurse      Indicates if sub-folders need to be considered to file .qna file(s)
-  --sort         When set, questions collections are alphabetically sorted are alphabetically sorted in .lu files
+  --sort         When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
 
 ## `bf qnamaker:create:kb`
 
@@ -710,23 +717,25 @@ USAGE
 
 OPTIONS
   -h, --help                       qnamaker:query command help
+  --context=context                Path to Context object json file with previous QnA
 
   --endpointKey=endpointKey        Specifies the endpoint key for your private QnA service (From qnamaker.ai portal user
-                                   settings page). Overrides the value present in config.
+                                   settings page). Overrides the value present in config
 
-  --hostname=hostname              Specifies the url for your private QnA service. Overrides the value present in
-                                   config.
+  --hostname=hostname              Specifies the url for your private QnA service. Overrides the value present in config
 
   --kbId=kbId                      Specifies the active qnamaker knowledgebase id. Overrides the value present in the
                                    config
 
-  --question=question              (required) Query to get a prediction for.
+  --qnaId=qnaId                    Exact qnaId to fetch from the knowledgebase, this field takes priority over question
+
+  --question=question              (required) Query to get a prediction for
 
   --scorethreshold=scorethreshold  Specifies the confidence score threshold for the returned answer.
 
-  --strictfilters=strictfilters    Path to json file {"strictfilters": MetadataDTO[]}
+  --strictfilters=strictfilters    Path to json file with MetadataDTO[] e.g {"strictfilters": MetadataDTO[]}
 
-  --test                           Query against the test index.
+  --test                           Query against the test index
 
   --top=top                        Specifies the number of matching results
 ```
@@ -839,24 +848,24 @@ _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cl
 
 ## `bf qnamaker:translate`
 
-Translate given LUIS application JSON model or lu file(s)
+Translate given QnA maker application JSON model or qna file(s)
 
 ```
 USAGE
   $ bf qnamaker:translate
 
 OPTIONS
-  --in=in                                    (required) Source .lu file(s) or LUIS application JSON model
+  --in=in                                    Source .qna file(s) or QnA maker application JSON model
   --out=out                                  Output folder name. If not specified stdout will be used as output
-  --recurse                                  Indicates if sub-folders need to be considered to file .lu file(s)
+  --recurse                                  Indicates if sub-folders need to be considered to find .qna file(s)
   --srclang=srclang                          Source lang code. Auto detect if missing.
   --tgtlang=tgtlang                          (required) Comma separated list of target languages.
-  --translate_comments=translate_comments    When set, machine translate comments found in .lu or .qna file
-  --translate_link_text=translate_link_text  When set, machine translate link description in .lu or .qna file
+  --translate_comments=translate_comments    When set, machine translate comments found in .qna file
+  --translate_link_text=translate_link_text  When set, machine translate link description in .qna file
   --translatekey=translatekey                (required) Machine translation endpoint key.
 ```
 
-_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/translate.ts)_
+_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/translate.ts)_
 
 ## `bf qnamaker:update`
 

packages/cli/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "@microsoft/bf-chatdown": "1.0.0",
     "@microsoft/bf-cli-config": "1.0.0",
-    "@microsoft/bf-luis": "1.0.0",
+    "@microsoft/bf-lu": "1.0.0",
     "@microsoft/bf-qnamaker": "1.0.0",
     "@oclif/command": "~1.5.13",
     "@oclif/config": "~1.13.0",
@@ -64,7 +64,7 @@
       "@microsoft/bf-chatdown",
       "@microsoft/bf-cli-config",
       "@microsoft/bf-qnamaker",
-      "@microsoft/bf-luis"
+      "@microsoft/bf-lu"
     ],
     "hooks": {
       "init": "./lib/hooks/init/inithook"

packages/config/README.md

@@ -4,9 +4,7 @@
 
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/@microsoft/bf-cli-config.svg)](https://www.npmjs.com/package/@microsoft/bf-cli-config)
-[![Downloads/week](https://img.shields.io/npm/dw/@microsoft/bf-cli-config.svg)](https://www.npmjs.com/package/@microsoft/bf-cli-config)
-[![License](https://img.shields.io/npm/l/@microsoft/bf-cli-config.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/config/package.json)
+[![Version](https://img.shields.io/npm/v/@microsoft/bf-cli-config)](https://www.npmjs.com/package/@microsoft/bf-cli-config)
 
 # Commands
 <!-- commands -->
@@ -73,6 +71,7 @@ USAGE
 
 OPTIONS
   -d, --disable  Disable tlemetry
+  -e, --enable   Enable tlemetry
   -h, --help     show CLI help
 ```