react-doc-generator/src/lib/command.js

Generate a simple React Component documentation in Markdown.

const { program } = require("commander");

const pkg = require("../../package.json");

export default (function Command() {
  const list = (val) => {
    val = val.replace(/[, ]+/g, ",").trim();
    return val.split(",").filter((value) => value.length > 0);
  };

  program
    .version(pkg.version)
    .usage(`<dir> [options]`)
    .option(
      "-x, --extensions <items>",
      "Include only these file extensions. Default: js,jsx",
      list,
      ["js", "jsx"]
    )
    .option(
      "-i, --ignore <items>",
      "Folders to ignore. Default: node_modules,__tests__,__mocks__",
      list,
      ["node_modules", "__tests__", "__mocks__"]
    )
    .option(
      "-e, --exclude-patterns <items>",
      "Filename patterns to exclude. Default: []",
      list,
      []
    )
    .option(
      "-t, --title [value]",
      "Document title. Default: 'Components'",
      "Components"
    )
    .option(
      "-o, --output <file>",
      "Markdown file to write. Default: 'DOCUMENTATION.MD'",
      "DOCUMENTATION.MD"
    )
    .parse(process.argv);

  return program;
})();