fix: updated plugin from generator

oclif · Mar 22, 2018 · 0a0155d · 0a0155d
1 parent 3861c42
commit 0a0155d
Show file tree

Hide file tree

Showing 7 changed files with 198 additions and 63 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -15,8 +15,8 @@ jobs:
             - v1-yarn-{{checksum ".circleci/config.yml"}}-{{ checksum "yarn.lock"}}
             - v1-yarn-{{checksum ".circleci/config.yml"}}
       - run: .circleci/greenkeeper
-      - run: yarn add -D nyc@11 @oclif/nyc-config@0 mocha-junit-reporter@1 @commitlint/cli@6 @commitlint/config-conventional@6
-      # - run: ./bin/run --help
+      - run: yarn add -D nyc@11 @oclif/nyc-config@1 mocha-junit-reporter@1 @commitlint/cli@6 @commitlint/config-conventional@6
+      - run: ./bin/run --help
       - run: |
           mkdir -p reports
           $NYC yarn test --reporter mocha-junit-reporter

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 *-debug.log
 *-error.log
+.oclif.manifest.json
 /.nyc_output
 /coverage
 /coverage.lcov

diff --git a/README.md b/README.md
@@ -1,13 +1,141 @@
 @oclif/plugin-plugins
-======================
+=====================
 
 plugins plugin for oclif
 
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-plugins.svg)](https://npmjs.org/package/@oclif/plugin-plugins)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-plugins/tree/master.svg?style=svg)](https://circleci.com/gh/oclif/plugin-plugins/tree/master)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-plugins?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/plugin-plugins/branch/master)
+[![CircleCI](https://circleci.com/gh/oclif/plugin-plugins/tree/master.svg?style=shield)](https://circleci.com/gh/oclif/plugin-plugins/tree/master)
+[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-plugins?branch=master&svg=true)](https://ci.appveyor.com/project/oclif/plugin-plugins/branch/master)
 [![Codecov](https://codecov.io/gh/oclif/plugin-plugins/branch/master/graph/badge.svg)](https://codecov.io/gh/oclif/plugin-plugins)
 [![Greenkeeper](https://badges.greenkeeper.io/oclif/plugin-plugins.svg)](https://greenkeeper.io/)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@oclif/plugin-plugins/badge.svg)](https://snyk.io/test/npm/@oclif/plugin-plugins)
+[![Known Vulnerabilities](https://snyk.io/test/github/oclif/plugin-plugins/badge.svg)](https://snyk.io/test/github/oclif/plugin-plugins)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-plugins.svg)](https://npmjs.org/package/@oclif/plugin-plugins)
 [![License](https://img.shields.io/npm/l/@oclif/plugin-plugins.svg)](https://github.com/oclif/plugin-plugins/blob/master/package.json)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+<!-- usage -->
+# Usage
+
+```sh-session
+$ npm install -g @oclif/plugin-plugins
+$ oclif-example COMMAND
+running command...
+$ oclif-example (-v|--version|version)
+@oclif/plugin-plugins/1.0.4 darwin-x64 node-v9.9.0
+$ oclif-example --help [COMMAND]
+USAGE
+  $ oclif-example COMMAND
+...
+```
+<!-- usagestop -->
+<!-- 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)
+## plugins
+
+list installed plugins
+
+```
+USAGE
+  $ oclif-example plugins
+
+OPTIONS
+  --core  show core plugins
+
+EXAMPLE
+  $ oclif-example plugins
+```
+
+_See code: [src/commands/plugins.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins.ts)_
+
+### plugins:install PLUGIN...
+
+installs a plugin into the CLI
+
+```
+USAGE
+  $ oclif-example plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to install
+
+EXAMPLE
+  $ oclif-example plugins:install heroku-production-status
+```
+
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/install.ts)_
+
+### plugins:uninstall PLUGIN...
+
+removes a plugin from the CLI
+
+```
+USAGE
+  $ oclif-example plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+```
+
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/uninstall.ts)_
+
+### plugins:update
+
+update installed plugins
+
+```
+USAGE
+  $ oclif-example plugins:update
+```
+
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/update.ts)_
+
+## plugins:install PLUGIN...
+
+installs a plugin into the CLI
+
+```
+USAGE
+  $ oclif-example plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to install
+
+EXAMPLE
+  $ oclif-example plugins:install heroku-production-status
+```
+
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/install.ts)_
+
+## plugins:uninstall PLUGIN...
+
+removes a plugin from the CLI
+
+```
+USAGE
+  $ oclif-example plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+```
+
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/uninstall.ts)_
+
+## plugins:update
+
+update installed plugins
+
+```
+USAGE
+  $ oclif-example plugins:update
+```
+
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.0.4/src/commands/plugins/update.ts)_
+<!-- commandsstop -->
diff --git a/appveyor.yml b/appveyor.yml
@@ -6,7 +6,7 @@ cache:
 
 install:
   - ps: Install-Product node $env:nodejs_version x64
-  - yarn add -D nyc@11 @oclif/nyc-config@0
+  - yarn add -D nyc@11 @oclif/nyc-config@1
 test_script:
   - .\bin\run --help
   - .\node_modules\.bin\nyc --nycrc-path node_modules/@oclif/nyc-config/.nycrc yarn test

diff --git a/package.json b/package.json
@@ -3,17 +3,10 @@
   "description": "plugins plugin for oclif",
   "version": "1.0.4",
   "author": "Jeff Dickey @jdxcode",
-  "oclif": {
-    "commands": "./lib/commands",
-    "scope": "heroku-cli",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ]
-  },
   "bugs": "https://github.com/oclif/plugin-plugins/issues",
   "dependencies": {
     "@heroku-cli/color": "^1.1.3",
-    "@oclif/command": "^1.4.1",
+    "@oclif/command": "^1.4.2",
     "chalk": "^2.3.1",
     "cli-ux": "^3.3.23",
     "debug": "^3.1.0",
@@ -26,25 +19,25 @@
     "yarn": "^1.5.1"
   },
   "devDependencies": {
-    "@oclif/config": "^1.3.57",
-    "@oclif/dev-cli": "^1.2.18",
+    "@oclif/config": "^1.3.59",
+    "@oclif/dev-cli": "^1.3.1",
     "@oclif/errors": "^1.0.2",
-    "@oclif/plugin-help": "^1.1.5",
-    "@oclif/test": "^1.0.0",
+    "@oclif/plugin-help": "^1.1.6",
+    "@oclif/test": "^1.0.1",
     "@oclif/tslint": "^1.0.2",
     "@types/chai": "^4.1.2",
     "@types/fs-extra": "^5.0.1",
     "@types/load-json-file": "^2.0.7",
     "@types/mocha": "^2.2.48",
-    "@types/node": "^9.4.6",
+    "@types/node": "^9.4.7",
     "@types/semver": "^5.5.0",
     "@types/supports-color": "^3.1.0",
     "chai": "^4.1.2",
     "concurrently": "^3.5.1",
     "fancy-test": "^1.0.1",
     "globby": "^8.0.1",
-    "mocha": "^5.0.1",
-    "ts-node": "^5.0.0",
+    "mocha": "^5.0.4",
+    "ts-node": "5",
     "tslint": "^5.9.1",
     "typescript": "^2.7.2"
   },
@@ -61,14 +54,25 @@
   ],
   "license": "MIT",
   "main": "lib/index.js",
+  "oclif": {
+    "commands": "./lib/commands",
+    "scope": "heroku-cli",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "bin": "oclif-example"
+  },
   "repository": "oclif/plugin-plugins",
   "scripts": {
     "build": "rm -rf lib && tsc",
-    "lint": "concurrently -p command \"tsc -p test --noEmit\" \"tslint -p test\"",
-    "postpublish": "rm .oclif.manifest.json",
+    "clean": "rm -f .oclif.manifest.json",
+    "lint": "tsc -p test --noEmit && tslint -p test -t stylish",
+    "postpublish": "yarn run clean",
     "posttest": "yarn run lint",
-    "prepublishOnly": "yarn run build && oclif-dev manifest",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\""
+    "prepublishOnly": "yarn run build && oclif-dev manifest && oclif-dev readme",
+    "preversion": "yarn run clean",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif-dev readme && git add README.md"
   },
   "types": "lib/index.d.ts"
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,8 +4,6 @@
     "forceConsistentCasingInFileNames": true,
     "importHelpers": true,
     "module": "commonjs",
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
     "outDir": "./lib",
     "pretty": true,
     "rootDirs": [