@oclif/plugin-plugins - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

.oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"1.0.5","commands":{"plugins":{"id":"plugins","description":"list installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%- config.bin %> plugins"],"flags":{"core":{"name":"core","type":"boolean","description":"show core plugins"}},"args":[]},"plugins:install":{"id":"plugins:install","description":"installs a plugin into the CLI","usage":"plugins:install PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || \"heroku-production-status\" %> "],"flags":{},"args":[{"name":"plugin","description":"plugin to install","required":true}]},"plugins:uninstall":{"id":"plugins:uninstall","description":"removes a plugin from the CLI","usage":"plugins:uninstall PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"plugin","description":"plugin to uninstall","required":true}]},"plugins:update":{"id":"plugins:update","description":"update installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"1.0.6","commands":{"plugins":{"id":"plugins","description":"list installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%- config.bin %> plugins"],"flags":{"core":{"name":"core","type":"boolean","description":"show core plugins"}},"args":[]},"plugins:install":{"id":"plugins:install","description":"installs a plugin into the CLI","usage":"plugins:install PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || \"heroku-production-status\" %> "],"flags":{},"args":[{"name":"plugin","description":"plugin to install","required":true}]},"plugins:uninstall":{"id":"plugins:uninstall","description":"removes a plugin from the CLI","usage":"plugins:uninstall PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"plugin","description":"plugin to uninstall","required":true}]},"plugins:update":{"id":"plugins:update","description":"update installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{},"args":[]}}}

CHANGELOG.md

