Skip to content

Commit 369eb67

Browse files
committed
docs: Clarify script working directory behavior (fixes npm#8305)
1 parent 9cb9d50 commit 369eb67

3 files changed

Lines changed: 39 additions & 210 deletions

File tree

DEPENDENCIES.json

Lines changed: 15 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -10,87 +10,43 @@
1010
"libnpmpack"
1111
],
1212
[
13-
"@npmcli/arborist"
14-
],
15-
[
16-
"@npmcli/metavuln-calculator"
17-
],
18-
[
19-
"pacote",
13+
"@npmcli/arborist",
2014
"@npmcli/config",
2115
"libnpmversion"
2216
],
2317
[
24-
"@npmcli/run-script",
2518
"@npmcli/map-workspaces",
26-
"libnpmaccess",
27-
"libnpmorg",
28-
"libnpmpublish",
29-
"libnpmsearch",
30-
"libnpmteam",
31-
"init-package-json",
32-
"npm-profile"
19+
"@npmcli/run-script"
3320
],
3421
[
35-
"@npmcli/package-json",
36-
"npm-registry-fetch"
37-
],
38-
[
39-
"@npmcli/git",
40-
"make-fetch-happen"
22+
"@npmcli/package-json"
4123
],
4224
[
4325
"@npmcli/smoke-tests",
44-
"npm-pick-manifest",
45-
"@npmcli/installed-package-contents",
46-
"cacache",
47-
"promzard"
26+
"@npmcli/git",
27+
"libnpmpublish"
4828
],
4929
[
5030
"@npmcli/docs",
51-
"npm-package-arg",
5231
"@npmcli/promise-spawn",
53-
"npm-install-checks",
54-
"npm-bundled",
55-
"@npmcli/fs",
56-
"unique-filename",
57-
"npm-packlist",
5832
"@npmcli/mock-globals",
59-
"bin-links",
60-
"nopt",
61-
"parse-conflict-json",
62-
"read-package-json-fast",
63-
"read",
64-
"normalize-package-data"
33+
"@npmcli/fs",
34+
"@npmcli/metavuln-calculator",
35+
"libnpmaccess",
36+
"libnpmorg",
37+
"libnpmsearch",
38+
"libnpmteam"
6539
],
6640
[
6741
"@npmcli/eslint-config",
6842
"@npmcli/template-oss",
69-
"ignore-walk",
7043
"semver",
71-
"hosted-git-info",
72-
"proc-log",
73-
"validate-npm-package-name",
7444
"which",
75-
"ini",
76-
"npm-normalize-package-bin",
77-
"json-parse-even-better-errors",
78-
"@npmcli/node-gyp",
79-
"ssri",
80-
"unique-slug",
81-
"@npmcli/redact",
82-
"@npmcli/agent",
83-
"minipass-fetch",
45+
"@npmcli/installed-package-contents",
8446
"@npmcli/name-from-folder",
47+
"@npmcli/node-gyp",
8548
"@npmcli/query",
86-
"cmd-shim",
87-
"read-cmd-shim",
88-
"write-file-atomic",
89-
"abbrev",
90-
"proggy",
91-
"minify-registry-metadata",
92-
"mute-stream",
93-
"npm-audit-report",
94-
"npm-user-validate"
49+
"@npmcli/redact",
50+
"abbrev"
9551
]
9652
]

DEPENDENCIES.md

