@tremho/mist-lift 1.0.2-pre-release.4 → 1.0.2

package/src/commands/help.ts

@@ -1,171 +1,170 @@
 import * as ac from 'ansi-colors'
 
-export function doHelp(
-    command:string
-) {
-    switch (command) {
-        case 'help':
-            return helpHelp()
-        case 'init':
-            return helpInit()
-        case 'create':
-            return helpCreate()
-        case 'build':
-            return helpBuild()
-        case 'test':
-            return helpTest()
-        case 'start':
-            return helpStart()
-        // case 'stop':
-        //     return helpStop()
-        case 'package':
-            return helpPackage()
-        case 'deploy':
-            return helpDeploy()
-        case 'publish':
-            return helpPublish()
-        case 'settings':
-            return helpSettings()
-        case 'doctor':
-            return helpDoctor()
-        default:
-            return helpDefault()
-    }
+export function doHelp (
+  command: string
+): void {
+  switch (command) {
+    case 'help':
+      return helpHelp()
+    case 'init':
+      return helpInit()
+    case 'create':
+      return helpCreate()
+    case 'build':
+      return helpBuild()
+    case 'test':
+      return helpTest()
+    case 'start':
+      return helpStart()
+      // case 'stop':
+      //     return helpStop()
+    case 'package':
+      return helpPackage()
+    case 'deploy':
+      return helpDeploy()
+    case 'publish':
+      return helpPublish()
+    case 'settings':
+      return helpSettings()
+    case 'doctor':
+      return helpDoctor()
+    default:
+      return helpDefault()
+  }
 }
-function helpDefault() {
-    console.log('lift is the command-line tool of the MistLift framework.');
-    console.log("");
-    console.log(ac.bold("Usage: " + ac.grey("lift " + ac.grey.dim("command  [args]"))));
-    console.log("where " + ac.grey.dim("command") + " is one of:");
-    console.log("  " + ac.blue.bold("help " + ac.grey.dim("[command]")) + " -- this list, or help on a given command");
-    console.log("  " + ac.blue.bold("init") + "  -- create or prepare a directory as a MistLift project");
-    console.log("  " + ac.blue.bold("create " + ac.grey.italic("functionName")) + "  -- define and create a new API function");
-    console.log("  " + ac.green("build") + "  -- build the project");
-    console.log("  " + ac.green("test") + "  -- build, and run unit tests");
-    console.log("  " + ac.cyan.bold("start") + "  -- start the local express server");
-    // console.log("  " + ac.cyan.bold("stop") + "  -- stop the local express server");
-    console.log("  " + ac.green("package "+ ac.grey.italic("[functionName]")) + "  -- builds and packages functions into lambda-ready zips");
-    console.log("  " + ac.green("deploy " + ac.grey.italic("[functionName]")) + "  -- builds, packages, and deploys function packages to AWS lambda");
-    console.log("  " + ac.blue.bold("publish") + "  -- publishes the API and binds to the deployed functions");
-    console.log("  " + ac.blue.bold("settings") + "  -- sets up cloud settings");
-    console.log("  " + ac.blue.bold("doctor") + "  -- checks MistLift installation and status");
-    console.log('');
-    console.log("use " + ac.bold("lift help " + ac.grey.dim('[command]')) + " for command arguments and detals.");
-    console.log(ac.italic("use " + ac.bold("lift version " +ac.grey.dim("or lift -v or lift --version") + ac.grey(" to see current running version of MistLift"))))
+function helpDefault (): void {
+  console.log('lift is the command-line tool of the MistLift framework.')
+  console.log('')
+  console.log(ac.bold('Usage: ' + ac.grey('lift ' + ac.grey.dim('command  [args]'))))
+  console.log('where ' + ac.grey.dim('command') + ' is one of:')
+  console.log('  ' + ac.blue.bold('help ' + ac.grey.dim('[command]')) + ' -- this list, or help on a given command')
+  console.log('  ' + ac.blue.bold('init') + '  -- create or prepare a directory as a MistLift project')
+  console.log('  ' + ac.blue.bold('create ' + ac.grey.italic('functionName')) + '  -- define and create a new API function')
+  console.log('  ' + ac.green('build') + '  -- build the project')
+  console.log('  ' + ac.green('test') + '  -- build, and run unit tests')
+  console.log('  ' + ac.cyan.bold('start') + '  -- start the local express server')
+  // console.log("  " + ac.cyan.bold("stop") + "  -- stop the local express server");
+  console.log('  ' + ac.green('package ' + ac.grey.italic('[functionName]')) + '  -- builds and packages functions into lambda-ready zips')
+  console.log('  ' + ac.green('deploy ' + ac.grey.italic('[functionName]')) + '  -- builds, packages, and deploys function packages to AWS lambda')
+  console.log('  ' + ac.blue.bold('publish') + '  -- publishes the API and binds to the deployed functions')
+  console.log('  ' + ac.blue.bold('settings') + '  -- sets up cloud settings')
+  console.log('  ' + ac.blue.bold('doctor') + '  -- checks MistLift installation and status')
+  console.log('')
+  console.log('use ' + ac.bold('lift help ' + ac.grey.dim('[command]')) + ' for command arguments and detals.')
+  console.log(ac.italic('use ' + ac.bold('lift version ' + ac.grey.dim('or lift -v or lift --version') + ac.grey(' to see current running version of MistLift'))))
 }
-function printBanner(cmd:string) {
-    let out = '  ' + ac.green('╭───────────────────────────────────────────────────────────────╮')+'\n'
-    out += '  ' + ac.green('|                                                               |')+'\n'
-    out += '  ' + ac.green('|                               Lift                            |')+'\n'
-    out += '  ' + ac.green('|                                                               |')+'\n'
-    out += '  ' + ac.green('╰───────────────────────────────────────────────────────────────╯')+'\n'
-    out += '  ' + ac.bold.green(cmd)
-    out += '\n'
-    console.log(out)
+function printBanner (cmd: string): void {
+  let out = '  ' + ac.green('╭───────────────────────────────────────────────────────────────╮') + '\n'
+  out += '  ' + ac.green('|                                                               |') + '\n'
+  out += '  ' + ac.green('|                               Lift                            |') + '\n'
+  out += '  ' + ac.green('|                                                               |') + '\n'
+  out += '  ' + ac.green('╰───────────────────────────────────────────────────────────────╯') + '\n'
+  out += '  ' + ac.bold.green(cmd)
+  out += '\n'
+  console.log(out)
 }
-function helpHelp() {
-    printBanner("help")
-    console.log("use " + ac.bold('lift help') + " by itself to see a list of commands");
-    console.log("use " + ac.bold("lift help " + ac.grey.dim('[command]')) + " for help on a given command");
-    console.log('');
+function helpHelp (): void {
+  printBanner('help')
+  console.log('use ' + ac.bold('lift help') + ' by itself to see a list of commands')
+  console.log('use ' + ac.bold('lift help ' + ac.grey.dim('[command]')) + ' for help on a given command')
+  console.log('')
 }
-export function helpInit() {
-    printBanner("init")
-    console.log("use " + ac.bold('lift init .') + " from within a directory to init the current directory as a MistLift project");
-    console.log("use " + ac.bold("lift init " + ac.grey.dim('projectPath')) + " to create a new directory at "
-    + ac.grey.dim("projectPath") + " if it does not exist and init a MistLift project in that directory, if not already initialized");
-    console.log("")
-    console.log("This will begin an interactive session where you will be asked questions about the project you are creating.")
-    console.log("The project will be complete and ready to run right away.")
-    console.log("You can then modify the application to your needs.")
+export function helpInit (): void {
+  printBanner('init')
+  console.log('use ' + ac.bold('lift init .') + ' from within a directory to init the current directory as a MistLift project')
+  console.log('use ' + ac.bold('lift init ' + ac.grey.dim('projectPath')) + ' to create a new directory at ' +
+    ac.grey.dim('projectPath') + ' if it does not exist and init a MistLift project in that directory, if not already initialized')
+  console.log('')
+  console.log('This will begin an interactive session where you will be asked questions about the project you are creating.')
+  console.log('The project will be complete and ready to run right away.')
+  console.log('You can then modify the application to your needs.')
 }
 
-export function helpCreate() {
-    printBanner("create")
-    console.log("use " + ac.bold('lift create') + ac.grey.dim(' functionName') + " to create a new function for your API")
-    console.log("")
-    console.log("your project folder (set up with "+ac.green.bold("init")+") will have a new function template created as "
-    + ac.grey.dim("functionName")
-    + " in a folder named "
-    + ac.green.dim("functions") + " within your project directory")
-    console.log("")
-    console.log(ac.grey("The default function will display a'Hello World!' message when built and run" ));
-    console.log(ac.grey("Modify the code to suit the needs of your function application"));
+export function helpCreate (): void {
+  printBanner('create')
+  console.log('use ' + ac.bold('lift create') + ac.grey.dim(' functionName') + ' to create a new function for your API')
+  console.log('')
+  console.log('your project folder (set up with ' + ac.green.bold('init') + ') will have a new function template created as ' +
+    ac.grey.dim('functionName') +
+    ' in a folder named ' +
+    ac.green.dim('functions') + ' within your project directory')
+  console.log('')
+  console.log(ac.grey("The default function will display a'Hello World!' message when built and run"))
+  console.log(ac.grey('Modify the code to suit the needs of your function application'))
 }
-export function helpBuild() {
-    printBanner("build")
-    console.log("use "+ ac.bold('lift build') + " to build all your functions of the project")
-    console.log("use "+ ac.bold('lift build') + " one or more function names to build these individually")
-    console.log("")
-    console.log("include "+ ac.bold('--clean') + " to force a rebuild, bypassing file date compare")
-    console.log("include "+ ac.bold('--failfast') + " to stop after encountering an error")
-    console.log("include "+ ac.bold('--deferfail') + " to build all, then report any errors (the default)")
-    console.log("")
-    console.log("The build step compiles your typescript (.ts) files into executable javascript (.js) files within a folder named 'build' in your project directory.")
-    console.log("Files that are not updated are not rebuilt.")
-    console.log("The build step is automatically invoked by other actions that depend upon it as a prerequisite, so it does not need to be explicitly run in normal operation.");
-    console.log("");
+export function helpBuild (): void {
+  printBanner('build')
+  console.log('use ' + ac.bold('lift build') + ' to build all your functions of the project')
+  console.log('use ' + ac.bold('lift build') + ' one or more function names to build these individually')
+  console.log('')
+  console.log('include ' + ac.bold('--clean') + ' to force a rebuild, bypassing file date compare')
+  console.log('include ' + ac.bold('--failfast') + ' to stop after encountering an error')
+  console.log('include ' + ac.bold('--deferfail') + ' to build all, then report any errors (the default)')
+  console.log('')
+  console.log("The build step compiles your typescript (.ts) files into executable javascript (.js) files within a folder named 'build' in your project directory.")
+  console.log('Files that are not updated are not rebuilt.')
+  console.log('The build step is automatically invoked by other actions that depend upon it as a prerequisite, so it does not need to be explicitly run in normal operation.')
+  console.log('')
 }
-export function helpTest() {
-    printBanner("test")
-    console.log("use "+ ac.bold( 'lift test') + " to invoke the testing framework and run unit tests for all functions")
-    console.log("")
-    console.log("Tests should be written in files within the named test folder for each created function. test files are given the suffix .test.ts")
-    console.log("The test framework used is 'Tap' (https://node-tap.org)")
-    console.log("");
+export function helpTest (): void {
+  printBanner('test')
+  console.log('use ' + ac.bold('lift test') + ' to invoke the testing framework and run unit tests for all functions')
+  console.log('')
+  console.log('Tests should be written in files within the named test folder for each created function. test files are given the suffix .test.ts')
+  console.log("The test framework used is 'Tap' (https://node-tap.org)")
+  console.log('')
 }
-export function helpStart() {
-    printBanner("start")
-    console.log("use "+ ac.bold( 'lift start') + " to start running the local 'Express' server for local execution")
-    console.log("")
-    console.log("Functions may be run and tested via a local http server powered by express.")
-    console.log("By default, access is at "+ac.blue("http://localhost:8081"));
-    console.log("");
+export function helpStart (): void {
+  printBanner('start')
+  console.log('use ' + ac.bold('lift start') + " to start running the local 'Express' server for local execution")
+  console.log('')
+  console.log('Functions may be run and tested via a local http server powered by express.')
+  console.log('By default, access is at ' + ac.blue('http://localhost:8081'))
+  console.log('')
 }
-export function helpStop() {
-    printBanner("stop")
-    console.log("use "+ ac.bold('lift stop') + " to stop the running local 'Express' server")
-    console.log("")
-    console.log("This will shut down the local server")
-    console.log("")
+export function helpStop (): void {
+  printBanner('stop')
+  console.log('use ' + ac.bold('lift stop') + " to stop the running local 'Express' server")
+  console.log('')
+  console.log('This will shut down the local server')
+  console.log('')
 }
-export function helpPackage() {
-    printBanner("package")
-    console.log("use "+ ac.bold('lift package') + " to build and package functions for cloud deployment")
-    console.log("")
-    console.log("options such as "+ac.bold('--clean')+ " may be specified to force a build prior to packaging")
-    console.log("")
-    console.log("Functions must be packaged into zip files before delivery to the cloud")
-    console.log("The package command handles this by first insuring a fresh build and then packaging the function and its module dependencies")
-    console.log(ac.grey("This action is invoked as part of deployment, and need not be invoked separately with this command"))
-    console.log("");
+export function helpPackage (): void {
+  printBanner('package')
+  console.log('use ' + ac.bold('lift package') + ' to build and package functions for cloud deployment')
+  console.log('')
+  console.log('options such as ' + ac.bold('--clean') + ' may be specified to force a build prior to packaging')
+  console.log('')
+  console.log('Functions must be packaged into zip files before delivery to the cloud')
+  console.log('The package command handles this by first insuring a fresh build and then packaging the function and its module dependencies')
+  console.log(ac.grey('This action is invoked as part of deployment, and need not be invoked separately with this command'))
+  console.log('')
 }
-export function helpDeploy() {
-    printBanner("deploy")
-    console.log("use " + ac.bold('lift deploy') + ac.grey.dim(' functionName') + " to package and deploy a function to the cloud")
-    console.log("use " + ac.bold('lift deploy') + " with no argument to deploy all functions to the cloud")
-    console.log("")
-    console.log("options such as "+ac.bold('--clean')+ " may be specified to force a build prior to packaging")
-    console.log("the option "+ac.bold('--no-package')+ " may be specified to deploy without repackaging")
-    console.log("");
-    console.log("functions will be built and packaged if necessary before deployment");
-
+export function helpDeploy (): void {
+  printBanner('deploy')
+  console.log('use ' + ac.bold('lift deploy') + ac.grey.dim(' functionName') + ' to package and deploy a function to the cloud')
+  console.log('use ' + ac.bold('lift deploy') + ' with no argument to deploy all functions to the cloud')
+  console.log('')
+  console.log('options such as ' + ac.bold('--clean') + ' may be specified to force a build prior to packaging')
+  console.log('the option ' + ac.bold('--no-package') + ' may be specified to deploy without repackaging')
+  console.log('')
+  console.log('functions will be built and packaged if necessary before deployment')
 }
-export function helpPublish() {
-    printBanner("publish")
-    console.log("use " + ac.bold('lift publish') + " to publish the API to an accessible cloud endpoint")
-    console.log("");
-    console.log("The base url for the cloud API will be returned by this operation.")
-    console.log("");
-    console.log("Once published, updates to functions may be made with "+ac.bold('deploy')+ " without needing to republish.")
-    console.log("Changes to webroot content or api definitions will require a new publish")
-    console.log("Each publish operation returns a new URL.  The previous URL is invalid.")
+export function helpPublish (): void {
+  printBanner('publish')
+  console.log('use ' + ac.bold('lift publish') + ' to publish the API to an accessible cloud endpoint')
+  console.log('')
+  console.log('The base url for the cloud API will be returned by this operation.')
+  console.log('')
+  console.log('Once published, updates to functions may be made with ' + ac.bold('deploy') + ' without needing to republish.')
+  console.log('Changes to webroot content or api definitions will require a new publish')
+  console.log('Each publish operation returns a new URL.  The previous URL is invalid.')
 }
-export function helpSettings() {
-    printBanner("settings")
-    console.log("use " + ac.bold('lift settings') + " to set or review the Cloud settings and configured options")
+export function helpSettings (): void {
+  printBanner('settings')
+  console.log('use ' + ac.bold('lift settings') + ' to set or review the Cloud settings and configured options')
 }
-export function helpDoctor() {
-    printBanner("doctor")
-    console.log("use " + ac.bold('lift doctor') + " to report the status of your MistLift installation and dependencies")
+export function helpDoctor (): void {
+  printBanner('doctor')
+  console.log('use ' + ac.bold('lift doctor') + ' to report the status of your MistLift installation and dependencies')
 }

package/src/commands/init.ts

@@ -16,47 +16,45 @@
 
 import * as path from 'path'
 import * as fs from 'fs'
-import {helpInit} from "./help";
-import {doDoctor} from "./doctor";
-import {interrogateUserForPackageJsonSettings} from "./actions/initQuestions";
-import {addPackageScripts, installPackage, installDevPackage} from "./actions/setupPackageJson";
+import { helpInit } from './help'
+import { interrogateUserForPackageJsonSettings } from './actions/initQuestions'
+import { addPackageScripts, installPackage, installDevPackage } from './actions/setupPackageJson'
 
-export async function doInit(
-    folder:string
-)
-{
-    if(!folder) {
-        helpInit();
-        return;
-    }
-    const cwd = process.cwd()
-    const refPath = path.isAbsolute(folder) ? path.normalize(folder) : path.normalize(path.join(cwd, folder))
-    console.log(refPath)
-    if(!fs.existsSync(refPath)) {
-        fs.mkdirSync(refPath, {recursive: true})
-    }
+export async function doInit (
+  folder?: string
+): Promise<void> {
+  if (folder === undefined || folder === '') {
+    helpInit()
+    return
+  }
+  const cwd = process.cwd()
+  const refPath = path.isAbsolute(folder) ? path.normalize(folder) : path.normalize(path.join(cwd, folder))
+  console.log(refPath)
+  if (!fs.existsSync(refPath)) {
+    fs.mkdirSync(refPath, { recursive: true })
+  }
 
-    const funcDir = path.join(refPath, "functions")
-    if(!fs.existsSync(funcDir)) {
-        fs.mkdirSync(funcDir)
-    }
+  const funcDir = path.join(refPath, 'functions')
+  if (!fs.existsSync(funcDir)) {
+    fs.mkdirSync(funcDir)
+  }
 
-    // make webroot with docs folder and placeholder yaml
-    const webrootDocs = path.join(refPath, "webroot", "docs")
-    if(!fs.existsSync(webrootDocs)) {
-        fs.mkdirSync(webrootDocs, {recursive: true})
-        const yaml = path.join(webrootDocs, 'apidoc.yaml');
-        fs.writeFileSync(yaml, '');
-        const swaggerSrcDir = path.join(__dirname, '..', '..', 'templateData')
-        fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui.css'), path.join(webrootDocs, 'swagger-ui.css'));
-        fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui-bundle.js'), path.join(webrootDocs, 'swagger-ui-bundle.js'));
-        fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui-standalone-preset.js'), path.join(webrootDocs, 'swagger-ui-standalone-preset.js'));
-    }
+  // make webroot with docs folder and placeholder yaml
+  const webrootDocs = path.join(refPath, 'webroot', 'docs')
+  if (!fs.existsSync(webrootDocs)) {
+    fs.mkdirSync(webrootDocs, { recursive: true })
+    const yaml = path.join(webrootDocs, 'apidoc.yaml')
+    fs.writeFileSync(yaml, '')
+    const swaggerSrcDir = path.join(__dirname, '..', '..', 'templateData')
+    fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui.css'), path.join(webrootDocs, 'swagger-ui.css'))
+    fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui-bundle.js'), path.join(webrootDocs, 'swagger-ui-bundle.js'))
+    fs.copyFileSync(path.join(swaggerSrcDir, 'swagger-ui-standalone-preset.js'), path.join(webrootDocs, 'swagger-ui-standalone-preset.js'))
+  }
 
-    await interrogateUserForPackageJsonSettings(refPath)
-    await addPackageScripts(refPath)
-    await installDevPackage(refPath,"@types/node")
-    await installDevPackage(refPath,"typescript")
-    await installDevPackage(refPath,"tap")
-    await installPackage(refPath,"@tremho/inverse-y")
+  await interrogateUserForPackageJsonSettings(refPath)
+  await addPackageScripts(refPath)
+  await installDevPackage(refPath, '@types/node')
+  await installDevPackage(refPath, 'typescript')
+  await installDevPackage(refPath, 'tap')
+  await installPackage(refPath, '@tremho/inverse-y')
 }