walk-package-graph

walkPackageGraph

• walkPackageGraph(root: string, walkHandlers?: IWalkHandlers, resolveDevDependency?: boolean): void

• Starts to walk package dependency graph and runs walkHandlers

  import { walkPackageGraph } from 'walk-package-graph';
  
  walkPackageGraph('/path/to/start', {
    onEnd(rootNode) {
      console.info('onEnd', rootNode + '');
    },
    onError(error) {
      console.error('onError', error.path, error.message);
    },
    onResolve(node) {
      console.info('onResolve', node.id, node.path, node.dependencies);
    },
    onUnresolve(node, unresolvedNames) {
      console.error('onUnresolve', node.path, unresolvedNames);
    },
    onVisit(node) {
      console.info('onVisit', node.path);
    }
  });

  Parameters

  • root: string

    A start path (a project root usually)

  • Default value walkHandlers: IWalkHandlers = {}

    Event handlers

  • Default value resolveDevDependency: boolean = false

    Resolve devDependencies or not.

  Returns void