@@ -0,1 +1,9 @@
+<a name="1.0.6"></a>
+## [1.0.6](https://github.com/oclif/plugin-plugins/compare/0a0155d9f2ac09ecde7f8ce2b15b85fae6c5cba8...v1.0.6) (2018-03-22)
+
+
+### Bug Fixes
+
+* rename example to mycli ([e018e45](https://github.com/oclif/plugin-plugins/commit/e018e45))
+
 <a name="1.0.5"></a>
@@ -2,0 +10,0 @@ ## [1.0.5](https://github.com/oclif/plugin-plugins/compare/3e1bc65d5bcd452548c440630dbe9d2194ca81bc...v1.0.5) (2018-03-22)

package.json

 {
   "name": "@oclif/plugin-plugins",
   "description": "plugins plugin for oclif",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "Jeff Dickey @jdxcode",
@@ -10,4 +10,4 @@ "bugs": "https://github.com/oclif/plugin-plugins/issues",
     "@oclif/command": "^1.4.2",
-    "chalk": "^2.3.1",
-    "cli-ux": "^3.3.23",
+    "chalk": "^2.3.2",
+    "cli-ux": "^3.3.25",
     "debug": "^3.1.0",
@@ -64,3 +64,3 @@ "fs-extra": "^5.0.0",
     ],
-    "bin": "oclif-example"
+    "bin": "mycli"
   },
@@ -67,0 +67,0 @@ "repository": "oclif/plugin-plugins",

README.md

@@ -16,27 +16,44 @@ @oclif/plugin-plugins
 <!-- toc -->
+* [What is this?](#what-is-this)
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
-<!-- usage -->
-# Usage
 
+# What is this?
+
+This plugin is used to allow users to install plugins into your oclif CLI at runtime. For example, in the Heroku CLI this is used to allow people to install plugins such as the Heroku Kafka plugin:
+
 ```sh-session
-$ npm install -g @oclif/plugin-plugins
-$ oclif-example COMMAND
-running command...
-$ oclif-example (-v|--version|version)
-@oclif/plugin-plugins/1.0.5 linux-x64 node-v9.8.0
-$ oclif-example --help [COMMAND]
-USAGE
-  $ oclif-example COMMAND
-...
+$ heroku plugins:install heroku-kafka
+$ heroku kafka
 ```
-<!-- usagestop -->
+
+This is useful to allow users to create their own plugins to work in your CLI or to allow you to build functionality that users can optionally install.
+
+One particular way this is useful is for building functionality you aren't ready to include in a public repository. Build your plugin separately as a plugin, then include it as a core plugin later into your CLI.
+
+# Usage
+
+First add the plugin to your project with `yarn add @oclif/plugin-plugins`, then add it to the `package.json` of the oclif CLI:
+
+```js
+{
+  "name": "mycli",
+  "version": "0.0.0",
+  // ...
+  "oclif": {
+    "plugins": ["@oclif/plugin-help", "@oclif/plugin-plugins"]
+  }
+}
+```
+
+Now the user can run any of the commands below to manage plugins at runtime.
+
 <!-- commands -->
 # Commands
 
-* [oclif-example plugins](#plugins)
-* [oclif-example plugins:install PLUGIN...](#pluginsinstall-plugin)
-* [oclif-example plugins:uninstall PLUGIN...](#pluginsuninstall-plugin)
-* [oclif-example plugins:update](#pluginsupdate)
+* [mycli plugins](#plugins)
+* [mycli plugins:install PLUGIN...](#pluginsinstall-plugin)
+* [mycli plugins:uninstall PLUGIN...](#pluginsuninstall-plugin)
+* [mycli plugins:update](#pluginsupdate)
 ## plugins
@@ -48,3 +65,3 @@
 USAGE
-  $ oclif-example plugins
+  $ mycli plugins
 
@@ -55,6 +72,6 @@ OPTIONS
 EXAMPLE
-  $ oclif-example plugins
+  $ mycli plugins
 ```
 
-_See code: [src/commands/plugins.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins.ts)_
+_See code: [src/commands/plugins.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins.ts)_
 
@@ -67,3 +84,3 @@ ### plugins:install PLUGIN...
 USAGE
-  $ oclif-example plugins:install PLUGIN...
+  $ mycli plugins:install PLUGIN...
 
@@ -74,6 +91,6 @@ ARGUMENTS
 EXAMPLE
-  $ oclif-example plugins:install heroku-production-status
+  $ mycli plugins:install heroku-production-status
 ```
 
-_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/install.ts)_
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/install.ts)_
 
@@ -86,3 +103,3 @@ ### plugins:uninstall PLUGIN...
 USAGE
-  $ oclif-example plugins:uninstall PLUGIN...
+  $ mycli plugins:uninstall PLUGIN...
 
@@ -93,3 +110,3 @@ ARGUMENTS
 
-_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/uninstall.ts)_
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/uninstall.ts)_
 
@@ -102,6 +119,6 @@ ### plugins:update
 USAGE
-  $ oclif-example plugins:update
+  $ mycli plugins:update
 ```
 
-_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/update.ts)_
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/update.ts)_
 
@@ -114,3 +131,3 @@ ## plugins:install PLUGIN...
 USAGE
-  $ oclif-example plugins:install PLUGIN...
+  $ mycli plugins:install PLUGIN...
 
@@ -121,6 +138,6 @@ ARGUMENTS
 EXAMPLE
-  $ oclif-example plugins:install heroku-production-status
+  $ mycli plugins:install heroku-production-status
 ```
 
-_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/install.ts)_
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/install.ts)_
 
@@ -133,3 +150,3 @@ ## plugins:uninstall PLUGIN...
 USAGE
-  $ oclif-example plugins:uninstall PLUGIN...
+  $ mycli plugins:uninstall PLUGIN...
 
@@ -140,3 +157,3 @@ ARGUMENTS
 
-_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/uninstall.ts)_
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/uninstall.ts)_
 
@@ -149,6 +166,6 @@ ## plugins:update
 USAGE
-  $ oclif-example plugins:update
+  $ mycli plugins:update
 ```
 
-_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.5/src/commands/plugins/update.ts)_
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.6/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37084

increased by2.44%

Number of lines in readme file

159

increased by11.97%

Dependency changes

• Updatedchalk@^2.3.2

• Updatedcli-ux@^3.3.25