Skip to content

Commit 1ff0dfa

Browse files
committed
Docs for nodeModuleNamesOnly
1 parent dccf473 commit 1ff0dfa

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ npm install --save-dev @11ty/dependency-tree
1717
## Features
1818

1919
* Ignores `node_modules`
20+
* Or, use `nodeModuleNamesOnly` to return a list of node_modules packages.
2021
* Ignores Node’s built-ins (e.g. `path`)
2122
* Handles circular dependencies (Node does this too)
2223

@@ -48,4 +49,15 @@ DependencyTree("./this-does-not-exist.js"); // throws an error
4849

4950
DependencyTree("./this-does-not-exist.js", { allowNotFound: true });
5051
// returns []
52+
```
53+
54+
### `nodeModuleNamesOnly`
55+
56+
Navigates all the local files and returns a list of unique package names (not file names) required.
57+
58+
```js
59+
const DependencyTree = require("@11ty/dependency-tree");
60+
61+
DependencyTree("./this-does-not-exist.js", { nodeModuleNamesOnly: true });
62+
// returns []
5163
```

0 commit comments

Comments
 (0)