lunaisadev-website-old/node_modules/@11ty/dependency-tree
Luna 4f63b4f9a0 first commit 2021-07-27 18:40:12 -07:00
..
test first commit 2021-07-27 18:40:12 -07:00
LICENSE first commit 2021-07-27 18:40:12 -07:00
README.md first commit 2021-07-27 18:40:12 -07:00
main.js first commit 2021-07-27 18:40:12 -07:00
package.json first commit 2021-07-27 18:40:12 -07:00

README.md

dependency-tree

Returns an unordered array of local paths to dependencies of a node JavaScript file (everything it or any of its dependencies requires).

Reduced feature (faster) alternative to the dependency-tree package that only works with stock node JS. This is used by Eleventy to find dependencies of a JavaScript file to watch for changes to re-run Eleventys build.

Installation

npm install --save-dev @11ty/dependency-tree

Features

  • Ignores node_modules
  • Ignores Nodes built-ins (e.g. path)
  • Handles circular dependencies (Node does this too)

Usage

// my-file.js

// if my-local-dependency.js has dependencies, it will include those too
const test = require("./my-local-dependency.js");

// ignored, is a built-in
const path = require("path");
const DependencyTree = require("@11ty/dependency-tree");

DependencyTree("./my-file.js");
// returns ["./my-local-dependency.js"]

allowNotFound

const DependencyTree = require("@11ty/dependency-tree");

DependencyTree("./this-does-not-exist.js"); // throws an error

DependencyTree("./this-does-not-exist.js", { allowNotFound: true });
// returns []