From 740c0d75f64ef09e9e88158bf42e31d3cea49c5d Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdxcode@users.noreply.github.com> Date: Wed, 14 Feb 2018 13:00:56 -0800 Subject: [PATCH] fix: doc improvements --- templates/src/command.js.ejs | 6 ++++++ templates/src/command.ts.ejs | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/templates/src/command.js.ejs b/templates/src/command.js.ejs index 061df01..bda8fb5 100644 --- a/templates/src/command.js.ejs +++ b/templates/src/command.js.ejs @@ -9,6 +9,12 @@ class <%- klass %> extends Command { } } +<%- klass %>.description = ` +Describe the command here +... +Extra documentation goes here +` + <%- klass %>.flags = { <%_ if (type === 'single') { _%> // add --version flag to show CLI version diff --git a/templates/src/command.ts.ejs b/templates/src/command.ts.ejs index 9d2bc43..6680232 100644 --- a/templates/src/command.ts.ejs +++ b/templates/src/command.ts.ejs @@ -29,7 +29,7 @@ hello world from <%- name %>! `$ <%- cmd %> --name myname hello myname from <%- name %>! `, - '$ <%- cmd %> file outputs "hello world!" to file', + '$ <%- cmd %> ./afile outputs "hello world!" to ./afile', '$ <%- cmd %> --force', '$ <%- cmd %> --help', ]