Support passing in information about external functions in lg:analyze (#1237)

* support of adding external functions as arguments

* remove only

* fix test cases failed

* revert comment

Author: Shuai Wang

common/config/rush/pnpm-lock.yaml

@@ -437,6 +437,7 @@ OPTIONS
   -i, --in=in    (required) LG File or folder that contains .lg file(s)
   -o, --out=out  Output file or folder name. If not specified stdout will be used as output
   -r, --recurse  Consider sub-folders to find .lg file(s)
+  -e, --external-functions Pass a list of external functions and add them to Expression functions, seprated by ",". for example, "function1,function2,function3"
 ```
 
 _See code: [@microsoft/bf-lg-cli](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_

packages/cli/README.md

@@ -47,6 +47,7 @@ OPTIONS
   -i, --in=in    (required) LG File or folder that contains .lg file(s)
   -o, --out=out  Output file or folder name. If not specified stdout will be used as output
   -r, --recurse  Consider sub-folders to find .lg file(s)
+  -e, --external-functions Pass a list of external functions and add them to Expression functions, seprated by ",". for example, "function1,function2,function3"
 ```
 
 _See code: [src/commands/lg/analyze.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_

packages/lg/README.md

@@ -11,6 +11,7 @@
     "@oclif/command": "^1.5.19",
     "@oclif/config": "^1.14.0",
     "botbuilder-lg":"4.13.0",
+    "adaptive-expressions":"4.13.0",
     "delay": "^4.3.0",
     "fs-extra": "^8.1.0",
     "lodash": "^4.17.15",

packages/lg/package.json

@@ -9,6 +9,7 @@
 import {Command, flags, CLIError} from '@microsoft/bf-cli-command'
 import {Helper} from '../../utils'
 import {Templates, DiagnosticSeverity, Diagnostic} from 'botbuilder-lg'
+import {Expression, ExpressionEvaluator} from 'adaptive-expressions'
 import * as path from 'path'
 import * as fs from 'fs-extra'
 
@@ -28,6 +29,7 @@ export default class AnalyzeCommand extends Command {
     recurse: flags.boolean({char: 'r', description: 'Consider sub-folders to find .lg file(s)'}),
     out: flags.string({char: 'o', description: 'Output file or folder name. If not specified stdout will be used as output'}),
     force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file'}),
+    'external-functions': flags.string({char: 'e', helpValue: 'function1,function2', description: 'Pass a list of external functions and add them to Expression functions, seprated by ",". for example, "function1,function2,function3"'}),
     help: flags.help({char: 'h', description: 'lg:analyze help'}),
   }
 
@@ -37,6 +39,13 @@ export default class AnalyzeCommand extends Command {
     const lgFilePaths = Helper.findLGFiles(flags.in, flags.recurse)
 
     Helper.checkInputAndOutput(lgFilePaths)
+    if (flags['external-functions']) {
+      const functionList = flags['external-functions'].split(',')
+      for (const func of functionList)
+        Expression.functions.add(func, new ExpressionEvaluator(func, () => {
+          return {value: undefined, error: ''}
+        }))
+    }
 
     const allTemplates = []
     for (const filePath of lgFilePaths) {

packages/lg/src/commands/lg/analyze.ts

@@ -38,6 +38,20 @@ describe('lg:analyze lg file', async () => {
     await TestUtil.compareFiles(path.join(generatedFolderPath, 'analysisResult.txt'), path.join(verifiedFolderPath, 'analysisResult1.txt'))
   })
 
+  test
+  .command(['lg:analyze',
+    '--in',
+    path.join(__dirname, testcaseFolderPath, 'analyze/external.lg'),
+    '--out',
+    generatedFolder,
+    '-r',
+    '-f',
+    '--external-functions',
+    'ReadDatabase'])
+  .it('', async () => {
+    await TestUtil.compareFiles(path.join(generatedFolderPath, 'analysisResult.txt'), path.join(verifiedFolderPath, 'analysisResult3.txt'))
+  })
+
   // lg files folder
   test
   .command(['lg:analyze',
@@ -46,7 +60,9 @@ describe('lg:analyze lg file', async () => {
     '--out',
     generatedFolder,
     '-r',
-    '-f'])
+    '-f',
+    '--external-functions',
+    'ReadDatabase'])
   .it('', async () => {
     await TestUtil.compareFiles(path.join(generatedFolderPath, 'analysisResult.txt'), path.join(verifiedFolderPath, 'analysisResult2.txt'))
   })

packages/lg/test/commands/lg/analyze.test.ts

@@ -0,0 +1,8 @@
+#CallMyName(name)
+- hello ${name} ${GetToDos()}
+
+#GetToDos
+- Here is your Todos: ${ReadDatabase()} ${LogWaiting()}
+
+#LogWaiting
+- Is there any thing I can help you with?

packages/lg/test/fixtures/testcase/analyze/external.lg

@@ -1,3 +1,8 @@
+external.lg:CallMyName references:
+external.lg:GetToDos references:
+    external.lg: CallMyName
+external.lg:LogWaiting references:
+    external.lg: CallMyName, GetToDos
 generator.lg:greeting references:
 generator.lg:welcome references:
     generator.lg: greeting

packages/lg/test/fixtures/verified/analysisResult2.txt

@@ -0,0 +1,5 @@
+external.lg:CallMyName references:
+external.lg:GetToDos references:
+    external.lg: CallMyName
+external.lg:LogWaiting references:
+    external.lg: CallMyName, GetToDos