Refine examples

README.md

@@ -143,6 +143,8 @@ If you don't want to save the token, you can specify one as an option:
 gren release --token=[your token]
 ```
 
+### [See all the options here](https://github-tools.github.io/github-release-notes/options.html)
+
 ### Commands
 
 There are two main commands that can be ran with 🤖:
@@ -178,6 +180,12 @@ gren --help
 gren help release # or gren release --help
 ```
 
+It's also possible to see all the examples [here](https://github-tools.github.io/github-release-notes/examples.html) or directly in the terminal:
+
+```shell
+gren examples release
+```
+
 ## Configuration file
 
 You can create a configuration file where the task will be ran, where to specify your options. [See how to set up the config file](https://github-tools.github.io/github-release-notes/options.html#configuration-file)

lib/_examples.js

@@ -7,28 +7,25 @@ const chalk = require('chalk');
  */
 function generateExamples(title, examples) {
     process.stdout.write(`\n  Examples for ${title}:`);
-    const spaceify = number => new Array(number ? number + 1 : 0).join(' ');
+    const spaceify = number => new Array(!number || number < 0 ? 0 : number + 1).join(' ');
     const spaces = spaceify(6);
-    const namePlaceholder = spaceify(Math.max(...examples.map(({ name }) => name ? name.length : 0)));
     const descriptionPlaceholder = spaceify(Math.max(...examples.map(({ description }) => description ? description.length : 0)));
 
     examples.forEach(({ name, description, code }) => {
-        const tabs = spaceify(description && descriptionPlaceholder.length - description.length);
+        const tabs = spaceify(descriptionPlaceholder.length - (description ? description.length : 0));
 
         if (name) {
             process.stdout.write(`\n\n    ${chalk.blue(name)}:\n`);
-        } else {
-            process.stdout.write(namePlaceholder);
         }
 
         if (description) {
-            process.stdout.write(`\n      ${description}`);
+            process.stdout.write(`\n${spaces}${description}`);
         } else {
-            process.stdout.write(descriptionPlaceholder);
+            process.stdout.write(spaces);
         }
 
         if (code) {
-            process.stdout.write(`${spaces}${tabs}${chalk.green(`[ ${code} ]`)}\n`);
+            process.stdout.write(`${tabs}${spaces}${chalk.green(`$ ${code}`)}\n`);
         }
     });
 }

lib/gren-examples.js

@@ -11,6 +11,15 @@ gren
     .name('gren examples')
     .description(`See few examples for how to use gren. For more informations (and a bit of UI) check ${chalk.blue('https://github-tools.github.io/github-release-notes/examples.html')}`)
     .usage('<command>')
+    .on('--help', () => {
+        console.log('');
+        console.log('  Commands:');
+        console.log('');
+        console.log('      $ gren examples gren');
+        console.log('      $ gren examples release');
+        console.log('      $ gren examples changelog');
+        console.log('');
+    })
     .action(cmd => {
         command = cmd;
     })