You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,9 @@ There are several options to integrate Mockup.
31
31
32
32
This starts up the webpack build process in watch mode.
33
33
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.
35
35
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.
37
37
38
38
- Go to `http://localhost:8000`:
39
39
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:
124
124
1. Run `make watch-plone`. You need buildout to have plone.staticresources checked out next to Mockup.
125
125
Mockup will compile it's bundle directly into the `++plone++static` directory of plone.staticresources and update it when you change something in Mockup.
126
126
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`.
128
128
129
129
For more commands inspect Makefile and the script part of the package.json.
130
130
@@ -166,17 +166,17 @@ You can put some `debugger;` statements to the code to break the execution and i
166
166
167
167
### Developing external Packages
168
168
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`.
170
170
171
171
1. Check out the external package you want to develop on.
172
172
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!)
174
174
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.
176
176
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.
178
178
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.
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.
322
322
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`.
324
324
325
325
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.
0 commit comments