Skip to content

Commit f4aa6f5

Browse files
committed
Update deps for nodeModuleNames option.
1 parent 56b709d commit f4aa6f5

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,42 @@ DependencyTree("./this-does-not-exist.js", { allowNotFound: true });
5151
// returns []
5252
```
5353

54-
### `nodeModuleNamesOnly`
54+
### `nodeModuleNames`
5555

56-
(Added in v2.0.0) Navigates all the local files and returns a list of unique package names (not file names) required.
56+
(Added in v2.0.1) Controls whether or not node package names are included in the list of dependencies.
57+
58+
* `nodeModuleNames: "include"`: included alongside the local JS files.
59+
* `nodeModuleNames: "exclude"` (default): node module package names are excluded.
60+
* `nodeModuleNames: "only"`: only node module package names are returned.
61+
62+
```js
63+
// my-file.js:
64+
65+
require("./my-local-dependency.js");
66+
require("@11ty/eleventy");
67+
```
5768

5869
```js
5970
const DependencyTree = require("@11ty/dependency-tree");
6071

61-
DependencyTree("./this-does-not-exist.js", { nodeModuleNamesOnly: true });
62-
// returns []
63-
```
72+
DependencyTree("./my-file.js");
73+
// returns ["./my-local-dependency.js"]
74+
75+
DependencyTree("./my-file.js", { nodeModuleNames: "exclude" });
76+
// returns ["./my-local-dependency.js"]
77+
78+
DependencyTree("./my-file.js", { nodeModuleNames: "include" });
79+
// returns ["./my-local-dependency.js", "@11ty/eleventy"]
80+
81+
DependencyTree("./my-file.js", { nodeModuleNames: "only" });
82+
// returns ["@11ty/eleventy"]
83+
```
84+
85+
#### (Deprecated) `nodeModuleNamesOnly`
86+
87+
(Added in v2.0.0) Changed to use `nodeModuleNames` option instead. Backwards compatibility is maintained automatically.
88+
89+
* `nodeModuleNamesOnly: false` is mapped to `nodeModuleNames: "exclude"`
90+
* `nodeModuleNamesOnly: true` is mapped to `nodeModuleNames: "only"`
91+
92+
If both `nodeModuleNamesOnly` and `nodeModuleNames` are included in options, `nodeModuleNames` takes precedence.

0 commit comments

Comments
 (0)