Lines changed: 6 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -3,93 +3,44 @@
33
## `github.com/npm/` only
44
```mermaid
55
graph LR;
6-
bin-links-->cmd-shim;
7-
bin-links-->npm-normalize-package-bin;
8-
bin-links-->proc-log;
9-
bin-links-->read-cmd-shim;
10-
bin-links-->write-file-atomic;
11-
cacache-->npmcli-fs["@npmcli/fs"];
12-
cacache-->ssri;
13-
cacache-->unique-filename;
14-
init-package-json-->npm-package-arg;
15-
init-package-json-->npmcli-package-json["@npmcli/package-json"];
16-
init-package-json-->promzard;
17-
init-package-json-->read;
18-
init-package-json-->semver;
19-
init-package-json-->validate-npm-package-name;
20-
libnpmaccess-->npm-package-arg;
21-
libnpmaccess-->npm-registry-fetch;
226
libnpmaccess-->npmcli-eslint-config["@npmcli/eslint-config"];
237
libnpmaccess-->npmcli-mock-registry["@npmcli/mock-registry"];
248
libnpmaccess-->npmcli-template-oss["@npmcli/template-oss"];
25-
libnpmdiff-->npm-package-arg;
269
libnpmdiff-->npmcli-arborist["@npmcli/arborist"];
2710
libnpmdiff-->npmcli-eslint-config["@npmcli/eslint-config"];
2811
libnpmdiff-->npmcli-installed-package-contents["@npmcli/installed-package-contents"];
2912
libnpmdiff-->npmcli-template-oss["@npmcli/template-oss"];
30-
libnpmdiff-->pacote;
31-
libnpmexec-->bin-links;
32-
libnpmexec-->npm-package-arg;
3313
libnpmexec-->npmcli-arborist["@npmcli/arborist"];
3414
libnpmexec-->npmcli-eslint-config["@npmcli/eslint-config"];
3515
libnpmexec-->npmcli-mock-registry["@npmcli/mock-registry"];
3616
libnpmexec-->npmcli-package-json["@npmcli/package-json"];
3717
libnpmexec-->npmcli-run-script["@npmcli/run-script"];
3818
libnpmexec-->npmcli-template-oss["@npmcli/template-oss"];
39-
libnpmexec-->pacote;
40-
libnpmexec-->proc-log;
41-
libnpmexec-->read-package-json-fast;
42-
libnpmexec-->read;
4319
libnpmexec-->semver;
4420
libnpmfund-->npmcli-arborist["@npmcli/arborist"];
4521
libnpmfund-->npmcli-eslint-config["@npmcli/eslint-config"];
4622
libnpmfund-->npmcli-template-oss["@npmcli/template-oss"];
47-
libnpmorg-->npm-registry-fetch;
4823
libnpmorg-->npmcli-eslint-config["@npmcli/eslint-config"];
4924
libnpmorg-->npmcli-template-oss["@npmcli/template-oss"];
50-
libnpmpack-->npm-package-arg;
5125
libnpmpack-->npmcli-arborist["@npmcli/arborist"];
5226
libnpmpack-->npmcli-eslint-config["@npmcli/eslint-config"];
5327
libnpmpack-->npmcli-run-script["@npmcli/run-script"];
5428
libnpmpack-->npmcli-template-oss["@npmcli/template-oss"];
55-
libnpmpack-->pacote;
56-
libnpmpublish-->normalize-package-data;
57-
libnpmpublish-->npm-package-arg;
58-
libnpmpublish-->npm-registry-fetch;
5929
libnpmpublish-->npmcli-eslint-config["@npmcli/eslint-config"];
6030
libnpmpublish-->npmcli-mock-globals["@npmcli/mock-globals"];
6131
libnpmpublish-->npmcli-mock-registry["@npmcli/mock-registry"];
6232
libnpmpublish-->npmcli-template-oss["@npmcli/template-oss"];
63-
libnpmpublish-->proc-log;
6433
libnpmpublish-->semver;
65-
libnpmpublish-->ssri;
66-
libnpmsearch-->npm-registry-fetch;
6734
libnpmsearch-->npmcli-eslint-config["@npmcli/eslint-config"];
6835
libnpmsearch-->npmcli-template-oss["@npmcli/template-oss"];
69-
libnpmteam-->npm-registry-fetch;
7036
libnpmteam-->npmcli-eslint-config["@npmcli/eslint-config"];
7137
libnpmteam-->npmcli-template-oss["@npmcli/template-oss"];
72-
libnpmversion-->json-parse-even-better-errors;
7338
libnpmversion-->npmcli-eslint-config["@npmcli/eslint-config"];
7439
libnpmversion-->npmcli-git["@npmcli/git"];
7540
libnpmversion-->npmcli-run-script["@npmcli/run-script"];
7641
libnpmversion-->npmcli-template-oss["@npmcli/template-oss"];
77-
libnpmversion-->proc-log;
7842
libnpmversion-->semver;
79-
make-fetch-happen-->cacache;
80-
make-fetch-happen-->minipass-fetch;
81-
make-fetch-happen-->npmcli-agent["@npmcli/agent"];
82-
make-fetch-happen-->proc-log;
83-
make-fetch-happen-->ssri;
84-
nopt-->abbrev;
85-
normalize-package-data-->hosted-git-info;
86-
normalize-package-data-->semver;
8743
npm-->abbrev;
88-
npm-->cacache;
89-
npm-->hosted-git-info;
90-
npm-->ini;
91-
npm-->init-package-json;
92-
npm-->json-parse-even-better-errors;
9344
npm-->libnpmaccess;
9445
npm-->libnpmdiff;
9546
npm-->libnpmexec;
@@ -100,17 +51,6 @@ graph LR;
10051
npm-->libnpmsearch;
10152
npm-->libnpmteam;
10253
npm-->libnpmversion;
103-
npm-->make-fetch-happen;
104-
npm-->nopt;
105-
npm-->normalize-package-data;
106-
npm-->npm-audit-report;
107-
npm-->npm-install-checks;
108-
npm-->npm-package-arg;
109-
npm-->npm-packlist;
110-
npm-->npm-pick-manifest;
111-
npm-->npm-profile;
112-
npm-->npm-registry-fetch;
113-
npm-->npm-user-validate;
11454
npm-->npmcli-arborist["@npmcli/arborist"];
11555
npm-->npmcli-config["@npmcli/config"];
11656
npm-->npmcli-docs["@npmcli/docs"];
@@ -126,41 +66,8 @@ graph LR;
12666
npm-->npmcli-run-script["@npmcli/run-script"];
12767
npm-->npmcli-smoke-tests["@npmcli/smoke-tests"];
12868
npm-->npmcli-template-oss["@npmcli/template-oss"];
129-
npm-->pacote;
130-
npm-->parse-conflict-json;
131-
npm-->proc-log;
132-
npm-->read;
13369
npm-->semver;
134-
npm-->ssri;
135-
npm-->validate-npm-package-name;
13670
npm-->which;
137-
npm-bundled-->npm-normalize-package-bin;
138-
npm-install-checks-->semver;
139-
npm-package-arg-->hosted-git-info;
140-
npm-package-arg-->proc-log;
141-
npm-package-arg-->semver;
142-
npm-package-arg-->validate-npm-package-name;
143-
npm-packlist-->ignore-walk;
144-
npm-pick-manifest-->npm-install-checks;
145-
npm-pick-manifest-->npm-normalize-package-bin;
146-
npm-pick-manifest-->npm-package-arg;
147-
npm-pick-manifest-->semver;
148-
npm-profile-->npm-registry-fetch;
149-
npm-profile-->proc-log;
150-
npm-registry-fetch-->make-fetch-happen;
151-
npm-registry-fetch-->minipass-fetch;
152-
npm-registry-fetch-->npm-package-arg;
153-
npm-registry-fetch-->npmcli-redact["@npmcli/redact"];
154-
npm-registry-fetch-->proc-log;
155-
npmcli-arborist-->bin-links;
156-
npmcli-arborist-->cacache;
157-
npmcli-arborist-->hosted-git-info;
158-
npmcli-arborist-->minify-registry-metadata;
159-
npmcli-arborist-->nopt;
160-
npmcli-arborist-->npm-install-checks;
161-
npmcli-arborist-->npm-package-arg;
162-
npmcli-arborist-->npm-pick-manifest;
163-
npmcli-arborist-->npm-registry-fetch;
16471
npmcli-arborist-->npmcli-eslint-config["@npmcli/eslint-config"];
16572
npmcli-arborist-->npmcli-fs["@npmcli/fs"];
16673
npmcli-arborist-->npmcli-installed-package-contents["@npmcli/installed-package-contents"];
@@ -174,83 +81,40 @@ graph LR;
17481
npmcli-arborist-->npmcli-redact["@npmcli/redact"];
17582
npmcli-arborist-->npmcli-run-script["@npmcli/run-script"];
17683
npmcli-arborist-->npmcli-template-oss["@npmcli/template-oss"];
177-
npmcli-arborist-->pacote;
178-
npmcli-arborist-->parse-conflict-json;
179-
npmcli-arborist-->proc-log;
180-
npmcli-arborist-->proggy;
181-
npmcli-arborist-->read-package-json-fast;
18284
npmcli-arborist-->semver;
183-
npmcli-arborist-->ssri;
184-
npmcli-config-->ini;
185-
npmcli-config-->nopt;
18685
npmcli-config-->npmcli-eslint-config["@npmcli/eslint-config"];
18786
npmcli-config-->npmcli-map-workspaces["@npmcli/map-workspaces"];
18887
npmcli-config-->npmcli-mock-globals["@npmcli/mock-globals"];
18988
npmcli-config-->npmcli-package-json["@npmcli/package-json"];
19089
npmcli-config-->npmcli-template-oss["@npmcli/template-oss"];
191-
npmcli-config-->proc-log;
19290
npmcli-config-->semver;
193-
npmcli-docs-->ignore-walk;
19491
npmcli-docs-->npmcli-eslint-config["@npmcli/eslint-config"];
19592
npmcli-docs-->npmcli-template-oss["@npmcli/template-oss"];
19693
npmcli-docs-->semver;
19794
npmcli-fs-->semver;
198-
npmcli-git-->ini;
199-
npmcli-git-->npm-pick-manifest;
20095
npmcli-git-->npmcli-promise-spawn["@npmcli/promise-spawn"];
201-
npmcli-git-->proc-log;
20296
npmcli-git-->semver;
20397
npmcli-git-->which;
204-
npmcli-installed-package-contents-->npm-bundled;
205-
npmcli-installed-package-contents-->npm-normalize-package-bin;
20698
npmcli-map-workspaces-->npmcli-name-from-folder["@npmcli/name-from-folder"];
20799
npmcli-map-workspaces-->npmcli-package-json["@npmcli/package-json"];
208-
npmcli-metavuln-calculator-->cacache;
209-
npmcli-metavuln-calculator-->json-parse-even-better-errors;
210-
npmcli-metavuln-calculator-->pacote;
211-
npmcli-metavuln-calculator-->proc-log;
212100
npmcli-metavuln-calculator-->semver;
213101
npmcli-mock-globals-->npmcli-eslint-config["@npmcli/eslint-config"];
214102
npmcli-mock-globals-->npmcli-template-oss["@npmcli/template-oss"];
215-
npmcli-mock-registry-->npm-package-arg;
216103
npmcli-mock-registry-->npmcli-arborist["@npmcli/arborist"];
217104
npmcli-mock-registry-->npmcli-eslint-config["@npmcli/eslint-config"];
218105
npmcli-mock-registry-->npmcli-template-oss["@npmcli/template-oss"];
219-
npmcli-mock-registry-->pacote;
220-
npmcli-package-json-->hosted-git-info;
221-
npmcli-package-json-->json-parse-even-better-errors;
222106
npmcli-package-json-->npmcli-git["@npmcli/git"];
223-
npmcli-package-json-->proc-log;
224107
npmcli-package-json-->semver;
225108
npmcli-promise-spawn-->which;
226109
npmcli-run-script-->npmcli-node-gyp["@npmcli/node-gyp"];
227110
npmcli-run-script-->npmcli-package-json["@npmcli/package-json"];
228111
npmcli-run-script-->npmcli-promise-spawn["@npmcli/promise-spawn"];
229-
npmcli-run-script-->proc-log;
230112
npmcli-run-script-->which;
231113
npmcli-smoke-tests-->npmcli-eslint-config["@npmcli/eslint-config"];
232114
npmcli-smoke-tests-->npmcli-mock-registry["@npmcli/mock-registry"];
233115
npmcli-smoke-tests-->npmcli-promise-spawn["@npmcli/promise-spawn"];
234116
npmcli-smoke-tests-->npmcli-template-oss["@npmcli/template-oss"];
235117
npmcli-smoke-tests-->which;
236-
pacote-->cacache;
237-
pacote-->npm-package-arg;
238-
pacote-->npm-packlist;
239-
pacote-->npm-pick-manifest;
240-
pacote-->npm-registry-fetch;
241-
pacote-->npmcli-git["@npmcli/git"];
242-
pacote-->npmcli-installed-package-contents["@npmcli/installed-package-contents"];
243-
pacote-->npmcli-package-json["@npmcli/package-json"];
244-
pacote-->npmcli-promise-spawn["@npmcli/promise-spawn"];
245-
pacote-->npmcli-run-script["@npmcli/run-script"];
246-
pacote-->proc-log;
247-
pacote-->ssri;
248-
parse-conflict-json-->json-parse-even-better-errors;
249-
promzard-->read;
250-
read-->mute-stream;
251-
read-package-json-fast-->json-parse-even-better-errors;
252-
read-package-json-fast-->npm-normalize-package-bin;
253-
unique-filename-->unique-slug;
254118
```
255119

