[Feature] dpdm.config.ts

[kachkaev]

Is your feature request related to a problem? Please describe.

I'm using dpdm in a monorepo and it works well. There is a small problem that I have encountered. Configuring dpdm for each workspace is a bit repetitive and brittle: I have to add this pretty long command to package.jsons:

    "lint:dpdm": "dpdm --exit-code circular:1 --tree false --transform --warning false '**/*.{ts,tsx}'",

Describe the solution you'd like

If there was a way to define an ESM-first dpdm.config.ts (like vite.config.ts, eslint.config.ts), that could improve the situation. I could have a base config in a corresponding namespace and re-export it in other workspace. Composing configs would become easier too. The same config type could be passed down to dmdm via API its JS API.

Describe alternatives you've considered

Crafting a config using args in package.json scripts, but that can't be autocompleted or linted. Took a bit of time to set up the args.

Additional context

Ultimately, I would also like to see some form of 'allow list' for circular dependencies. Similar config options exist in knip.config.ts for ignoring dependencies etc. Not all circular dependencies are easy to fix. If few tough ones a remaining, adding them to a config as exceptions can help with further codebase development. It will be possible to fail dmdm if new kinds of cycles are created, but the existing ones are tolerable until the opportunity shows up. We use this trick in Knip for 'orphan' files that are no longer used but cannot be deleted just yet for various reasons.

[acrazing]

Thanks for the suggestion!

The circular dependency allow-list part is implemented in dpdm@4.1.0 via the new --skip-imports option.

Example:

dpdm ./src/index.ts --skip-imports 'src/a.js:src/b.js' 'src/c.js:src/d.js'

It also supports regexp matching, for example:

dpdm ./src/index.ts --skip-imports 'src/a.js:.*'

This behaves like --skip-dynamic-imports circular, but only for the specified import edges.

For the config file section, I plan to implement it in the next few weeks. I’m currently working on another project that this should depend on.

[acrazing]

Additionally, within a monorepo, a single dpdm command is typically sufficient; there is no need to configure each module individually. For instance, dpdm packages/*/src/index.ts will check the dependencies of the entry files for all modules. The prerequisite is that you have properly configured the tsconfig file in the root directory to ensure it correctly resolves path aliases. For example:

{
  "compilerOptions": {
    "paths": {
      "@xxx/*": ["packages/*/src/index.ts"]
    }
  },
  "include": ["packages"],
  "extends": ["node_modules", "dist"]
}

[kachkaev]

Awesome, huge thanks for adding --skip-imports! I'll give this option a try soon. Also happy with some early testing of a config file, if needed.

As of having a shared tsconfig, not sure it would work in our case. We have a mix of node, next.js and shared packages, so their needs for compiler options are different. ESLint is also configure per workspace and it relies on a local tsconfig.

[acrazing]

@kachkaev You can try creating a separate tsconfig file just for dpdm in your project's root directory, for example tsconfig.dpdm.json, and pass it with --tsconfig tsconfig.dpdm.json.

That file only needs to describe the parts dpdm uses for dependency resolution, especially path aliases. dpdm does not use it as your build/test/typecheck config, so it will not affect any existing workspace tasks unless you explicitly use that tsconfig elsewhere.

For example:

{
  "compilerOptions": {
    "paths": {
      "@xxx/*": ["packages/*/src"]
    }
  }
}

Then run:

dpdm --tsconfig tsconfig.dpdm.json 'packages/*/src/*.*' 'pages/**/*.*' 'server/**/*.*'

This can stay intentionally small and only exist for dpdm's path alias resolution. The future config file support should make this a bit more convenient too.