@picturelink/barrelsby/src/modules.test.ts

Automatic TypeScript barrels for your entire code base

import { assert } from "chai";

import * as Modules from "./modules";
import { Logger } from "./options/logger";
import * as TestUtilities from "./testUtilities";
import { Directory } from "./utilities";

describe("builder/modules module has a", () => {
  describe("loadDirectoryModules function that", () => {
    let directory: Directory;
    let logged: string[];
    let logger: Logger;
    beforeEach(() => {
      directory = TestUtilities.mockDirectoryTree();
      logged = [];
      logger = TestUtilities.mockLogger(logged);
    });
    it("should identify modules from directories recursively", () => {
      const result = Modules.loadDirectoryModules(
        directory.directories[0],
        logger,
        [],
        [],
        false
      );
      assert.lengthOf(result, 2);
      assert.deepEqual(result[0], {
        name: "script.ts",
        path: "directory1/directory2/script.ts"
      });
      assert.deepEqual(result[1], {
        name: "deeplyNested.ts",
        path: "directory1/directory2/directory4/deeplyNested.ts"
      });
    });
    it("should not identify modules recursively if the local flag is set", () => {
      const result = Modules.loadDirectoryModules(
        directory.directories[0],
        logger,
        [],
        [],
        true
      );
      assert.lengthOf(result, 1);
      assert.deepEqual(result[0], {
        name: "script.ts",
        path: "directory1/directory2/script.ts"
      });
    });
    it("should identify directories that already contain a barrel", () => {
      // Set up a barrel.
      const targetDirectory = directory.directories[0];
      targetDirectory.barrel = targetDirectory.files[0];

      const result = Modules.loadDirectoryModules(
        directory.directories[0],
        logger,
        [],
        [],
        false
      );
      assert.lengthOf(result, 1);
      assert.deepEqual(result[0], {
        name: "script.ts",
        path: "directory1/directory2/script.ts"
      });
    });
    it("should only include TypeScript files", () => {
      const result = Modules.loadDirectoryModules(
        directory,
        logger,
        [],
        [],
        false
      );
      result.forEach(location => assert.notEqual(location.name, "ignore.txt"));
    });
    it("should only include files matching a whitelist option when specified", () => {
      const result = Modules.loadDirectoryModules(
        directory,
        logger,
        ["directory2"],
        [],
        false
      );
      assert.lengthOf(result, 2);
      assert.deepEqual(result[0], {
        name: "script.ts",
        path: "directory1/directory2/script.ts"
      });
      assert.deepEqual(result[1], {
        name: "deeplyNested.ts",
        path: "directory1/directory2/directory4/deeplyNested.ts"
      });
    });
    it("should exclude files matching a blacklist option when specified", () => {
      const result = Modules.loadDirectoryModules(
        directory,
        logger,
        [],
        ["directory2"],
        false
      );
      assert.lengthOf(result, 3);
      assert.deepEqual(result[0], {
        name: "barrel.ts",
        path: "directory1/barrel.ts"
      });
      assert.deepEqual(result[1], {
        name: "index.ts",
        path: "directory1/index.ts"
      });
      assert.deepEqual(result[2], {
        name: "program.ts",
        path: "directory1/directory3/program.ts"
      });
    });
    it("should correctly handle both whitelist and blacklist options being set", () => {
      const result = Modules.loadDirectoryModules(
        directory,
        logger,
        ["directory2"],
        ["directory4"],
        false
      );
      assert.lengthOf(result, 1);
      assert.deepEqual(result[0], {
        name: "script.ts",
        path: "directory1/directory2/script.ts"
      });
    });
    it("should log useful information to the logger", () => {
      // Set up a barrel.
      const indexedDirectory = directory.directories[0];
      indexedDirectory.barrel = indexedDirectory.files[0];

      Modules.loadDirectoryModules(directory, logger, [], [], false);
      assert.deepEqual(logged, [
        "Getting modules @ ./directory1",
        "Getting modules @ directory1/directory2",
        "Found existing barrel @ directory1/directory2/script.ts",
        "Getting modules @ directory1/directory3"
      ]);
    });
  });
});