fix: use templates for examples (#719)

oclif · Nov 13, 2023 · c2a3f43 · c2a3f43
1 parent 93fa155
commit c2a3f43
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 11 deletions.
diff --git a/src/commands/plugins/index.ts b/src/commands/plugins/index.ts
@@ -11,7 +11,7 @@ export default class PluginsIndex extends Command {
   static description = 'List installed plugins.'
   static enableJsonFlag = true
 
-  static examples = ['$ <%- config.bin %> plugins']
+  static examples = ['<%= config.bin %> <%= command.id %>']
 
   static flags = {
     core: Flags.boolean({description: 'Show core plugins.'}),

diff --git a/src/commands/plugins/inspect.ts b/src/commands/plugins/inspect.ts
@@ -48,7 +48,7 @@ export default class PluginsInspect extends Command {
 
   static enableJsonFlag = true
 
-  static examples = ['$ <%= config.bin %> plugins:inspect <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
+  static examples = ['<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
 
   static flags = {
     help: Flags.help({char: 'h'}),

diff --git a/src/commands/plugins/install.ts b/src/commands/plugins/install.ts
@@ -24,9 +24,9 @@ e.g. If you have a core plugin that has a 'hello' command, installing a user-ins
   public static enableJsonFlag = true
 
   static examples = [
-    '$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || "myplugin" %> ',
-    '$ <%= config.bin %> plugins:install https://github.com/someuser/someplugin',
-    '$ <%= config.bin %> plugins:install someuser/someplugin',
+    '<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || "myplugin" %> ',
+    '<%= config.bin %> <%= command.id %> https://github.com/someuser/someplugin',
+    '<%= config.bin %> <%= command.id %> someuser/someplugin',
   ]
 
   static flags = {

diff --git a/src/commands/plugins/link.ts b/src/commands/plugins/link.ts
@@ -15,7 +15,7 @@ Installation of a linked plugin will override a user-installed or core plugin.
 e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
 `
 
-  static examples = ['$ <%= config.bin %> plugins:link <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
+  static examples = ['<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
 
   static flags = {
     help: Flags.help({char: 'h'}),

diff --git a/src/commands/plugins/uninstall.ts b/src/commands/plugins/uninstall.ts
@@ -29,16 +29,13 @@ export default class PluginsUninstall extends Command {
 
   static description = 'Removes a plugin from the CLI.'
 
+  static examples = ['<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || "myplugin" %>']
+
   static flags = {
     help: Flags.help({char: 'h'}),
     verbose: Flags.boolean({char: 'v'}),
   }
 
-  static help = `
-  Example:
-    $ <%- config.bin %> plugins:uninstall <%- config.pjson.oclif.examplePlugin || "myplugin" %>
-  `
-
   static strict = false
 
   static usage = 'plugins:uninstall PLUGIN...'