@picturelink/barrelsby/src/builders/flat.test.ts

Automatic TypeScript barrels for your entire code base

import { assert } from "chai";
import Sinon from "sinon";

import * as TestUtilities from "../testUtilities";
import * as Flat from "./flat";

describe("builder/flat module has a", () => {
  describe("buildFlatBarrel function that", () => {
    describe("when using the default settings", () => {
      let output: string;
      let spySandbox: sinon.SinonSandbox;
      let logger: Sinon.SinonSpy;
      beforeEach(() => {
        const directory = TestUtilities.mockDirectoryTree();
        spySandbox = Sinon.createSandbox();
        logger = spySandbox.spy();
        output = Flat.buildFlatBarrel(
          directory,
          TestUtilities.mockModules(directory),
          '"',
          ";",
          logger,
          undefined,
          false
        );
      });
      afterEach(() => {
        spySandbox.restore();
      });
      it("should produce the correct output", () => {
        TestUtilities.assertMultiLine(
          output,
          `export * from "./barrel";
export * from "./index";
export * from "./directory2/script";
export * from "./directory2/directory4/deeplyNested";
export * from "./directory3/program";
`
        );
      });
      it("should log useful information to the logger", () => {
        const messages = [
          "Including path ./barrel",
          "Including path ./index",
          "Including path ./directory2/script",
          "Including path ./directory2/directory4/deeplyNested",
          "Including path ./directory3/program"
        ];
        assert.equal(logger.callCount, messages.length);
        messages.forEach((message: string, index: number) => {
          assert.equal(logger.getCall(index).args[0], message);
        });
      });
      it("should produce output compatible with the recommended tslint ruleset", () => {
        TestUtilities.tslint(output, '"');
      });
    });

    describe("when using single quotes", () => {
      let output: string;
      let spySandbox: sinon.SinonSandbox;
      let logger: Sinon.SinonSpy;
      beforeEach(() => {
        const directory = TestUtilities.mockDirectoryTree();
        spySandbox = Sinon.createSandbox();
        logger = spySandbox.spy();
        output = Flat.buildFlatBarrel(
          directory,
          TestUtilities.mockModules(directory),
          "'",
          ";",
          logger,
          undefined,
          false
        );
      });
      afterEach(() => {
        spySandbox.restore();
      });
      it("should produce the correct output", () => {
        TestUtilities.assertMultiLine(
          output,
          `export * from './barrel';
export * from './index';
export * from './directory2/script';
export * from './directory2/directory4/deeplyNested';
export * from './directory3/program';
`
        );
      });
      it("should log useful information to the logger", () => {
        const messages = [
          "Including path ./barrel",
          "Including path ./index",
          "Including path ./directory2/script",
          "Including path ./directory2/directory4/deeplyNested",
          "Including path ./directory3/program"
        ];
        assert.equal(logger.callCount, messages.length);
        messages.forEach((message: string, index: number) => {
          assert.equal(logger.getCall(index).args[0], message);
        });
      });
      it("should produce output compatible with the recommended tslint ruleset", () => {
        TestUtilities.tslint(output, "'");
      });
    });

    describe("when using no semicolon", () => {
      let output: string;
      let spySandbox: sinon.SinonSandbox;
      let logger: Sinon.SinonSpy;
      beforeEach(() => {
        const directory = TestUtilities.mockDirectoryTree();
        spySandbox = Sinon.createSandbox();
        logger = spySandbox.spy();
        output = Flat.buildFlatBarrel(
          directory,
          TestUtilities.mockModules(directory),
          '"',
          "",
          logger,
          undefined,
          false
        );
      });
      afterEach(() => {
        spySandbox.restore();
      });
      it("should produce the correct output", () => {
        TestUtilities.assertMultiLine(
          output,
          `export * from "./barrel"
export * from "./index"
export * from "./directory2/script"
export * from "./directory2/directory4/deeplyNested"
export * from "./directory3/program"
`
        );
      });
      it("should log useful information to the logger", () => {
        const messages = [
          "Including path ./barrel",
          "Including path ./index",
          "Including path ./directory2/script",
          "Including path ./directory2/directory4/deeplyNested",
          "Including path ./directory3/program"
        ];
        assert.equal(logger.callCount, messages.length);
        messages.forEach((message: string, index: number) => {
          assert.equal(logger.getCall(index).args[0], message);
        });
      });
    });

    describe("when using the exportDefault setting", () => {
      let output: string;
      let spySandbox: sinon.SinonSandbox;
      let logger: Sinon.SinonSpy;
      beforeEach(() => {
        const directory = TestUtilities.mockDirectoryTree();
        spySandbox = Sinon.createSandbox();
        logger = spySandbox.spy();
        output = Flat.buildFlatBarrel(
          directory,
          TestUtilities.mockModules(directory),
          '"',
          ";",
          logger,
          undefined,
          true
        );
      });
      afterEach(() => {
        spySandbox.restore();
      });
      it("should produce the correct output", () => {
        TestUtilities.assertMultiLine(
          output,
          `export { default as barrel } from "./barrel";
export * from "./barrel";
export { default as index } from "./index";
export * from "./index";
export { default as script } from "./directory2/script";
export * from "./directory2/script";
export { default as deeplyNested } from "./directory2/directory4/deeplyNested";
export * from "./directory2/directory4/deeplyNested";
export { default as program } from "./directory3/program";
export * from "./directory3/program";
`
        );
      });
      it("should produce output compatible with the recommended tslint ruleset", () => {
        TestUtilities.tslint(output, '"');
      });
    });
  });
});