codependix-configure

Writing a codependix configuration

Codependix produces nothing until a configuration tells it what to export and where. Every field is optional, and a workspace with no configuration file resolves every graph type for every project to target: "none" — a successful run that writes nothing. The configuration is the whole control surface; there is no flag that selects a graph type.

import { type CodependixConfiguration } from "@codependix/configuration";

const codependixConfiguration: CodependixConfiguration = {
  defaults: {
    imports: { markdown: { anchor: "codependix-imports" }, target: "markdown" },
    nestjs: { markdown: { anchor: "codependix-nestjs" }, target: "markdown" },
    nx: { markdown: { anchor: "codependix-nx" }, target: "markdown" },
  },
  exclude: ["fixtures/**"],
  include: ["**"],
  projects: {
    widgets: {
      nx: {
        json: { path: "output/nx-graph.json" },
        markdown: { anchor: "codependix-nx", path: "docs/architecture.md" },
        target: "both",
      },
    },
  },
  workspace: {
    nx: { markdown: { anchor: "codependix-workspace" }, target: "markdown" },
  },
};

export default codependixConfiguration;

Where the file is found

codependix.config.{ts,mts,cts,js,mjs,cjs,json} is searched for upward from the run's directory, and the first file found wins outright — nothing from a further ancestor is merged into it. A workspace carrying both a TypeScript and a JSON file gets the TypeScript one.

Two paths behave differently on purpose:

• A path given with --config must exist. A typo fails the run rather than quietly resolving every graph to "none". It is resolved against the working directory first, then against the workspace root, so a configuration kept in a configuration/ folder can be named relative to either.
• An absent configuration is legal. A workspace that never wrote one is not told to; it simply exports nothing.

defaults, never default

The field that applies to every project naming no override of its own is spelled defaults. A configuration module's default export is unwrapped by name while loading, so a field called default would collide with that unwrapping. A configuration that writes default: is not rejected — unknown keys are stripped rather than refused, so a newer configuration still loads under an older codependix — it simply has no effect at all, which reads exactly like a tool that ignored it.