Skip to content

Commit 4413cbd

Browse files
committed
pnpm README: Change yarn occurrences with pnpm.
1 parent 39e8601 commit 4413cbd

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ There are several options to integrate Mockup.
3131

3232
This starts up the webpack build process in watch mode.
3333
Any JavaScript changes are immediately compiled.
34-
For some changes - like for adding new packages via `yarn add` and then using it you might need to restart.
34+
For some changes - like for adding new packages via `pnpm add` and then using it you might need to restart.
3535
The command also spins up a development server for our `11ty` based documentation and demo pages.
36-
If you don't need the docs running, you can run `yarn start:webpack` or `npm run start:webpack` instead, so that only the webpack devserver is running.
36+
If you don't need the docs running, you can run `pnpm start:webpack` or `npm run start:webpack` instead, so that only the webpack devserver is running.
3737

3838
- Go to `http://localhost:8000`:
3939
On this port our demo and documentation pages are served.
@@ -124,7 +124,7 @@ If you want to develop in Plone, you have two options:
124124
1. Run `make watch-plone`. You need buildout to have plone.staticresources checked out next to Mockup.
125125
Mockup will compile it's bundle directly into the `++plone++static` directory of plone.staticresources and update it when you change something in Mockup.
126126

127-
2. Run `npx yarn start:webpack`, go to the resource registry ( http://localhost:8080/Plone/@@resourceregistry-controlpanel ) and add the URL `http://localhost:8000/bundle.min.js` to the JavaScript input field of the plone bundle instead of the other URL `++plone++static/bundle-plone/bundle.min.js`.
127+
2. Run `npx pnpm start:webpack`, go to the resource registry ( http://localhost:8080/Plone/@@resourceregistry-controlpanel ) and add the URL `http://localhost:8000/bundle.min.js` to the JavaScript input field of the plone bundle instead of the other URL `++plone++static/bundle-plone/bundle.min.js`.
128128

129129
For more commands inspect Makefile and the script part of the package.json.
130130

@@ -166,17 +166,17 @@ You can put some `debugger;` statements to the code to break the execution and i
166166

167167
### Developing external Packages
168168

169-
If you want to work on ony external package like Patternslib or any external Mockup pattern you can do so by linking those packages into the node_modules folder via `yarn link`.
169+
If you want to work on ony external package like Patternslib or any external Mockup pattern you can do so by linking those packages into the node_modules folder via `pnpm link`.
170170

171171
1. Check out the external package you want to develop on.
172172

173-
2. Make sure you have installed the dependencies in the development package (e.g. by running `yarn install`). (TODO: verify that!)
173+
2. Make sure you have installed the dependencies in the development package (e.g. by running `pnpm install`). (TODO: verify that!)
174174

175-
3. Run `yarn link` in the external development package to register it with yarn.
175+
3. Run `pnpm link` in the external development package to register it with pnpm.
176176

177-
4. Run `yarn link "PACKAGE-NAME"` in mockup to create the node_modules symlink.
177+
4. Run `pnpm link "PACKAGE-NAME"` in mockup to create the node_modules symlink.
178178

179-
After developing you might want to run `yarn unlink "PACKAGE-NAME"` to unlink the development package.
179+
After developing you might want to run `pnpm unlink "PACKAGE-NAME"` to unlink the development package.
180180

181181
For more information see:
182182

@@ -195,7 +195,7 @@ https://formidable.com/blog/2018/finding-webpack-duplicates-with-inspectpack-plu
195195
Build the stats.json file:
196196

197197
```
198-
npx yarn build:stats
198+
npx pnpm build:stats
199199
```
200200

201201
Check dependency tree and why which package was included:
@@ -219,7 +219,7 @@ To update the translation file, the following needs to be done:
219219
1. Extract the messages from this package:
220220

221221
```
222-
npx yarn run i18n
222+
npx pnpm run i18n
223223
```
224224

225225
Or just `npm run i18n`...
@@ -290,7 +290,7 @@ Without grouping: `TYPE: MESSAGE`
290290

291291
If the commit message doesn't follow this convention, then it won't be included in the changelog.
292292
To bypass the pre-commit hook, use the git `-n` switch.
293-
Example: `git commit yarn.lock -m "yarn install." -n`.
293+
Example: `git commit pnpm-lock.yaml -m "pnpm install." -n`.
294294

295295
If you are working on a component like the structure pattern (pat-structure), use `pat structure` as a group.
296296

@@ -318,11 +318,11 @@ git commit -am "maint: Remove unnecessary file from root directory."
318318

319319
**Note**
320320

321-
Please keep commits on the `yarn.lock` file or any other auto-generated code seperate.
321+
Please keep commits on the `pnpm-lock.yaml` file or any other auto-generated code seperate.
322322

323-
Just commit them seperately with `git commit yarn.lock -m "yarn install" -n`.
323+
Just commit them seperately with `git commit pnpm-lock.yaml -m "pnpm install" -n`.
324324

325325
Keeping them seperate reduces the effort when merging or rebasing branches where a merge conflict can easily happen.
326-
In such cases you can just withdraw your changes on the `yarn.lock` file, or remove those commits and reinstall with `yarn install` at the end of a successful merge or rebase.
326+
In such cases you can just withdraw your changes on the `pnpm-lock.yaml` file, or remove those commits and reinstall with `pnpm install` at the end of a successful merge or rebase.
327327

328328
---

0 commit comments

Comments
 (0)