react-doc-generator/src/__tests__/react-doc-generator.test.js

Generate a simple React Component documentation in Markdown.

// https://travis-ci.org/marborkowski/react-doc-generator

const path = require("path");
const fs = require("fs");
const spawn = require("child_process").spawn;

function run(command, args) {
  let stdout = [];
  let stderr = [];

  return new Promise((resolve, reject) => {
    let spawned = spawn(command, args);
    spawned.stdout.on("data", (data) => {
      stdout.push(data);
    });
    spawned.stderr.on("data", (data) => stderr.push(data));
    spawned.on("close", () => resolve([stdout.join(""), stderr.join("")]));
    spawned.on("error", (err) => {
      throw err;
    });
  }).catch((error) => {
    console.log(error, "Error");
    throw error;
  });
}

function loadDoc() {
  return new Promise((resolve, reject) => {
    fs.readFile("./dist/DOCUMENTATION.md", "utf8", function (err, data) {
      if (err) {
        reject(err);
      } else {
        resolve(data);
      }
    });
  });
}
let binPath = path.join(__dirname, "../../dist/react-doc-generator.js");
fs.chmodSync(binPath, "0777");
describe("react-doc-generator", () => {
  it("has the proper console output", async () => {
    try {
      const stdout = await run("node", [
        binPath,
        "src/__mocks__",
        "-o",
        "./dist/DOCUMENTATION.md",
      ]);
      const output = stdout[0];
      expect(output).toMatchSnapshot();
    } catch (e) {
      console.error(e);
      throw e;
    }
  });

  it("return the proper message when given extensions not found", async () => {
    try {
      const stdout = await run("node", [
        binPath,
        "src/__mocks__",
        "-o",
        "./dist/DOCUMENTATION.md",
        "-x",
        "4hs0,kku4",
      ]);
      const output = stdout[0];
      expect(output).toMatchSnapshot();
    } catch (e) {
      throw e;
    }
  });

  it("contains help section if no argument is available in query", async () => {
    try {
      const stdout = await run("node", [
        binPath,
        "-o",
        "./dist/DOCUMENTATION.md",
      ]);
      const output = stdout[0];
      expect(output).toMatchSnapshot();
    } catch (e) {
      throw e;
    }
  });
});
describe("output file", () => {
  it("has needed values", async () => {
    try {
      await run("node", [
        binPath,
        "src/__mocks__",
        "-o",
        "./dist/DOCUMENTATION.md",
        "-t",
        "MyTitleXYZ",
      ]);
      const result = await loadDoc();
      const lines = result.split("\n");
      expect(lines).toMatchSnapshot();
    } catch (e) {
      throw e;
    }
  });
});