feat!: use npm for plugin operations

README.md

@@ -91,9 +91,9 @@ For removing plugins that are no longer needed (either because they're sunset or
 - [`mycli plugins`](#mycli-plugins)
 - [`mycli plugins:inspect PLUGIN...`](#mycli-pluginsinspect-plugin)
 - [`mycli plugins:install PLUGIN...`](#mycli-pluginsinstall-plugin)
-- [`mycli plugins:link PLUGIN`](#mycli-pluginslink-plugin)
+- [`mycli plugins link PATH`](#mycli-plugins-link-path)
 - [`mycli plugins reset`](#mycli-plugins-reset)
-- [`mycli plugins:uninstall PLUGIN...`](#mycli-pluginsuninstall-plugin)
+- [`mycli plugins uninstall [PLUGIN]`](#mycli-plugins-uninstall-plugin)
 - [`mycli plugins update`](#mycli-plugins-update)
 
 ## `mycli plugins`
@@ -117,7 +117,7 @@ EXAMPLES
   $ mycli plugins
 ```
 
-_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/index.ts)_
+_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/index.ts)_
 
 ## `mycli plugins:inspect PLUGIN...`
 
@@ -144,7 +144,7 @@ EXAMPLES
   $ mycli plugins inspect myplugin
 ```
 
-_See code: [src/commands/plugins/inspect.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/inspect.ts)_
+_See code: [src/commands/plugins/inspect.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/inspect.ts)_
 
 ## `mycli plugins:install PLUGIN...`
 
@@ -158,10 +158,10 @@ ARGUMENTS
   PLUGIN  Plugin to install.
 
 FLAGS
-  -f, --force    Run yarn install with force flag.
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
   -h, --help     Show CLI help.
-  -s, --silent   Silences yarn output.
-  -v, --verbose  Show verbose yarn output.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -188,15 +188,15 @@ EXAMPLES
   $ mycli plugins install someuser/someplugin
 ```
 
-_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/install.ts)_
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/install.ts)_
 
-## `mycli plugins:link PLUGIN`
+## `mycli plugins link PATH`
 
 Links a plugin into the CLI for development.
 
 ```
 USAGE
-  $ mycli plugins link PLUGIN
+  $ mycli plugins link PATH [-h] [--install] [-v]
 
 ARGUMENTS
   PATH  [default: .] path to plugin
@@ -218,7 +218,7 @@ EXAMPLES
   $ mycli plugins link myplugin
 ```
 
-_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/link.ts)_
+_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/link.ts)_
 
 ## `mycli plugins reset`
 
@@ -233,15 +233,15 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [src/commands/plugins/reset.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/reset.ts)_
+_See code: [src/commands/plugins/reset.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/reset.ts)_
 
-## `mycli plugins:uninstall PLUGIN...`
+## `mycli plugins uninstall [PLUGIN]`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ mycli plugins uninstall PLUGIN...
+  $ mycli plugins uninstall [PLUGIN] [-h] [-v]
 
 ARGUMENTS
   PLUGIN  plugin to uninstall
@@ -261,7 +261,7 @@ EXAMPLES
   $ mycli plugins uninstall myplugin
 ```
 
-_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/uninstall.ts)_
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/uninstall.ts)_
 
 ## `mycli plugins update`
 
@@ -279,6 +279,6 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/4.3.5/src/commands/plugins/update.ts)_
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/update.ts)_
 
 <!-- commandsstop -->

package.json

@@ -1,19 +1,18 @@
 {
   "name": "@oclif/plugin-plugins",
   "description": "plugins plugin for oclif",
-  "version": "4.3.5",
+  "version": "5.0.0-beta.4",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-plugins/issues",
   "dependencies": {
     "@oclif/core": "^3.23.0",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",
     "npm": "10.2.4",
-    "npm-run-path": "^4.0.1",
+    "npm-package-arg": "^11.0.1",
+    "npm-run-path": "^5.2.0",
     "semver": "^7.6.0",
-    "shelljs": "^0.8.5",
-    "validate-npm-package-name": "^5.0.0",
-    "yarn": "^1.22.21"
+    "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^18",
@@ -23,6 +22,7 @@
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.6",
     "@types/node": "^18",
+    "@types/npm-package-arg": "^6.1.4",
     "@types/semver": "^7.5.8",
     "@types/shelljs": "^0.8.15",
     "@types/sinon": "^17",
@@ -50,8 +50,7 @@
   "files": [
     "oclif.manifest.json",
     "/lib",
-    "npm-shrinkwrap.json",
-    "oclif.lock"
+    "npm-shrinkwrap.json"
   ],
   "homepage": "https://github.com/oclif/plugin-plugins",
   "keywords": [
@@ -77,12 +76,12 @@
   "repository": "oclif/plugin-plugins",
   "scripts": {
     "build": "shx rm -rf lib && tsc",
-    "clean": "shx rm -f oclif.manifest.json npm-shrinkwrap.json oclif.lock",
+    "clean": "shx rm -f oclif.manifest.json npm-shrinkwrap.json",
     "compile": "tsc",
     "lint": "eslint . --ext .ts",
     "postpack": "yarn run clean",
     "posttest": "yarn lint",
-    "prepack": "yarn build && oclif manifest && oclif readme && npm shrinkwrap && oclif lock",
+    "prepack": "yarn build && oclif manifest && oclif readme && npm shrinkwrap",
     "prepare": "husky && yarn build",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit",
     "test:integration:install": "mocha \"test/**/install.integration.ts\"",

src/commands/plugins/index.ts

@@ -17,10 +17,14 @@ export default class PluginsIndex extends Command {
     core: Flags.boolean({description: 'Show core plugins.'}),
   }
 
-  plugins = new Plugins(this.config)
+  plugins!: Plugins
 
   async run(): Promise<PluginsJson> {
     const {flags} = await this.parse(PluginsIndex)
+    this.plugins = new Plugins({
+      config: this.config,
+    })
+
     let plugins = this.config.getPluginsList()
     sortBy(plugins, (p) => this.plugins.friendlyName(p.name))
     if (!flags.core) {

src/commands/plugins/inspect.ts

@@ -59,7 +59,7 @@ export default class PluginsInspect extends Command {
 
   static usage = 'plugins:inspect PLUGIN...'
 
-  plugins = new Plugins(this.config)
+  plugins!: Plugins
 
   async findDep(plugin: Plugin, dependency: string): Promise<{pkgPath: null | string; version: null | string}> {
     const dependencyPath = join(...dependency.split('/'))
@@ -140,7 +140,10 @@ export default class PluginsInspect extends Command {
   /* eslint-disable no-await-in-loop */
   async run(): Promise<PluginWithDeps[]> {
     const {argv, flags} = await this.parse(PluginsInspect)
-    if (flags.verbose) this.plugins.verbose = true
+    this.plugins = new Plugins({
+      config: this.config,
+      verbose: flags.verbose,
+    })
     const aliases = this.config.pjson.oclif.aliases ?? {}
     const plugins: PluginWithDeps[] = []
     for (let name of argv as string[]) {

src/commands/plugins/install.ts

@@ -4,7 +4,6 @@ import chalk from 'chalk'
 import validate from 'validate-npm-package-name'
 
 import Plugins from '../../plugins.js'
-import {YarnMessagesCache} from '../../util.js'
 
 export default class PluginsInstall extends Command {
   static aliases = ['plugins:add']
@@ -32,7 +31,7 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
   static flags = {
     force: Flags.boolean({
       char: 'f',
-      description: 'Run yarn install with force flag.',
+      description: 'Force npm to fetch remote resources even if a local copy exists on disk.',
     }),
     help: Flags.help({char: 'h'}),
     jit: Flags.boolean({
@@ -46,7 +45,7 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
         const jitPluginsConfig = ctx.config.pjson.oclif.jitPlugins ?? {}
         if (Object.keys(jitPluginsConfig).length === 0) return input
 
-        const plugins = new Plugins(ctx.config)
+        const plugins = new Plugins({config: ctx.config})
 
         const nonJitPlugins = await Promise.all(
           requestedPlugins.map(async (plugin) => {
@@ -65,12 +64,13 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
     }),
     silent: Flags.boolean({
       char: 's',
-      description: 'Silences yarn output.',
+      default: true,
+      description: 'Silences npm output.',
       exclusive: ['verbose'],
     }),
     verbose: Flags.boolean({
       char: 'v',
-      description: 'Show verbose yarn output.',
+      description: 'Show verbose npm output.',
       exclusive: ['silent'],
     }),
   }
@@ -80,11 +80,13 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
   static usage = 'plugins:install PLUGIN...'
 
   flags!: Interfaces.InferredFlags<typeof PluginsInstall.flags>
-  plugins = new Plugins(this.config)
 
   // In this case we want these operations to happen
   // sequentially so the `no-await-in-loop` rule is ignored
-  async parsePlugin(input: string): Promise<{name: string; tag: string; type: 'npm'} | {type: 'repo'; url: string}> {
+  async parsePlugin(
+    plugins: Plugins,
+    input: string,
+  ): Promise<{name: string; tag: string; type: 'npm'} | {type: 'repo'; url: string}> {
     // git ssh url
     if (input.startsWith('git+ssh://') || input.endsWith('.git')) {
       return {type: 'repo', url: input}
@@ -93,7 +95,7 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
     const getNameAndTag = async (input: string): Promise<{name: string; tag: string}> => {
       const regexAtSymbolNotAtBeginning = /(?<!^)@/
       const [splitName, tag = 'latest'] = input.split(regexAtSymbolNotAtBeginning)
-      const name = splitName.startsWith('@') ? splitName : await this.plugins.maybeUnfriendlyName(splitName)
+      const name = splitName.startsWith('@') ? splitName : await plugins.maybeUnfriendlyName(splitName)
       validateNpmPkgName(name)
 
       if (this.flags.jit) {
@@ -135,39 +137,39 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
   async run(): Promise<void> {
     const {argv, flags} = await this.parse(PluginsInstall)
     this.flags = flags
-    if (flags.verbose && !flags.silent) this.plugins.verbose = true
-    if (flags.silent && !flags.verbose) this.plugins.silent = true
+
+    const plugins = new Plugins({
+      config: this.config,
+      verbose: this.flags.verbose,
+    })
     const aliases = this.config.pjson.oclif.aliases || {}
     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)
+      const p = await this.parsePlugin(plugins, name)
       let plugin
       await this.config.runHook('plugins:preinstall', {
         plugin: p,
       })
       try {
         if (p.type === 'npm') {
-          ux.action.start(`Installing plugin ${chalk.cyan(this.plugins.friendlyName(p.name) + '@' + p.tag)}`)
-          plugin = await this.plugins.install(p.name, {
+          ux.action.start(
+            `${this.config.name}: Installing plugin ${chalk.cyan(plugins.friendlyName(p.name) + '@' + p.tag)}`,
+          )
+          plugin = await plugins.install(p.name, {
             force: flags.force,
             tag: p.tag,
           })
         } else {
-          ux.action.start(`Installing plugin ${chalk.cyan(p.url)}`)
-          plugin = await this.plugins.install(p.url, {force: flags.force})
+          ux.action.start(`${this.config.name}: Installing plugin ${chalk.cyan(p.url)}`)
+          plugin = await plugins.install(p.url, {force: flags.force})
         }
       } catch (error) {
         ux.action.stop(chalk.bold.red('failed'))
-        YarnMessagesCache.getInstance().flush(plugin)
         throw error
       }
 
       ux.action.stop(`installed v${plugin.version}`)
-
-      YarnMessagesCache.getInstance().flush(plugin)
-
-      this.log(chalk.green(`\nSuccessfully installed ${plugin.name} v${plugin.version}`))
     }
   }
 }

src/commands/plugins/link.ts

@@ -2,7 +2,6 @@ import {Args, Command, Flags, ux} from '@oclif/core'
 import chalk from 'chalk'
 
 import Plugins from '../../plugins.js'
-import {YarnMessagesCache} from '../../util.js'
 
 export default class PluginsLink extends Command {
   static args = {
@@ -27,17 +26,16 @@ e.g. If you have a user-installed or core plugin that has a 'hello' command, ins
     verbose: Flags.boolean({char: 'v'}),
   }
 
-  static usage = 'plugins:link PLUGIN'
-
-  plugins = new Plugins(this.config)
-
   async run(): Promise<void> {
     const {args, flags} = await this.parse(PluginsLink)
-    this.plugins.verbose = flags.verbose
-    ux.action.start(`Linking plugin ${chalk.cyan(args.path)}`)
-    await this.plugins.link(args.path, {install: flags.install})
-    ux.action.stop()
 
-    YarnMessagesCache.getInstance().flush()
+    const plugins = new Plugins({
+      config: this.config,
+      verbose: flags.verbose,
+    })
+
+    ux.action.start(`${this.config.name}: Linking plugin ${chalk.cyan(args.path)}`)
+    await plugins.link(args.path, {install: flags.install})
+    ux.action.stop()
   }
 }

src/commands/plugins/reset.ts

@@ -20,7 +20,9 @@ export default class Reset extends Command {
 
   async run(): Promise<void> {
     const {flags} = await this.parse(Reset)
-    const plugins = new Plugins(this.config)
+    const plugins = new Plugins({
+      config: this.config,
+    })
     const userPlugins = await plugins.list()
 
     this.log(`Found ${userPlugins.length} plugin${userPlugins.length === 0 ? '' : 's'}:`)