@zuke/dpdm

`@zuke/dpdm` — a typed `DpdmTasks` wrapper for the

Symbols

# DpdmAnalyzeSettings class

class DpdmAnalyzeSettings extends ToolSettings

Settings for a dpdm analysis run.

Member	Signature	Doc
`transform`	`transform(): this`	Transform TypeScript modules to JavaScript before analysis (`--transform`).
`noTree`	`noTree(): this`	Suppress the dependency tree output (`--no-tree`).
`noCircular`	`noCircular(): this`	Suppress the circular-dependency output (`--no-circular`).
`noWarning`	`noWarning(): this`	Suppress warnings about unresolved/missing modules (`--no-warning`).
`noProgress`	`noProgress(): this`	Disable the progress bar (`--no-progress`).
`output`	`output(path: PathLike): this`	Write the analysis as JSON to a file (`--output`).
`tsconfig`	`tsconfig(path: PathLike): this`	Use an explicit tsconfig for module resolution (`--tsconfig`).
`context`	`context(path: PathLike): this`	Set the context directory used to shorten printed paths (`--context`).
`extensions`	`extensions(...exts: string[]): this`	Extensions to resolve, e.g. `.ts`, `.tsx` (`--extensions`).
`js`	`js(...exts: string[]): this`	Extensions treated as JavaScript-like (`--js`).
`include`	`include(pattern: string): this`	Only analyze files matching this regular expression (`--include`).
`exclude`	`exclude(pattern: string): this`	Skip files matching this regular expression (`--exclude`).
`skipDynamicImports`	`skipDynamicImports(mode: circular \| tree): this`	Skip dynamic imports when detecting `circular` or `tree` (`--skip-dynamic-imports`).
`detectUnusedFilesFrom`	`detectUnusedFilesFrom(glob: string): this`	Detect unused files starting from this glob (`--detect-unused-files-from`).
`exitCode`	`exitCode(rule: string): this`	Exit with a code when a case occurs, e.g. `circular:1` (`--exit-code`).
`entries`	`entries(...paths: PathLike[]): this`	The entry files or globs to analyze (appended after all options).

# DpdmTasks const

const DpdmTasks: DpdmTasksApi

Typed task functions for the dpdm CLI.

# DpdmTasksApi interface

interface DpdmTasksApi

The shape of DpdmTasks.

Member	Signature	Doc
`analyze`	`analyze(configure?: Configure<DpdmAnalyzeSettings>): Promise<CommandOutput>`	Analyze dependencies and circular imports: `dpdm <flags> <entries...>`.