summaryrefslogtreecommitdiff
path: root/node_modules/@11ty/dependency-tree-esm/README.md
diff options
context:
space:
mode:
authorShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
committerShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
commit7a52ddeba2a68388b544f529d2d92104420f77b0 (patch)
tree15ddd47457a2cb4a96060747437d36474e4f6b4e /node_modules/@11ty/dependency-tree-esm/README.md
parent53d6ae2b5568437afa5e4995580a3fb679b7b91b (diff)
Changed from static to 11ty!
Diffstat (limited to 'node_modules/@11ty/dependency-tree-esm/README.md')
-rw-r--r--node_modules/@11ty/dependency-tree-esm/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/@11ty/dependency-tree-esm/README.md b/node_modules/@11ty/dependency-tree-esm/README.md
new file mode 100644
index 0000000..56b0f56
--- /dev/null
+++ b/node_modules/@11ty/dependency-tree-esm/README.md
@@ -0,0 +1,40 @@
+# `dependency-tree-esm`
+
+Returns an unordered array of local paths to dependencies of a Node ES module JavaScript file.
+
+* See also: [`dependency-tree`](https://github.com/11ty/eleventy-dependency-tree) for the CommonJS version.
+
+This is used by Eleventy to find dependencies of a JavaScript file to watch for changes to re-run Eleventy’s build.
+
+## Installation
+
+```
+npm install --save-dev @11ty/dependency-tree-esm
+```
+
+## Features
+
+* Ignores bare specifiers (e.g. `import "my-package"`)
+* Ignores Node’s built-ins (e.g. `import "path"`)
+* Handles circular dependencies
+* Returns an empty set if the file does not exist.
+
+## Usage
+
+```js
+// my-file.js
+
+// if my-local-dependency.js has dependencies, it will include those too
+import "./my-local-dependency.js";
+
+
+// ignored, is a built-in
+import path from "path";
+```
+
+```js
+const { find } = require("@11ty/dependency-tree-esm");
+
+await find("./my-file.js");
+// returns ["./my-local-dependency.js"]
+```