commander-to-markdown/test.js

Render the options of a commander app as markdown

require('tap-spec-integrated');
const test = require('tape-catch');
const u = require('untab');
const proxyquire = require('proxyquire');

const commanderToMarkdown = require('.');

test('Works as advertized', (is) => {
  is.equal(
    commanderToMarkdown(`${__dirname}/test/fixtures/app`),
    u`
      #### \`<address>\`
      Address for delivery.

      #### \`-p, --peppers\`
      Add peppers.

      #### \`-P, --pineapple\`
      Add pineapple.

      #### \`-b, --bbq-sauce\`
      Add bbq sauce.

      #### \`-c, --cheese [type]\`
      Pick the type of cheese. Default: \`marble\`.
    `,
    'covers the readme example'
  );
  is.end();
});

test('Prints the description in sentences', (is) => {
  is.equal(
    commanderToMarkdown(`${__dirname}/test/fixtures/quick-and-dirty-app`),
    u`
      #### \`-x\`
      Just some words bunched together. Some more here. Default: \`nothing\`.
    `,
    'capitalizes sentences'
  );
  is.end();
});

const isStubbedOut = (is, options, modulePath) => is.deepEqual(
  [typeof options[modulePath], String(options[modulePath])],
  ['function', '() => ({})'],
  `stubs out \`${modulePath}\` with a dummy function`
);

test('Stubs out program logic', (is) => {
  is.plan(3);

  const myPath = '/a/b/c';

  const commanderToMarkdownStub = proxyquire('.', {
    proxyquire: (path, options) => {
      is.equal(
        path,
        myPath,
        'requires the given `path`'
      );

      isStubbedOut(is, options, '.');
      isStubbedOut(is, options, '..');
    },
  });

  commanderToMarkdownStub(myPath);

  is.end();
});

test('`programModules` works', (is) => {
  is.plan(2);

  const myPath = '/a/b/c';

  const commanderToMarkdownStub = proxyquire('.', {
    proxyquire: (path, options) => {
      isStubbedOut(is, options, '.');
      isStubbedOut(is, options, './logic');
    },
  });

  commanderToMarkdownStub(myPath, { programModules: ['.', './logic'] });

  is.end();
});