Add test for readme-generation with custom help

Co-authored-by: Chad Carbert <chadcarbert@me.com>

src/_test-help.ts

@@ -0,0 +1,12 @@
+// This a test help class for the purposes of dev-cli and readme generation.
+// It is used for testing purposes only as the dev-cli generates a readme for itself in tests
+// (see readme tests). For more info on help plugins check out @oclif/plugin-help
+
+export default class TestHelp {
+  [x: string]: any
+
+  getCommandHelpForReadme(command: any) {
+    const flags = Object.keys(command.flags).join(', ')
+    return `Test help generated by test plugin for: ${command.id}\nIt has the following flags: ${flags}`
+  }
+}

test/fixtures/cli-with-custom-help/README.md

@@ -0,0 +1,19 @@
+# cli-with-custom-help
+
+This file is a test for running `oclif-dev readme` in the presence of
+a custom help class. It should use the custom help class to generate
+the command documentation below. The test suite resets this file after
+each test.
+
+<!-- toc -->
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+<!-- commandsstop -->

test/fixtures/cli-with-custom-help/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "cli-with-custom-help",
+  "files": [
+    "/lib"
+  ],
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "cli-with-custom-help",
+    "helpClass": "./lib/help"
+  }
+}

test/fixtures/cli-with-custom-help/src/commands/hello.ts

@@ -0,0 +1,31 @@
+import {Command, flags} from '@oclif/command'
+
+export default class Hello extends Command {
+  static description = 'describe the command here'
+
+  static examples = [
+    `$ cli-with-custom-help hello
+hello world from ./src/hello.ts!
+`,
+  ]
+
+  static flags = {
+    help: flags.help({char: 'h'}),
+    // flag with a value (-n, --name=VALUE)
+    name: flags.string({char: 'n', description: 'name to print'}),
+    // flag with no value (-f, --force)
+    force: flags.boolean({char: 'f'}),
+  }
+
+  static args = [{name: 'file'}]
+
+  async run() {
+    const {args, flags} = this.parse(Hello)
+
+    const name = flags.name ?? 'world'
+    this.log(`hello ${name} from ./src/commands/hello.ts`)
+    if (args.file && flags.force) {
+      this.log(`you input --force and --file: ${args.file}`)
+    }
+  }
+}

test/fixtures/cli-with-custom-help/src/help.ts

@@ -0,0 +1,12 @@
+import {HelpBase} from '@oclif/plugin-help'
+import {Command} from '@oclif/config'
+
+export default class CustomHelp extends HelpBase {
+  showHelp() {
+    console.log('TODO: showHelp')
+  }
+
+  showCommandHelp(command: Command) {
+    console.log(`Custom help for ${command.id}`)
+  }
+}

test/fixtures/cli-with-custom-help/src/index.ts

@@ -0,0 +1 @@
+export {run} from '@oclif/command'

test/fixtures/cli-with-custom-help/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "lib",
+    "rootDir": "src",
+    "strict": true,
+    "target": "es2017"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}

test/readme.test.ts

@@ -1,5 +1,6 @@
 import {expect, test} from '@oclif/test'
 import * as fs from 'fs-extra'
+import * as path from 'path'
 
 const readme = fs.readFileSync('README.md', 'utf8')
 
@@ -20,4 +21,21 @@ describe('readme', () => {
   .it('runs readme --multi', () => {
     expect(fs.readFileSync('README.md', 'utf8')).to.contain('manifest')
   })
+
+  describe('with custom help', () => {
+    const rootPath = path.join(__dirname, 'fixtures/cli-with-custom-help')
+    const readmePath = path.join(rootPath, 'README.md')
+    const originalReadme = fs.readFileSync(readmePath, 'utf8')
+
+    test
+    .stdout()
+    .finally(() => fs.writeFileSync(readmePath, originalReadme))
+    .stub(process, 'cwd', () => rootPath)
+    .command(['readme'])
+    .it('prints custom help to the readme', () => {
+      const newReadme = fs.readFileSync(readmePath, 'utf8')
+
+      expect(newReadme).to.contain('Custom help for hello')
+    })
+  })
 })