Seeker - A Dependency Graph Inspector

Working in large codebases comes with it's own challenges. Analyzing the dependency graph should not be one. Seeker reduces the burden of analysis by searching for:

1. Circular dependencies
2. Orphan files

Use

Seeker can be used in unit testing to check for violations and exceptions.

import { assertEquals } from "std_lib/testing/asserts.ts";

import { report } from "https://deno.land/x/seeker@1.0.0/mod.ts";

Deno.test("dependency graph inspection", function () {
  const { circular, orphans } = report("..");

  assertEquals(circular.length, 0);
  assertEquals(orphans.length, 0);
});

Circular Dependencies

Obvious circular dependencies can sometimes easily go unnoticed, while deeply nested circular dependencies may not ever be something that gets noticed by maintainers over any length of time.

The simplest circular dependencie being:

// mod.ts
import libA from "./libA.ts";

export const GREETING = "Hello";

export function send(name: string) {
  libA(name);
}

// libA.ts
import { GREETING } from "./mod.ts";

export function libA(name: string) {
  console.log(`${GREETING} ${name}!`);
}

While circular dependencies might not always be a problem, they should still likely still be avoided.

Orphan Files

Orphan files - files that aren't used in any way - don't cause problems but they do bloat the size of a project and add to the cognitive overhead when maintainers, and other curious developers, are searching through files looking for something interesting.