Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acrazing/dpdm
Detect circular dependencies in your TypeScript projects.
https://github.com/acrazing/dpdm
circular command-line dependency javascript madge typescript typescript3 visualization
Last synced: about 19 hours ago
JSON representation
Detect circular dependencies in your TypeScript projects.
- Host: GitHub
- URL: https://github.com/acrazing/dpdm
- Owner: acrazing
- License: mit
- Created: 2019-07-13T04:59:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T17:02:34.000Z (about 1 month ago)
- Last Synced: 2024-10-28T21:40:41.428Z (11 days ago)
- Topics: circular, command-line, dependency, javascript, madge, typescript, typescript3, visualization
- Language: TypeScript
- Homepage:
- Size: 1.05 MB
- Stars: 714
- Watchers: 3
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - acrazing/dpdm - Detect circular dependencies in your TypeScript projects. (TypeScript)
README
DPDM
A robust static dependency analyzer for your JavaScript and TypeScript projects.
Highlights
|
Install
|
Usage
|
Options
|
API
## Highlights
- Supports `CommonJS`, `ESM`.
- Supports `JavaScript` and `TypeScript` completely.
- Supports TypeScript [path mapping](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping).
- Supports ignore TypeScript type dependencies.
- Light weight: use [TypeScript](https://npmjs.com/package/typescript) to parse all modules.
- Fast: use asynchronous API to load modules.
- Stable output: This is compared to `madge`, whose results are completely inconclusive when analyze `TypeScript`.
## Install
1. For command line
```bash
npm i -g dpdm
# or via yarn
yarn global add dpdm
```
2. As a module
```bash
npm i -D dpdm
# or via yarn
yarn add -D dpdm
```
## Usage in command line
1. Simple usage
```bash
dpdm ./src/index.ts
```
2. Print circular dependencies only
```bash
dpdm --no-warning --no-tree ./src/index.ts
```
3. Exit with a non-zero code if a circular dependency is found.
```bash
dpdm --exit-code circular:1 ./src/index.ts
```
4. Ignore type dependencies for TypeScript modules
```bash
dpdm -T ./src/index.ts
```
5. Find unused files by `index.js` in `src` directory:
```bash
dpdm --no-tree --no-warning --no-circular --detect-unused-files-from 'src/**/*.*' 'index.js'
```
6. Skip dynamic imports:
```bash
# The value circular will only ignore the dynamic imports
# when parse circular references.
# You can set it as tree to ignore the dynamic imports
# when parse source files.
dpdm --skip-dynamic-imports circular index.js
```
### Options
```bash
dpdm [options]
Analyze the files' dependencies.
Positionals:
files The file paths or globs [string]
Options:
--version Show version number [boolean]
--context the context directory to shorten path, default is current
directory [string]
--extensions, --ext comma separated extensions to resolve
[string] [default: ".ts,.tsx,.mjs,.js,.jsx,.json"]
--js comma separated extensions indicate the file is js like
[string] [default: ".ts,.tsx,.mjs,.js,.jsx"]
--include included filenames regexp in string, default includes all files
[string] [default: ".*"]
--exclude excluded filenames regexp in string, set as empty string to
include all files [string] [default: "node_modules"]
-o, --output output json to file [string]
--tree print tree to stdout [boolean] [default: true]
--circular print circular to stdout [boolean] [default: true]
--warning print warning to stdout [boolean] [default: true]
--tsconfig the tsconfig path, which is used for resolve path alias, default
is tsconfig.json if it exists in context directory [string]
-T, --transform transform typescript modules to javascript before analyze, it
allows you to omit types dependency in typescript
[boolean] [default: false]
--exit-code exit with specified code, the value format is CASE:CODE,
`circular` is the only supported CASE, CODE should be a integer
between 0 and 128. For example: `dpdm --exit-code circular:1` the
program will exit with code 1 if circular dependency found.
[string]
--progress show progress bar [boolean] [default: true]
--detect-unused-files-from this file is a glob, used for finding unused files. [string]
--skip-dynamic-imports Skip parse import(...) statement.
[string] [choices: "tree", "circular"]
-h, --help Show help [boolean]
```
### Example output
## Usage as a package
```typescript jsx
import { parseDependencyTree, parseCircular, prettyCircular } from 'dpdm';
parseDependencyTree('./index', {
/* options, see below */
}).then((tree) => {
const circulars = parseCircular(tree);
console.log(prettyCircular(circulars));
});
```
### API Reference
1. `parseDependencyTree(entries, option, output)`: parse dependencies for glob entries
```typescript jsx
/**
* @param entries - the glob entries to match
* @param options - the options, see below
*/
export declare function parseDependencyTree(
entries: string | string[],
options: ParserOptions,
): Promise;
/**
* the parse options
*/
export interface ParseOptions {
context: string;
extensions: string[];
js: string[];
include: RegExp;
exclude: RegExp;
tsconfig: string | undefined;
onProgress: (event: 'start' | 'end', target: string) => void;
transform: boolean;
skipDynamicImports: boolean;
}
export enum DependencyKind {
CommonJS = 'CommonJS', // require
StaticImport = 'StaticImport', // import ... from "foo"
DynamicImport = 'DynamicImport', // import("foo")
StaticExport = 'StaticExport', // export ... from "foo"
}
export interface Dependency {
issuer: string;
request: string;
kind: DependencyKind;
id: string | null; // the shortened, resolved filename, if cannot resolve, it will be null
}
// the parse tree result, key is file id, value is its dependencies
// if file is ignored, it will be null
export type DependencyTree = Record;
```
2. `parseCircular(tree)`: parse circulars in dependency tree
```typescript jsx
export declare function parseCircular(tree: DependencyTree): string[][];
```
## TODOs
- [ ] Supports HTML and HTML like modules
- [ ] Supports CSS and CSS like modules
- [ ] Prints interactive SVG