feat: use @oclif/core v2 (#536)

* feat: use @oclif/core v2

* chore: bump oclif/test

package.json

@@ -6,7 +6,7 @@
  "bugs": "https://github.com/oclif/plugin-plugins/issues",
  "dependencies": {
  "@oclif/color": "^1.0.2",
- "@oclif/core": "^1.23.0",
+ "@oclif/core": "^2.0.2-beta.6",
  "chalk": "^4.1.2",
  "debug": "^4.3.4",
  "fs-extra": "^9.0",
@@ -20,7 +20,7 @@
  "devDependencies": {
  "@commitlint/config-conventional": "^12.1.4",
  "@oclif/plugin-help": "^5.1.22",
- "@oclif/test": "^2.2.19",
+ "@oclif/test": "^2.2.21",
  "@types/chai": "^4.3.4",
  "@types/fs-extra": "^9.0",
  "@types/mocha": "^8.2.3",
@@ -76,7 +76,7 @@
  "clean": "shx rm -f oclif.manifest.json",
  "lint": "eslint . --ext .ts --config .eslintrc",
  "pretest": "yarn build && tsc -p test --noEmit",
- "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+ "test": "mocha \"test/**/*.test.ts\"",
  "posttest": "yarn lint",
  "prepublishOnly": "yarn run build && oclif manifest . && oclif readme",
  "postpublish": "yarn run clean",

src/commands/plugins/index.ts

@@ -1,5 +1,5 @@
 import color from '@oclif/color'
-import {Command, Flags, Plugin, CliUx} from '@oclif/core'
+import {Command, Flags, Plugin, ux} from '@oclif/core'
 
 import Plugins from '../../plugins'
 import {sortBy} from '../../util'
@@ -42,7 +42,7 @@ export default class PluginsIndex extends Command {
  }
 
  private createTree(plugin: Plugin) {
- const tree = CliUx.ux.tree()
+ const tree = ux.tree()
  for (const p of plugin.children) {
  const name = this.formatPlugin(p)
  tree.insert(name, this.createTree(p))

src/commands/plugins/inspect.ts

@@ -1,5 +1,5 @@
 import * as path from 'path'
-import {Command, Flags, Plugin, CliUx} from '@oclif/core'
+import {Args, Command, Flags, Plugin, ux} from '@oclif/core'
 import * as chalk from 'chalk'
 import * as fs from 'fs-extra'
 
@@ -25,9 +25,13 @@ export default class PluginsInspect extends Command {
 
  static strict = false;
 
- static args = [
- {name: 'plugin', description: 'Plugin to inspect.', required: true, default: '.'},
- ];
+ static args = {
+ plugin: Args.string({
+ description: 'Plugin to inspect.',
+ required: true,
+ default: '.',
+ }),
+ }
 
  static flags = {
  help: Flags.help({char: 'h'}),
@@ -43,7 +47,7 @@ export default class PluginsInspect extends Command {
  const {flags, argv} = await this.parse(PluginsInspect)
  if (flags.verbose) this.plugins.verbose = true
  const aliases = this.config.pjson.oclif.aliases || {}
- for (let name of argv) {
+ for (let name of argv as string[]) {
  if (name === '.') {
  const pkgJson = JSON.parse(await fs.readFile('package.json', 'utf-8'))
  name = pkgJson.name
@@ -84,7 +88,7 @@ export default class PluginsInspect extends Command {
 
  async inspect(pluginName: string, verbose = false): Promise<void> {
  const plugin = this.findPlugin(pluginName)
- const tree = CliUx.ux.tree()
+ const tree = ux.tree()
  const pluginHeader = chalk.bold.cyan(plugin.name)
  tree.insert(pluginHeader)
  tree.nodes[pluginHeader].insert(`version ${plugin.version}`)

src/commands/plugins/install.ts

@@ -1,4 +1,4 @@
-import {Command, Flags, CliUx} from '@oclif/core'
+import {Command, Flags, ux, Args} from '@oclif/core'
 import * as chalk from 'chalk'
 
 import Plugins from '../../plugins'
@@ -22,9 +22,9 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
 
  static strict = false;
 
- static args = [
- {name: 'plugin', description: 'Plugin to install.', required: true},
- ];
+ static args = {
+ plugin: Args.string({description: 'Plugin to install.', required: true}),
+ };
 
  static flags = {
  help: Flags.help({char: 'h'}),
@@ -46,7 +46,7 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
  const {flags, argv} = await this.parse(PluginsInstall)
  if (flags.verbose) this.plugins.verbose = true
  const aliases = this.config.pjson.oclif.aliases || {}
- for (let name of argv) {
+ for (let name of argv as string[]) {
  if (aliases[name] === null) this.error(`${name} is blocked`)
  name = aliases[name] || name
  const p = await this.parsePlugin(name)
@@ -56,23 +56,23 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
  })
  try {
  if (p.type === 'npm') {
- CliUx.ux.action.start(
+ ux.action.start(
  `Installing plugin ${chalk.cyan(this.plugins.friendlyName(p.name))}`,
  )
  plugin = await this.plugins.install(p.name, {
  tag: p.tag,
  force: flags.force,
  })
  } else {
- CliUx.ux.action.start(`Installing plugin ${chalk.cyan(p.url)}`)
+ ux.action.start(`Installing plugin ${chalk.cyan(p.url)}`)
  plugin = await this.plugins.install(p.url, {force: flags.force})
  }
  } catch (error) {
- CliUx.ux.action.stop(chalk.bold.red('failed'))
+ ux.action.stop(chalk.bold.red('failed'))
  throw error
  }
 
- CliUx.ux.action.stop(`installed v${plugin.version}`)
+ ux.action.stop(`installed v${plugin.version}`)
  }
  }
  /* eslint-enable no-await-in-loop */

src/commands/plugins/link.ts

@@ -1,4 +1,4 @@
-import {Command, Flags, CliUx} from '@oclif/core'
+import {Args, Command, Flags, ux} from '@oclif/core'
 import * as chalk from 'chalk'
 
 import Plugins from '../../plugins'
@@ -14,7 +14,9 @@ e.g. If you have a user-installed or core plugin that has a 'hello' command, ins
 
  static examples = ['$ <%= config.bin %> plugins:link <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
 
- static args = [{name: 'path', description: 'path to plugin', required: true, default: '.'}]
+ static args = {
+ path: Args.string({name: 'path', description: 'path to plugin', required: true, default: '.'}),
+ }
 
  static flags = {
  help: Flags.help({char: 'h'}),
@@ -26,8 +28,8 @@ e.g. If you have a user-installed or core plugin that has a 'hello' command, ins
  async run(): Promise<void> {
  const {flags, args} = await this.parse(PluginsLink)
  this.plugins.verbose = flags.verbose
- CliUx.ux.action.start(`Linking plugin ${chalk.cyan(args.path)}`)
+ ux.action.start(`Linking plugin ${chalk.cyan(args.path)}`)
  await this.plugins.link(args.path)
- CliUx.ux.action.stop()
+ ux.action.stop()
  }
 }

src/commands/plugins/uninstall.ts

@@ -1,4 +1,4 @@
-import {Command, Flags, Plugin, Interfaces, CliUx} from '@oclif/core'
+import {Command, Flags, Plugin, Interfaces, ux, Args} from '@oclif/core'
 import * as chalk from 'chalk'
 
 import Plugins from '../../plugins'
@@ -15,7 +15,9 @@ export default class PluginsUninstall extends Command {
 
  static variableArgs = true
 
- static args = [{name: 'plugin', description: 'plugin to uninstall'}]
+ static args = {
+ plugin: Args.string({description: 'plugin to uninstall'}),
+ }
 
  static flags = {
  help: Flags.help({char: 'h'}),
@@ -34,9 +36,9 @@ export default class PluginsUninstall extends Command {
  this.plugins = new Plugins(this.config)
  if (flags.verbose) this.plugins.verbose = true
  if (argv.length === 0) argv.push('.')
- for (const plugin of argv) {
+ for (const plugin of argv as string[]) {
  const friendly = this.removeTags(this.plugins.friendlyName(plugin))
- CliUx.ux.action.start(`Uninstalling ${friendly}`)
+ ux.action.start(`Uninstalling ${friendly}`)
  const unfriendly = await this.plugins.hasPlugin(this.removeTags(plugin))
  if (!unfriendly) {
  const p = this.config.plugins.find(p => p.name === plugin) as Plugin | undefined
@@ -51,11 +53,11 @@ export default class PluginsUninstall extends Command {
  const {name} = unfriendly as Interfaces.PJSON.User | Interfaces.PJSON.PluginTypes.Link
  await this.plugins.uninstall(name)
  } catch (error) {
- CliUx.ux.action.stop(chalk.bold.red('failed'))
+ ux.action.stop(chalk.bold.red('failed'))
  throw error
  }
 
- CliUx.ux.action.stop()
+ ux.action.stop()
  }
  }
  /* eslint-enable no-await-in-loop */

src/plugins.ts

@@ -1,4 +1,4 @@
-import {Errors, Config, Interfaces, CliUx} from '@oclif/core'
+import {Errors, Config, Interfaces, ux} from '@oclif/core'
 import * as fs from 'fs'
 import * as fse from 'fs-extra'
 import loadJSON from 'load-json-file'
@@ -143,7 +143,7 @@ export default class Plugins {
 
  async link(p: string): Promise<void> {
  const c = await Config.load(path.resolve(p))
- CliUx.ux.action.start(`${this.config.name}: linking plugin ${c.name}`)
+ ux.action.start(`${this.config.name}: linking plugin ${c.name}`)
  if (
  !c.valid &&
  !this.config.plugins.find(p => p.name === '@oclif/plugin-legacy')
@@ -189,7 +189,7 @@ export default class Plugins {
  })
  }
  } catch (error: any) {
- CliUx.ux.warn(error)
+ ux.warn(error)
  } finally {
  await this.remove(name)
  }
@@ -203,7 +203,7 @@ export default class Plugins {
  (p): p is Interfaces.PJSON.PluginTypes.User => p.type === 'user',
  )
  if (plugins.length === 0) return
- CliUx.ux.action.start(`${this.config.name}: Updating plugins`)
+ ux.action.start(`${this.config.name}: Updating plugins`)
 
  // migrate deprecated plugins
  const aliases = this.config.pjson.oclif.aliases || {}
@@ -236,7 +236,7 @@ export default class Plugins {
  )
  }
 
- CliUx.ux.action.stop()
+ ux.action.stop()
  }
  /* eslint-enable no-await-in-loop */
 
@@ -268,7 +268,7 @@ export default class Plugins {
  )
  return f.nodeVersion
  } catch (error: any) {
- if (error.code !== 'ENOENT') CliUx.ux.warn(error)
+ if (error.code !== 'ENOENT') ux.warn(error)
  }
  }
 

src/yarn.ts

@@ -1,4 +1,4 @@
-import {Interfaces, CliUx} from '@oclif/core'
+import {Interfaces, ux} from '@oclif/core'
 import NpmRunPath from 'npm-run-path'
 import * as path from 'path'
 
@@ -23,7 +23,7 @@ export default class Yarn {
  forked.stdout.setEncoding('utf8')
  forked.stdout.on('data', (d: any) => {
  if (options.verbose) process.stdout.write(d)
- else CliUx.ux.action.status = d.replace(/\n$/, '').split('\n').pop()
+ else ux.action.status = d.replace(/\n$/, '').split('\n').pop()
  })
 
  forked.on('error', reject)