Skip to content

Commit 7ee9646

Browse files
committed
docs: configurational=>config dependencies
1 parent 6282eeb commit 7ee9646

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/config-dependencies.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: config-dependencies
3-
title: Configurational dependencies
3+
title: Config dependencies
44
---
55

6-
Configurational dependencies are installed before all the other types of dependencies (before "dependencies", "devDependencies", "optionalDependencies").
6+
Config dependencies are installed before all the other types of dependencies (before "dependencies", "devDependencies", "optionalDependencies").
77

8-
Configurational dependencies cannot have dependencies of their own or lifecycle scripts. They should be added using exact version and the integrity checksum. Example:
8+
Config dependencies cannot have dependencies of their own or lifecycle scripts. They should be added using exact version and the integrity checksum. Example:
99

1010
```yaml title="pnpm-workspace.yaml"
1111
configDependencies:
@@ -16,7 +16,7 @@ configDependencies:
1616
1717
### Loading an allow list of built dependencies
1818
19-
You may load a list of package names that are allowed to be built via configurational dependencies and the [`onlyBuiltDependenciesFile`] setting. For example, you may publish a package with an `allow.json` file in its root directory:
19+
You may load a list of package names that are allowed to be built via config dependencies and the [`onlyBuiltDependenciesFile`] setting. For example, you may publish a package with an `allow.json` file in its root directory:
2020

2121
```json
2222
[
@@ -39,9 +39,9 @@ This way your project will load the list of packages that are allowed to be buil
3939

4040
### Installing dependencies used in hooks
4141

42-
Configurational dependencies are installed before the hooks from [`.pnpmfile.cjs`] are loaded, so you can use them as dependencies for your hooks.
42+
Config dependencies are installed before the hooks from [`.pnpmfile.cjs`] are loaded, so you can use them as dependencies for your hooks.
4343

44-
For instance, you may have a configurational dependency called "my-hooks" that exports a `readPackage` hook. In this case, you can import it into your `.pnpmfile.cjs` like this:
44+
For instance, you may have a config dependency called "my-hooks" that exports a `readPackage` hook. In this case, you can import it into your `.pnpmfile.cjs` like this:
4545

4646
```js
4747
const { readPackage } = require('.pnpm-config/my-hooks')
@@ -104,7 +104,7 @@ This makes it easy to maintain and share centralized configuration and dependenc
104104

105105
### Loading patches
106106

107-
You can reference [patch files] installed via configurational dependencies. For instance, if you have a configurational dependency called "my-patches", you can load patches from it:
107+
You can reference [patch files] installed via config dependencies. For instance, if you have a config dependency called "my-patches", you can load patches from it:
108108

109109
```yaml
110110
configDependencies:

0 commit comments

Comments
 (0)