Package Exports

dpdm

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dpdm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dpdm

A dependency analyzer for JavaScript/TypeScript.

Install

npm i dpdm # or yarn add dpdm

# use as command line
npm i -g dpdm # or yarn global add dpdm
dpdm --help

Usage

Library

import { parseDependencyTree, parseCircular } from 'dpdm';

const tree = parseDependencyTree('./index', {
  /* options */
});
const circulars = parseCircular(tree);
console.log(circulars);

Command line

$ dpdm --help

dpdm.ts [<options>] entry...

Options:
  --version            Show version number  [boolean]
  --context            the context directory to shorten path, default is process.cwd()  [string]
  --extensions, --ext  comma separated extensions to resolve  [string] [default: ".js,.jsx,.ts,.tsx,.json"]
  --include            included filenames regexp in string  [string] [default: "\.[tj]sx?$"]
  --exclude            excluded filenames regexp in string  [string] [default: "/node_modules/"]
  --output, -o         output json to file  [string] [default: "dpdm.json"]
  --tree               print tree to stdout  [boolean] [default: true]
  --circular           print circular to stdout  [boolean] [default: true]
  --warning            print warning to stdout  [boolean] [default: true]
  -h, --help           Show help  [boolean]

API

parseDependencyTree(entry, option, output): parse dependencies for a single entry

export declare function parseDependencyTree(
  entry: string | string[],
  options: ParserOptions,
  output?: DependencyTree,
): Promise<DependencyTree>;

export interface ParseOptions {
  context: string;
  extensions: string[];
  include: RegExp;
  exclude: RegExp;
}

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;
  result: string;
}

export type DependencyTree = Record<string, Dependency[]>;

parseCircular(tree): parse circulars in dependency tree

export declare function parseCircular(tree: DependencyTree): string[][];

LICENSE

MIT