Skip to content

Commit d939539

Browse files
committed
feat!: rename package to @pnpm/plugin-better-defaults
1 parent c010a37 commit d939539

File tree

3 files changed

+16
-41
lines changed

3 files changed

+16
-41
lines changed

README.md

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @pnpm/better-defaults
1+
# @pnpm/plugin-better-defaults
22

33
> Improved defaults for pnpm
44
@@ -17,46 +17,10 @@ You can extend or override these settings in your own `.pnpmfile.cjs`.
1717
## Installation
1818

1919
```
20-
pnpm add --config @pnpm/better-defaults
20+
pnpm add --config @pnpm/plugin-better-defaults
2121
```
2222

23-
This will add `@pnpm/better-defaults` to the [configDependencies](https://pnpm.io/config-dependencies) field in your `pnpm-workspace.yaml`.
24-
25-
## Usage
26-
27-
If you don't have a [pnpmfile](https://pnpm.io/pnpmfile) in your project, then add this to `pnpm-workspace.yaml`:
28-
29-
```yaml
30-
pnpmfile: node_modules/.pnpm-config/@pnpm/better-defaults/pnpmfile.cjs
31-
```
32-
33-
If you have a `.pnpmfile.cjs` already in your project, then you can reexport the `updateConfig` hooks from `@pnpm/better-defaults`. This should be your `.pnpmfile.cjs`:
34-
35-
```js
36-
module.exports = {
37-
hooks: {
38-
...require('.pnpm-config/@pnpm/better-defaults/pnpmfile.cjs').hooks,
39-
// Other hooks in your project
40-
}
41-
}
42-
```
43-
44-
Alternatively, you may have other changes in your `updateConfig` hook:
45-
46-
```js
47-
const { updateConfig: makeBetterDefaults } = require('.pnpm-config/@pnpm/better-defaults/pnpmfile.cjs').hooks
48-
49-
module.exports = {
50-
hooks: {
51-
updateConfig (config) {
52-
return {
53-
...makeBetterDefaults(config),
54-
hoistPattern: ['*'],
55-
}
56-
}
57-
}
58-
}
59-
```
23+
This will add `@pnpm/plugin-better-defaults` to the [configDependencies](https://pnpm.io/config-dependencies) field in your `pnpm-workspace.yaml`.
6024

6125
## License
6226

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@pnpm/better-defaults",
3-
"version": "0.2.2",
2+
"name": "@pnpm/plugin-better-defaults",
3+
"version": "0.1.0",
44
"description": "Improved defaults for pnpm",
55
"files": [
66
"pnpmfile.cjs"

pnpm-lock.yaml

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)