Skip to content

Commit 3f8c41d

Browse files
committed
docs: update pnpmfile settings
1 parent 28e1f7f commit 3f8c41d

File tree

5 files changed

+49
-26
lines changed

5 files changed

+49
-26
lines changed

docs/pnpmfile.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -176,36 +176,16 @@ This hook allows to override the fetchers that are used for different types of d
176176

177177
## Related Configuration
178178

179-
### ignore-pnpmfile
179+
import IgnorePnpmfile from './settings/_ignorePnpmfile.mdx'
180180

181-
* Default: **false**
182-
* Type: **Boolean**
181+
<IgnorePnpmfile />
183182

184-
`.pnpmfile.cjs` will be ignored. Useful together with `--ignore-scripts` when you
185-
want to make sure that no script gets executed during install.
183+
import Pnpmfile from './settings/_pnpmfile.mdx'
186184

187-
### pnpmfile
185+
<Pnpmfile />
188186

189-
* Default: **.pnpmfile.cjs**
190-
* Type: **path**
191-
* Example: **.pnpm/.pnpmfile.cjs**
187+
import GlobalPnpmfile from './settings/_globalPnpmfile.mdx'
192188

193-
The location of the local pnpmfile.
194-
195-
### global-pnpmfile
196-
197-
* Default: **null**
198-
* Type: **path**
199-
* Example: **~/.pnpm/global_pnpmfile.cjs**
200-
201-
The location of a global pnpmfile. A global pnpmfile is used by all projects
202-
during installation.
203-
204-
:::note
205-
206-
It is recommended to use local pnpmfiles. Only use a global pnpmfile
207-
if you use pnpm on projects that don't use pnpm as the primary package manager.
208-
209-
:::
189+
<GlobalPnpmfile />
210190

211191
[`pnpm patch`]: ./cli/patch.md

docs/settings.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1540,6 +1540,20 @@ auditConfig:
15401540

15411541
[`pnpm audit`]: ./cli/audit.md
15421542

1543+
## Pnpmfile
1544+
1545+
import IgnorePnpmfile from './settings/_ignorePnpmfile.mdx'
1546+
1547+
<IgnorePnpmfile />
1548+
1549+
import Pnpmfile from './settings/_pnpmfile.mdx'
1550+
1551+
<Pnpmfile />
1552+
1553+
import GlobalPnpmfile from './settings/_globalPnpmfile.mdx'
1554+
1555+
<GlobalPnpmfile />
1556+
15431557
## Other Settings
15441558

15451559
### savePrefix

docs/settings/_globalPnpmfile.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### globalPnpmfile
2+
3+
* Default: **null**
4+
* Type: **path**
5+
* Example: **~/.pnpm/global_pnpmfile.cjs**
6+
7+
The location of a global pnpmfile. A global pnpmfile is used by all projects
8+
during installation.
9+
10+
:::note
11+
12+
It is recommended to use local pnpmfiles. Only use a global pnpmfile
13+
if you use pnpm on projects that don't use pnpm as the primary package manager.
14+
15+
:::

docs/settings/_ignorePnpmfile.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### ignorePnpmfile
2+
3+
* Default: **false**
4+
* Type: **Boolean**
5+
6+
`.pnpmfile.cjs` will be ignored. Useful together with `--ignore-scripts` when you
7+
want to make sure that no script gets executed during install.

docs/settings/_pnpmfile.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### pnpmfile
2+
3+
* Default: **['.pnpmfile.cjs']**
4+
* Type: **path[]**
5+
* Example: **['.pnpm/.pnpmfile.cjs']**
6+
7+
The location of the local pnpmfile(s).

0 commit comments

Comments
 (0)