256120
## all dependencies
@@ -778,12 +642,9 @@ packages higher up the chain.
778642

779643
- npm
780644
- @npmcli/mock-registry, libnpmdiff, libnpmexec, libnpmfund, libnpmpack
781-
- @npmcli/arborist
782-
- @npmcli/metavuln-calculator
783-
- pacote, @npmcli/config, libnpmversion
784-
- @npmcli/run-script, @npmcli/map-workspaces, libnpmaccess, libnpmorg, libnpmpublish, libnpmsearch, libnpmteam, init-package-json, npm-profile
785-
- @npmcli/package-json, npm-registry-fetch
786-
- @npmcli/git, make-fetch-happen
787-
- @npmcli/smoke-tests, npm-pick-manifest, @npmcli/installed-package-contents, cacache, promzard
788-
- @npmcli/docs, npm-package-arg, @npmcli/promise-spawn, npm-install-checks, npm-bundled, @npmcli/fs, unique-filename, npm-packlist, @npmcli/mock-globals, bin-links, nopt, parse-conflict-json, read-package-json-fast, read, normalize-package-data
789-
- @npmcli/eslint-config, @npmcli/template-oss, ignore-walk, semver, hosted-git-info, proc-log, validate-npm-package-name, which, ini, npm-normalize-package-bin, json-parse-even-better-errors, @npmcli/node-gyp, ssri, unique-slug, @npmcli/redact, @npmcli/agent, minipass-fetch, @npmcli/name-from-folder, @npmcli/query, cmd-shim, read-cmd-shim, write-file-atomic, abbrev, proggy, minify-registry-metadata, mute-stream, npm-audit-report, npm-user-validate
645+
- @npmcli/arborist, @npmcli/config, libnpmversion
646+
- @npmcli/map-workspaces, @npmcli/run-script
647+
- @npmcli/package-json
648+
- @npmcli/smoke-tests, @npmcli/git, libnpmpublish
649+
- @npmcli/docs, @npmcli/promise-spawn, @npmcli/mock-globals, @npmcli/fs, @npmcli/metavuln-calculator, libnpmaccess, libnpmorg, libnpmsearch, libnpmteam
650+
- @npmcli/eslint-config, @npmcli/template-oss, semver, which, @npmcli/installed-package-contents, @npmcli/name-from-folder, @npmcli/node-gyp, @npmcli/query, @npmcli/redact, abbrev

0 commit comments

Comments
 (0)