@adobe/aio-cli-plugin-app 8.6.1 → 9.1.0

package/src/commands/app/deploy.js

@@ -12,13 +12,11 @@ governing permissions and limitations under the License.
 
 const ora = require('ora')
 const chalk = require('chalk')
-// const path = require('path')
-const { cli } = require('cli-ux')
 
 const BaseCommand = require('../../BaseCommand')
 const BuildCommand = require('./build')
 const webLib = require('@adobe/aio-lib-web')
-const { flags } = require('@oclif/command')
+const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
 const { createWebExportFilter, runScript, buildExtensionPointPayloadWoMetadata, buildExcShellViewExtensionMetadata } = require('../../lib/app-helper')
 const rtLib = require('@adobe/aio-lib-runtime')
 const LogForwarding = require('../../lib/log-forwarding')
@@ -26,7 +24,7 @@ const LogForwarding = require('../../lib/log-forwarding')
 class Deploy extends BuildCommand {
   async run () {
     // cli input
-    const { flags } = this.parse(Deploy)
+    const { flags } = await this.parse(Deploy)
 
     // flags
     flags['web-assets'] = flags['web-assets'] && !flags['skip-web-assets'] && !flags['skip-static'] && !flags.action
@@ -260,80 +258,80 @@ This will always force a rebuild unless --no-force-build is set.
 
 Deploy.flags = {
   ...BaseCommand.flags,
-  'skip-build': flags.boolean({
+  'skip-build': Flags.boolean({
     description: '[deprecated] Please use --no-build'
   }),
-  'skip-deploy': flags.boolean({
+  'skip-deploy': Flags.boolean({
     description: '[deprecated] Please use \'aio app build\''
   }),
-  'skip-static': flags.boolean({
+  'skip-static': Flags.boolean({
     description: '[deprecated] Please use --no-web-assets'
   }),
-  'skip-web-assets': flags.boolean({
+  'skip-web-assets': Flags.boolean({
     description: '[deprecated] Please use --no-web-assets'
   }),
-  'skip-actions': flags.boolean({
+  'skip-actions': Flags.boolean({
     description: '[deprecated] Please use --no-actions'
   }),
-  actions: flags.boolean({
+  actions: Flags.boolean({
     description: '[default: true] Deploy actions if any',
     default: true,
     allowNo: true,
     exclusive: ['action'] // should be action exclusive --no-action but see https://github.com/oclif/oclif/issues/600
   }),
-  action: flags.string({
+  action: Flags.string({
     description: 'Deploy only a specific action, the flags can be specified multiple times, this will set --no-publish',
     char: 'a',
     exclusive: ['extension'],
     multiple: true
   }),
-  'web-assets': flags.boolean({
+  'web-assets': Flags.boolean({
     description: '[default: true] Deploy web-assets if any',
     default: true,
     allowNo: true
   }),
-  build: flags.boolean({
+  build: Flags.boolean({
     description: '[default: true] Run the build phase before deployment',
     default: true,
     allowNo: true
   }),
-  'force-build': flags.boolean({
+  'force-build': Flags.boolean({
     description: '[default: true] Force a build even if one already exists',
     exclusive: ['no-build'], // no-build
     default: true,
     allowNo: true
   }),
-  'content-hash': flags.boolean({
+  'content-hash': Flags.boolean({
     description: '[default: true] Enable content hashing in browser code',
     default: true,
     allowNo: true
   }),
-  open: flags.boolean({
+  open: Flags.boolean({
     description: 'Open the default web browser after a successful deploy, only valid if your app has a front-end',
     default: false
   }),
-  extension: flags.string({
+  extension: Flags.string({
     description: 'Deploy only a specific extension, the flags can be specified multiple times',
     exclusive: ['action'],
     char: 'e',
     multiple: true
   }),
-  publish: flags.boolean({
+  publish: Flags.boolean({
     description: '[default: true] Publish extension(s) to Exchange',
     allowNo: true,
     default: true,
     exclusive: ['action']
   }),
-  'force-publish': flags.boolean({
+  'force-publish': Flags.boolean({
     description: 'Force publish extension(s) to Exchange, delete previously published extension points',
     default: false,
     exclusive: ['action', 'publish'] // no-publish is excluded
   }),
-  'web-optimize': flags.boolean({
+  'web-optimize': Flags.boolean({
     description: '[default: false] Enable optimization (minification) of web js/css/html',
     default: false
   }),
-  'log-forwarding-update': flags.boolean({
+  'log-forwarding-update': Flags.boolean({
     description: '[default: true] Update log forwarding configuration on server',
     default: true,
     allowNo: true

package/src/commands/app/get-url.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 
 const chalk = require('chalk')
 
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 
 const BaseCommand = require('../../BaseCommand')
 const { wrapError } = require('../../lib/app-helper')
@@ -23,7 +23,7 @@ const { loadLocalDevConfig } = require('../../lib/run-local-runtime')
 class GetUrlCommand extends BaseCommand {
   async run () {
     // cli input
-    const { args, flags } = this.parse(GetUrlCommand)
+    const { args, flags } = await this.parse(GetUrlCommand)
 
     try {
       const options = {}
@@ -68,7 +68,7 @@ class GetUrlCommand extends BaseCommand {
       if (flags.json) {
         this.log(JSON.stringify(urls))
       } else if (flags.yml) {
-        this.log(yaml.safeDump(urls))
+        this.log(yaml.dump(urls))
       } else if (flags.hson) {
         this.log(urls)
       } else {
@@ -96,22 +96,22 @@ GetUrlCommand.description = 'Get action URLs'
 
 GetUrlCommand.flags = {
   ...BaseCommand.flags,
-  cdn: flags.boolean({
+  cdn: Flags.boolean({
     description: 'Display CDN based action URLs'
   }),
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j'
   }),
-  hson: flags.boolean({
+  hson: Flags.boolean({
     description: 'Output human readable json',
     char: 'h'
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y'
   }),
-  local: flags.boolean({
+  local: Flags.boolean({
     description: 'Display locally based action URLs'
   })
 }

package/src/commands/app/index.js

@@ -10,13 +10,13 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const HHelp = require('@oclif/plugin-help').default
+const { Help } = require('@oclif/core')
 const BaseCommand = require('../../BaseCommand')
 
 class IndexCommand extends BaseCommand {
   async run () {
-    const help = new HHelp(this.config)
-    help.showHelp(['app', '--help'])
+    const help = new Help(this.config)
+    await help.showHelp(['app', '--help'])
   }
 }
 

package/src/commands/app/info.js

@@ -11,14 +11,14 @@ governing permissions and limitations under the License.
 */
 
 const BaseCommand = require('../../BaseCommand')
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const yaml = require('js-yaml')
 const deepCopy = require('lodash.clonedeep')
 
 class Info extends BaseCommand {
   async run () {
     // cli input
-    const { flags } = this.parse(Info)
+    const { flags } = await this.parse(Info)
     const appConfig = deepCopy(this.getFullConfig({ allowNoImpl: true }))
 
     // includes .env secret delete all aio config for now
@@ -39,7 +39,7 @@ class Info extends BaseCommand {
       this.log(JSON.stringify(appConfig))
     } else if (flags.yml) {
       // remove undefined fields
-      this.log(yaml.safeDump(JSON.parse(JSON.stringify(appConfig))))
+      this.log(yaml.dump(JSON.parse(JSON.stringify(appConfig)), {}))
     } else { // flags.hson
       this.log(JSON.stringify(appConfig, null, 2))
     }
@@ -56,23 +56,23 @@ Info.description = `Display settings/configuration in use by an Adobe I/O App
 
 Info.flags = {
   ...BaseCommand.flags,
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j',
     exclusive: ['hson', 'yml']
   }),
-  hson: flags.boolean({
+  hson: Flags.boolean({
     default: true,
     description: 'Output human readable json',
     char: 'h',
     exclusive: ['json', 'yml']
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y',
     exclusive: ['hson', 'json']
   }),
-  mask: flags.boolean({
+  mask: Flags.boolean({
     description: 'Hide known private info',
     default: true,
     allowNo: true

package/src/commands/app/init.js

@@ -16,8 +16,9 @@ const fs = require('fs-extra')
 const ora = require('ora')
 const chalk = require('chalk')
 // const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:init', { provider: 'debug' })
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const generators = require('@adobe/generator-aio-app')
+const hyperlinker = require('hyperlinker')
 
 const { loadAndValidateConfigFile, importConfigJson } = require('../../lib/import')
 const { atLeastOne } = require('../../lib/app-helper')
@@ -29,7 +30,7 @@ const DEFAULT_WORKSPACE = 'Stage'
 
 class InitCommand extends AddCommand {
   async run () {
-    const { args, flags } = this.parse(InitCommand)
+    const { args, flags } = await this.parse(InitCommand)
 
     if (!flags.login && flags.workspace !== DEFAULT_WORKSPACE) {
       this.error('--no-login and --workspace flags cannot be used together.')
@@ -133,7 +134,7 @@ class InitCommand extends AddCommand {
     if (!isTermAccepted) {
       const terms = await consoleCLI.getDevTermsForOrg()
       const confirmDevTerms = await consoleCLI.prompt.promptConfirm(`${terms.text}
-      \nDo you agree with the new Developer Terms?`)
+      \nYou have not accepted the Developer Terms of Service. Go to ${hyperlinker('https://www.adobe.com/go/developer-terms', 'https://www.adobe.com/go/developer-terms')} to view the terms. Do you accept the terms? (y/n):`)
       if (!confirmDevTerms) {
         this.error('The Developer Terms of Service were declined')
       } else {
@@ -271,15 +272,15 @@ class InitCommand extends AddCommand {
 
   async runCodeGenerators (flags, extensionPoints, projectName) {
     let env = yeoman.createEnv()
+    // by default yeoman runs the install, we control installation from the app plugin
+    env.options = { skipInstall: true }
     const initialGenerators = ['base-app', 'add-ci']
     // first run app generator that will generate the root skeleton + ci
     for (const generatorKey of initialGenerators) {
       const appGen = env.instantiate(generators[generatorKey], {
         options: {
           'skip-prompt': flags.yes,
-          'project-name': projectName,
-          // by default yeoman runs the install, we control installation from the app plugin
-          'skip-install': true
+          'project-name': projectName
         }
       })
       await env.runGenerator(appGen)
@@ -289,6 +290,8 @@ class InitCommand extends AddCommand {
     // https://github.com/yeoman/environment/issues/324
 
     env = yeoman.createEnv()
+    // by default yeoman runs the install, we control installation from the app plugin
+    env.options = { skipInstall: true }
     // try to use appGen.composeWith
     for (let i = 0; i < extensionPoints.length; ++i) {
       const extGen = env.instantiate(
@@ -297,9 +300,7 @@ class InitCommand extends AddCommand {
           options: {
             'skip-prompt': flags.yes,
             // do not prompt for overwrites
-            force: true,
-            // by default yeoman runs the install, we control installation from the app plugin
-            'skip-install': true
+            force: true
           }
         })
       await env.runGenerator(extGen)
@@ -329,38 +330,38 @@ InitCommand.description = `Create a new Adobe I/O App
 
 InitCommand.flags = {
   ...AddCommand.flags,
-  yes: flags.boolean({
+  yes: Flags.boolean({
     description: 'Skip questions, and use all default values',
     default: false,
     char: 'y'
   }),
-  import: flags.string({
+  import: Flags.string({
     description: 'Import an Adobe I/O Developer Console configuration file',
     char: 'i'
   }),
-  login: flags.boolean({
+  login: Flags.boolean({
     description: 'Login using your Adobe ID for interacting with Adobe I/O Developer Console',
     default: true,
     allowNo: true
   }),
-  extensions: flags.boolean({
+  extensions: Flags.boolean({
     description: 'Use --no-extensions to create a blank application that does not integrate with Exchange',
     default: true,
     allowNo: true
   }),
-  extension: flags.string({
+  extension: Flags.string({
     description: 'Extension point(s) to implement',
     char: 'e',
     multiple: true,
     exclusive: ['extensions']
   }),
-  workspace: flags.string({
+  workspace: Flags.string({
     description: 'Specify the Adobe Developer Console Workspace to init from, defaults to Stage',
     default: DEFAULT_WORKSPACE,
     char: 'w',
     exclusive: ['import'] // also no-login
   }),
-  'confirm-new-workspace': flags.boolean({
+  'confirm-new-workspace': Flags.boolean({
     description: 'Skip and confirm prompt for creating a new workspace',
     default: false
   })

package/src/commands/app/list/extension-points.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 const BaseCommand = require('../../../BaseCommand')
 
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:list:extension-points', { provider: 'debug' })
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 
 const { EXTENSION_POINT_LIST } = require('../../../lib/defaults')
 const chalk = require('chalk')
@@ -20,14 +20,14 @@ const yaml = require('js-yaml')
 
 class ListExtensionPointsCommand extends BaseCommand {
   async run () {
-    const { flags } = this.parse(ListExtensionPointsCommand)
+    const { flags } = await this.parse(ListExtensionPointsCommand)
     aioLogger.debug(`list all extensions points with flags: ${JSON.stringify(flags)}`)
 
     // print
     if (flags.json) {
       this.log(JSON.stringify(EXTENSION_POINT_LIST))
     } else if (flags.yml) {
-      this.log(yaml.safeDump(EXTENSION_POINT_LIST))
+      this.log(yaml.dump(EXTENSION_POINT_LIST))
     } else {
       this.log(chalk.bold('Extensions Points'))
       Object.keys(EXTENSION_POINT_LIST).forEach(key => {
@@ -45,11 +45,11 @@ ListExtensionPointsCommand.description = `List all extension points for the sele
 `
 ListExtensionPointsCommand.flags = {
   ...BaseCommand.flags,
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j'
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y'
   })

package/src/commands/app/list/extension.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 const BaseCommand = require('../../../BaseCommand')
 
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:list:extensions', { provider: 'debug' })
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 
 const { EXTENSION_POINT_LIST } = require('../../../lib/defaults')
 const chalk = require('chalk')
@@ -20,7 +20,7 @@ const yaml = require('js-yaml')
 
 class ListExtensionCommand extends BaseCommand {
   async run () {
-    const { flags } = this.parse(ListExtensionCommand)
+    const { flags } = await this.parse(ListExtensionCommand)
     aioLogger.debug(`list extensions with flags: ${JSON.stringify(flags)}`)
 
     const extConfig = this.getAppExtConfigs(flags)
@@ -54,7 +54,7 @@ class ListExtensionCommand extends BaseCommand {
     if (flags.json) {
       this.log(JSON.stringify(extSummary))
     } else if (flags.yml) {
-      this.log(yaml.safeDump(extSummary))
+      this.log(yaml.dump(extSummary))
     } else {
       if (Object.keys(extSummary).length > 0) {
         this.log(chalk.bold('Extensions'))
@@ -81,11 +81,11 @@ ListExtensionCommand.description = `List implemented extensions
 `
 ListExtensionCommand.flags = {
   ...BaseCommand.flags,
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j'
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y'
   })

package/src/commands/app/list/index.js

@@ -9,13 +9,13 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const HHelp = require('@oclif/plugin-help').default
+const { Help } = require('@oclif/core')
 const BaseCommand = require('../../../BaseCommand')
 
 class ListCommand extends BaseCommand {
   async run () {
-    const help = new HHelp(this.config)
-    help.showHelp(['app:list', '--help'])
+    const help = new Help(this.config)
+    await help.showHelp(['app:list', '--help'])
   }
 }
 

package/src/commands/app/logs.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const BaseCommand = require('../../BaseCommand')
 const { wrapError } = require('../../lib/app-helper')
 const rtLib = require('@adobe/aio-lib-runtime')
@@ -35,7 +35,7 @@ class Logs extends BaseCommand {
   }
 
   async run () {
-    const { flags } = this.parse(Logs)
+    const { flags } = await this.parse(Logs)
     const fullConfig = this.getFullConfig()
 
     // has any backend
@@ -95,7 +95,7 @@ class Logs extends BaseCommand {
 
     try {
       const owConfig = { ow: Object.values(fullConfig.all)[0].ow }
-      await rtLib.printActionLogs(owConfig, this.log, flags.limit, filterActions, flags.strip, flags.poll || flags.tail || flags.watch)
+      await rtLib.printActionLogs(owConfig, this.log.bind(this), flags.limit, filterActions, flags.strip, flags.poll || flags.tail || flags.watch)
     } catch (error) {
       this.error(wrapError(error))
     }
@@ -107,34 +107,34 @@ Logs.description = `Fetch logs for an Adobe I/O App
 
 Logs.flags = {
   ...BaseCommand.flags,
-  limit: flags.integer({
+  limit: Flags.integer({
     description: 'Limit number of activations to fetch logs from ( 1-50 )',
     default: 1,
     char: 'l'
   }),
-  action: flags.string({
+  action: Flags.string({
     description: 'Fetch logs for a specific action',
     char: 'a',
     multiple: true
   }),
-  strip: flags.boolean({
+  strip: Flags.boolean({
     char: 'r',
     description: 'strip timestamp information and output first line only',
     default: false
   }),
-  tail: flags.boolean({
+  tail: Flags.boolean({
     description: 'Fetch logs continuously',
     char: 't',
     default: false,
     exclusive: ['watch', 'poll']
   }),
-  watch: flags.boolean({
+  watch: Flags.boolean({
     description: 'Fetch logs continuously',
     default: false,
     char: 'w',
     exclusive: ['tail', 'poll']
   }),
-  poll: flags.boolean({
+  poll: Flags.boolean({
     description: 'Fetch logs continuously',
     default: false,
     char: 'o',

package/src/commands/app/run.js

@@ -15,9 +15,8 @@ const chalk = require('chalk')
 const fs = require('fs-extra')
 const https = require('https')
 const getPort = require('get-port')
-const { cli } = require('cli-ux')
 
-const { flags } = require('@oclif/command')
+const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
 const coreConfig = require('@adobe/aio-lib-core-config')
 
 const BaseCommand = require('../../BaseCommand')
@@ -33,7 +32,7 @@ const CONFIG_KEY = 'aio-dev.dev-keys'
 class Run extends BaseCommand {
   async run () {
     // cli input
-    const { flags } = this.parse(Run)
+    const { flags } = await this.parse(Run)
     // aliases
     flags.actions = flags.actions && !flags['skip-actions']
 
@@ -42,7 +41,7 @@ class Run extends BaseCommand {
     const runConfigs = this.getAppExtConfigs(flags)
     const entries = Object.entries(runConfigs)
     if (entries.length > 1) {
-      this.error('You can only run one implementation at the time, please filter with the \'-e\' flag.')
+      this.error('Your app implements multiple extensions. You can only run one at the time, please select which extension to run with the \'-e\' flag.')
     }
     const name = entries[0][0]
     const config = entries[0][1]
@@ -78,7 +77,7 @@ class Run extends BaseCommand {
         shouldContentHash: false
       },
       fetchLogs: true,
-      devRemote: !flags.local,
+      isLocal: flags.local,
       verbose: flags.verbose
     }
 
@@ -203,31 +202,31 @@ Run.description = 'Run an Adobe I/O App'
 
 Run.flags = {
   ...BaseCommand.flags,
-  local: flags.boolean({
+  local: Flags.boolean({
     description: 'Run/debug actions locally ( requires Docker running )',
     exclusive: ['skip-actions']
   }),
-  serve: flags.boolean({
+  serve: Flags.boolean({
     description: '[default: true] Start frontend server (experimental)',
     default: true,
     allowNo: true
   }),
-  'skip-actions': flags.boolean({
+  'skip-actions': Flags.boolean({
     description: '[deprecated] Please use --no-actions',
     exclusive: ['local'],
     default: false
   }),
-  actions: flags.boolean({
+  actions: Flags.boolean({
     description: '[default: true] Run actions, defaults to true, to skip actions use --no-actions',
     exclusive: ['local'], // no-actions and local don't work together
     default: true,
     allowNo: true
   }),
-  open: flags.boolean({
+  open: Flags.boolean({
     description: 'Open the default web browser after a successful run, only valid if your app has a front-end',
     default: false
   }),
-  extension: flags.string({
+  extension: Flags.string({
     description: 'Run only a specific extension, this flag can only be specified once',
     char: 'e',
     // we do not support multiple yet

package/src/commands/app/test.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 
 const { runScript } = require('../../lib/app-helper')
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const BaseCommand = require('../../BaseCommand')
 const chalk = require('chalk')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:test', { provider: 'debug' })
@@ -19,7 +19,7 @@ const path = require('path')
 
 class Test extends BaseCommand {
   async run () {
-    const { flags } = this.parse(Test)
+    const { flags } = await this.parse(Test)
     let { all, unit, e2e, action, extension } = flags
 
     // 'all' overrides the setting of either the unit or e2e flag
@@ -201,27 +201,27 @@ class Test extends BaseCommand {
 }
 
 Test.flags = {
-  extension: flags.string({
+  extension: Flags.string({
     char: 'e',
     description: 'the extension(s) to test',
     exclusive: ['action'],
     multiple: true
   }),
-  action: flags.string({
+  action: Flags.string({
     char: 'a',
     description: 'the action(s) to test',
     exclusive: ['extension'],
     multiple: true
   }),
-  all: flags.boolean({
+  all: Flags.boolean({
     description: 'run both unit and e2e tests',
     default: false
   }),
-  e2e: flags.boolean({
+  e2e: Flags.boolean({
     description: 'run e2e tests',
     default: false
   }),
-  unit: flags.boolean({
+  unit: Flags.boolean({
     description: 'run unit tests',
     default: false
   })