feat. Oclif v2 migration (#171)

* oclif v2 migration

Co-authored-by: Jesse MacFadyen <purplecabbage@gmail.com>

Author: florind-ens

package.json

@@ -10,36 +10,29 @@
     "@adobe/aio-lib-core-logging": "^1.1.0",
     "@adobe/aio-lib-env": "^1.1.0",
     "@adobe/aio-lib-ims": "^5.0.0",
-    "@oclif/command": "^1",
-    "@oclif/config": "1.15.1",
-    "@oclif/errors": "^1.1.2",
-    "@oclif/plugin-help": "^2.2.3",
-    "cli-ux": "^5.4.5",
+    "@oclif/core": "^1.4.0",
     "js-yaml": "^3.13.1"
   },
   "devDependencies": {
     "@adobe/eslint-config-aio-lib-config": "^1.4.0",
     "@babel/core": "^7.9.6",
-    "@oclif/dev-cli": "^1",
-    "@oclif/test": "^1",
-    "@types/jest": "^26.0.20",
-    "babel-jest": "^26.0.1",
+    "@types/jest": "^27.4.1",
+    "babel-jest": "^27.5.1",
     "babel-runtime": "^6.26.0",
     "chalk": "^4.0.0",
     "eol": "^0.9.1",
     "eslint": "^7.32.0",
-    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif": "^4.0.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jest": "^23.20.0",
     "eslint-plugin-jsdoc": "^37.5.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "eslint-plugin-standard": "^4.0.1",
     "execa": "^4.0.0",
     "jest": "^27",
-    "jest-haste-map": "^25.1.0",
-    "jest-junit": "^10.0.0",
+    "jest-haste-map": "^27.5.1",
+    "jest-junit": "^13.0.0",
     "jest-plugin-fs": "^2.9.0",
     "stdout-stderr": "^0.1.9",
     "typescript": "^4.5.4"
@@ -61,9 +54,6 @@
   "oclif": {
     "commands": "./src/commands",
     "bin": "aio",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
     "hooks": {
       "init": "./src/hooks/upgrade-config-hook.js"
     },

src/commands/console/index.js

@@ -12,19 +12,18 @@ governing permissions and limitations under the License.
 
 const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-console', { provider: 'debug' })
 const config = require('@adobe/aio-lib-core-config')
-const { Command, flags } = require('@oclif/command')
+const { Command, Flags, Help } = require('@oclif/core')
 const { getToken, context } = require('@adobe/aio-lib-ims')
 const LibConsoleCLI = require('@adobe/aio-cli-lib-console')
 const { CLI } = require('@adobe/aio-lib-ims/src/context')
-const Help = require('@oclif/plugin-help').default
+const { getCliEnv } = require('@adobe/aio-lib-env')
 const yaml = require('js-yaml')
 const { CONFIG_KEYS, API_KEYS } = require('../../config')
-const { getCliEnv } = require('@adobe/aio-lib-env')
 
 class ConsoleCommand extends Command {
   async run () {
     const help = new Help(this.config)
-    help.showHelp(['console', '--help'])
+    await help.showHelp(['console', '--help'])
   }
 
   async initSdk () {
@@ -133,7 +132,7 @@ ConsoleCommand.description = 'Console plugin for the Adobe I/O CLI'
 
 // common flags
 ConsoleCommand.flags = {
-  help: flags.boolean({ description: 'Show help' })
+  help: Flags.boolean({ description: 'Show help' })
 }
 
 module.exports = ConsoleCommand

src/commands/console/org/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 Help = require('@oclif/plugin-help').default
+const { Help } = require('@oclif/core')
 const ConsoleCommand = require('../')
 
 class IndexCommand extends ConsoleCommand {
   async run () {
     const help = new Help(this.config)
-    help.showHelp(['console:org', '--help'])
+    await help.showHelp(['console:org', '--help'])
   }
 }
 

src/commands/console/org/list.js

@@ -11,15 +11,14 @@ governing permissions and limitations under the License.
 */
 
 const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-console:org:list', { provider: 'debug' })
-const { flags } = require('@oclif/command')
-const { cli } = require('cli-ux')
+const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
 const { ORG_TYPE_ENTERPRISE } = require('../../../config')
 
 const ConsoleCommand = require('../index')
 
 class ListCommand extends ConsoleCommand {
   async run () {
-    const { flags } = this.parse(ListCommand)
+    const { flags } = await this.parse(ListCommand)
 
     await this.initSdk()
 
@@ -82,12 +81,12 @@ ListCommand.description = 'List your Organizations'
 
 ListCommand.flags = {
   ...ConsoleCommand.flags,
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j',
     exclusive: ['yml']
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y',
     exclusive: ['json']

src/commands/console/org/select.js

@@ -16,7 +16,7 @@ const ConsoleCommand = require('../index')
 
 class SelectCommand extends ConsoleCommand {
   async run () {
-    const { args } = this.parse(SelectCommand)
+    const { args } = await this.parse(SelectCommand)
 
     await this.initSdk()
 

src/commands/console/project/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 Help = require('@oclif/plugin-help').default
+const { Help } = require('@oclif/core')
 const ConsoleCommand = require('../')
 
 class IndexCommand extends ConsoleCommand {
   async run () {
     const help = new Help(this.config)
-    help.showHelp(['console:project', '--help'])
+    await help.showHelp(['console:project', '--help'])
   }
 }
 

src/commands/console/project/list.js

@@ -10,14 +10,12 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-console:project:list', { provider: 'debug' })
-const { flags } = require('@oclif/command')
-const { cli } = require('cli-ux')
+const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
 const ConsoleCommand = require('../index')
 
 class ListCommand extends ConsoleCommand {
   async run () {
-    const { flags } = this.parse(ListCommand)
-
+    const { flags } = await this.parse(ListCommand)
     const orgId = flags.orgId || this.getConfig('org.id')
     if (!orgId) {
       this.log('You have not selected an Organization. Please select first.')
@@ -50,7 +48,7 @@ class ListCommand extends ConsoleCommand {
    * Retrieve projects from an Org
    *
    * @param {string} orgId organization id
-   * @returns {Array} Projects
+   * @returns {Promise<Array>} Projects
    */
   async getConsoleOrgProjects (orgId) {
     const response = await this.consoleCLI.getProjects(orgId)
@@ -77,15 +75,15 @@ ListCommand.description = 'List your Projects for the selected Organization'
 
 ListCommand.flags = {
   ...ConsoleCommand.flags,
-  orgId: flags.string({
+  orgId: Flags.string({
     description: 'OrgID for listing projects'
   }),
-  json: flags.boolean({
+  json: Flags.boolean({
     description: 'Output json',
     char: 'j',
     exclusive: ['yml']
   }),
-  yml: flags.boolean({
+  yml: Flags.boolean({
     description: 'Output yml',
     char: 'y',
     exclusive: ['json']

src/commands/console/project/select.js

@@ -10,14 +10,14 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-console:project:select', { provider: 'debug' })
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const { CONFIG_KEYS } = require('../../../config')
 
 const ConsoleCommand = require('../index')
 
 class SelectCommand extends ConsoleCommand {
   async run () {
-    const { args, flags } = this.parse(SelectCommand)
+    const { args, flags } = await this.parse(SelectCommand)
 
     const orgId = flags.orgId || this.getConfig(`${CONFIG_KEYS.ORG}.id`)
 
@@ -69,7 +69,7 @@ SelectCommand.args = [
 
 SelectCommand.flags = {
   ...ConsoleCommand.flags,
-  orgId: flags.string({
+  orgId: Flags.string({
     description: 'Organization id of the Console Project to select'
   })
 }

src/commands/console/publickey/delete.js

@@ -10,13 +10,13 @@ governing permissions and limitations under the License.
 */
 
 const aioConsoleLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-console:publickey:list', { provider: 'debug' })
-const { flags } = require('@oclif/command')
+const { Flags } = require('@oclif/core')
 const { CONFIG_KEYS } = require('../../../config')
 const ConsoleCommand = require('../index')
 
 class DeleteCommand extends ConsoleCommand {
   async run () {
-    const { args, flags } = this.parse(DeleteCommand)
+    const { args, flags } = await this.parse(DeleteCommand)
 
     const orgId = flags.orgId || this.getConfig(`${CONFIG_KEYS.ORG}.id`)
     if (!orgId) {
@@ -72,13 +72,13 @@ DeleteCommand.description = 'Delete a public key certificate from the selected W
 
 DeleteCommand.flags = {
   ...ConsoleCommand.flags,
-  orgId: flags.string({
+  orgId: Flags.string({
     description: 'Organization id of the Console Workspace to delete the public key certificate from'
   }),
-  projectId: flags.string({
+  projectId: Flags.string({
     description: 'Project id of the Console Workspace to delete the public key certificate from'
   }),
-  workspaceId: flags.string({
+  workspaceId: Flags.string({
     description: 'Workspace id of the Console Workspace to delete the public key certificate from'
   })
 }

src/commands/console/publickey/index.js

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