docs work

heroku · May 31, 2018 · 26e38aa · 26e38aa
1 parent c8a8fd8
commit 26e38aa
Show file tree

Hide file tree

Showing 6 changed files with 263 additions and 209 deletions.
diff --git a/README.md b/README.md
@@ -18,29 +18,90 @@ $ heroku local
 
 This command internally uses [node-foreman](https://github.com/strongloop/node-foreman) to run the app locally.
 
-Help
-=======
+Commands
+========
 
+<!-- commands -->
+* [`@heroku-cli/plugin-local local [PROCESSNAME]`](#heroku-cli-plugin-local-local-processname)
+* [`@heroku-cli/plugin-local local:run`](#heroku-cli-plugin-local-localrun)
+* [`@heroku-cli/plugin-local local:start [PROCESSNAME]`](#heroku-cli-plugin-local-localstart-processname)
+* [`@heroku-cli/plugin-local local:version`](#heroku-cli-plugin-local-localversion)
+
+## `@heroku-cli/plugin-local local [PROCESSNAME]`
+
+run heroku app locally
+
+```
+USAGE
+  $ @heroku-cli/plugin-local local [PROCESSNAME]
+
+OPTIONS
+  -e, --env=env            location of env file (defaults to .env)
+  -f, --procfile=procfile  use a different Procfile
+  -p, --port=port          port to listen on
+
+DESCRIPTION
+  Start the application specified by a Procfile (defaults to ./Procfile)
+
+  Examples:
+
+       heroku local
+       heroku local web
+       heroku local web=2
+       heroku local web=1,worker=2
+```
+
+## `@heroku-cli/plugin-local local:run`
+
+run a one-off command
+
+```
+USAGE
+  $ @heroku-cli/plugin-local local:run
+
+OPTIONS
+  -e, --env=env
+  -p, --port=port
+
+DESCRIPTION
+  Example:
+
+       heroku local:run bin/migrate
 ```
-$ heroku help local
 
-Usage: heroku local [PROCESSNAME]
+## `@heroku-cli/plugin-local local:start [PROCESSNAME]`
 
- run heroku app locally
+run heroku app locally
 
- Start the application specified by a Procfile (defaults to ./Procfile)
+```
+USAGE
+  $ @heroku-cli/plugin-local local:start [PROCESSNAME]
 
- Examples:
+OPTIONS
+  -e, --env=env            location of env file (defaults to .env)
+  -f, --procfile=procfile  use a different Procfile
+  -p, --port=port          port to listen on
 
-   heroku local
-   heroku local web
-   heroku local -f Procfile.test -e .env.test
+DESCRIPTION
+  Start the application specified by a Procfile (defaults to ./Procfile)
 
- -f, --procfile PROCFILE
- -e, --env ENV
- -p, --port PORT
+  Examples:
 
-Additional commands, type "heroku help COMMAND" for more details:
+       heroku local
+       heroku local web
+       heroku local web=2
+       heroku local web=1,worker=2
+```
+
+## `@heroku-cli/plugin-local local:version`
+
+display node-foreman version
+
+```
+USAGE
+  $ @heroku-cli/plugin-local local:version
 
-  local:version  #  display node-foreman version
+DESCRIPTION
+  Display node-foreman version
 ```
+<!-- commandsstop -->
diff --git a/commands/run.js b/commands/run.js
@@ -25,9 +25,7 @@ module.exports = {
   topic: 'local',
   command: 'run',
   description: 'run a one-off command',
-  help: `Example:
-
-    heroku local:run bin/migrate`,
+  examples: '$ heroku local:run bin/migrate',
   variableArgs: true,
   flags: [
     {name: 'env', char: 'e', hasValue: true, completion: FileCompletion},

diff --git a/commands/start.js b/commands/start.js
@@ -27,14 +27,11 @@ function * run (context) {
 const cmd = {
   topic: 'local',
   description: 'run heroku app locally',
-  help: `Start the application specified by a Procfile (defaults to ./Procfile)
-
-Examples:
-
-    heroku local
-    heroku local web
-    heroku local web=2
-    heroku local web=1,worker=2`,
+  help: 'Start the application specified by a Procfile (defaults to ./Procfile)',
+  examples: `$ heroku local
+$ heroku local web
+$ heroku local web=2
+$ heroku local web=1,worker=2`,
   args: [{name: 'processname', optional: true}],
   flags: [
     {name: 'procfile', char: 'f', hasValue: true, description: 'use a different Procfile', completion: FileCompletion},

diff --git a/commands/version.js b/commands/version.js
@@ -12,6 +12,5 @@ module.exports = {
   topic: 'local',
   command: 'version',
   description: 'display node-foreman version',
-  help: 'Display node-foreman version',
   run: cli.command(co.wrap(run))
 }
diff --git a/package.json b/package.json
@@ -7,19 +7,19 @@
     "url": "https://github.com/heroku/heroku-local/issues"
   },
   "dependencies": {
-    "@heroku-cli/command": "^8.0.5",
+    "@heroku-cli/command": "^8.1.20",
     "@heroku/foreman": "^2.0.2",
     "co": "^4.6.0",
-    "heroku-cli-util": "^8.0.6",
+    "heroku-cli-util": "^8.0.9",
     "lodash.flatten": "^4.4.0"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.13.1",
-    "@oclif/plugin-legacy": "^1.0.10",
+    "@oclif/dev-cli": "^1.13.29",
+    "@oclif/plugin-legacy": "^1.0.15",
     "standard": "^11.0.1"
   },
   "files": [
-    ".oclif.manifest.json",
+    "oclif.manifest.json",
     "index.js",
     "commands",
     "lib"
@@ -37,7 +37,8 @@
   "scripts": {
     "test": "bats test && standard",
     "prepublishOnly": "oclif-dev manifest",
-    "postpublish": "rm .oclif.manifest.json"
+    "postpublish": "rm oclif.manifest.json",
+    "version": "oclif-dev readme && git add README.md"
   },
   "cli-engine": {
     "topics": {