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: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This repository uses Markdown files to define changelog entries. If the changes in this pull request are **user-facing**, please create a changelog entry by running the following command:
4
4
5
-
yarn run nice
5
+
pnpm run nice
6
6
7
7
This will generate an `*.md` file in the `.changelog/` directory for your description. You can create as many as you need.
Copy file name to clipboardExpand all lines: docs/framework/contributing/development-environment.md
+16-22Lines changed: 16 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ modified_at: 2022-09-29
11
11
The CKEditor 5 codebase is divided into multiple [npm](http://npmjs.com/) packages. The main package is [`ckeditor5`](https://github.com/ckeditor/ckeditor5) which installs all project dependencies and various development-related resources such as:
12
12
13
13
* the testing environment setup,
14
-
* configuration for [Yarn](https://yarnpkg.com/),
14
+
* configuration for [pnpm](https://pnpm.io),
15
15
* translation management tools,
16
16
* documentation generator,
17
17
* and release tools.
@@ -33,15 +33,9 @@ To start developing CKEditor 5 you will require:
33
33
34
34
## Setting up the CKEditor development environment
35
35
36
-
First, you need to install [Yarn](https://yarnpkg.com/) to use it for dependency management.
36
+
First, you need to install [pnpm](https://pnpm.io) to use it for dependency management.
37
37
38
-
It is best to install it globally in your system for easier use later on:
39
-
40
-
```
41
-
npm install -g yarn
42
-
```
43
-
44
-
**Note:**[Read how to avoid using `sudo` to install packages globally](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md) or use [nvm](https://github.com/creationix/nvm).
38
+
It is best to install it in your system is to [follow the official pnpm installation guide](https://pnpm.io/installation).
45
39
46
40
Then clone the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5):
47
41
@@ -53,21 +47,21 @@ cd ckeditor5
53
47
And install all CKEditor 5 packages from the [npm registry](http://npmjs.com/).
54
48
55
49
```
56
-
yarn install
50
+
pnpm install
57
51
```
58
52
59
53
## Running tests
60
54
61
55
To run tests, you need to use the `test` and `manual` tasks.
62
56
63
57
```
64
-
yarn run test --watch --coverage --source-map --files=engine
58
+
pnpm run test --watch --coverage --source-map --files=engine
65
59
```
66
60
67
61
or, shorter:
68
62
69
63
```
70
-
yarn run test -- -wcs --files=engine
64
+
pnpm run test -- -wcs --files=engine
71
65
```
72
66
73
67
This command will run the [`ckeditor5-engine`](https://github.com/ckeditor/ckeditor5-engine) package's tests.
@@ -77,7 +71,7 @@ This command will run the [`ckeditor5-engine`](https://github.com/ckeditor/ckedi
77
71
To create a server for manual tests use the `manual` task:
78
72
79
73
```
80
-
yarn run manual
74
+
pnpm run manual
81
75
```
82
76
83
77
To help test localized editors, the task accepts two optional configurations: `--language="en"` and `--additionalLanguages="ar,pl,..."`. The former sets the main language used by test editors. By default it is `"en"` and in most scenarios, you do not need to change it. The latter brings more languages to manual tests, which is helpful for example,when working with {@link getting-started/setup/ui-language#righttoleft-rtl-languages-support right–to–left languages in the user interface}.
@@ -86,10 +80,10 @@ You can read more about the {@link framework/contributing/testing-environment Te
86
80
87
81
## Building DLLs
88
82
89
-
Some manual tests require DLL builds. To learn more about DLL builds, read the {@link getting-started/advanced/dll-builds DLL builds guide}. They do not have to be updated every time, unless you want to check changes in the DLL builds specifically. Running `yarn run manual` will prompt you to optionally run the build. To build them manually, you need to run the `dll:build` task:
83
+
Some manual tests require DLL builds. To learn more about DLL builds, read the {@link getting-started/advanced/dll-builds DLL builds guide}. They do not have to be updated every time, unless you want to check changes in the DLL builds specifically. Running `pnpm run manual` will prompt you to optionally run the build. To build them manually, you need to run the `dll:build` task:
90
84
91
85
```
92
-
yarn run dll:build
86
+
pnpm run dll:build
93
87
```
94
88
95
89
This task accepts the following arguments:
@@ -102,7 +96,7 @@ This task accepts the following arguments:
102
96
To build the documentation, you need to run the `docs` task:
103
97
104
98
```
105
-
yarn run docs
99
+
pnpm run docs
106
100
```
107
101
108
102
The documentation will be available in `build/docs/`.
@@ -126,23 +120,23 @@ This task accepts the following arguments:
126
120
*`--verbose`– Prints out more information.
127
121
128
122
```
129
-
yarn run docs --skip-api
123
+
pnpm run docs --skip-api
130
124
```
131
125
132
126
After building documentation, you can quickly start an HTTP server to serve them:
133
127
134
128
```
135
-
yarn run docs:serve
129
+
pnpm run docs:serve
136
130
```
137
131
138
132
### Verifying documentation
139
133
140
134
To verify that all pages in our documentation can be opened without any errors, you do not need to do that manually, page by page. Instead, there is a web crawler that automatically traverses the documentation and it visits all pages that have been found. The crawler opens a headless Chromium browser and logs to the console any error that has been found.
141
135
142
-
To check pages in the documentation, build it (`yarn run docs`), serve it (`yarn run docs:serve`), and then run the crawler:
136
+
To check pages in the documentation, build it (`pnpm run docs`), serve it (`pnpm run docs:serve`), and then run the crawler:
143
137
144
138
```
145
-
yarn run docs:verify
139
+
pnpm run docs:verify
146
140
```
147
141
148
142
<info-box>
@@ -162,7 +156,7 @@ The crawler accepts the following arguments:
162
156
For example, to check the documentation without the default exclusions (the API and assets links), using only 2 concurrent pages and terminate the scan as soon as first error is found, run this command:
163
157
164
158
```
165
-
yarn run docs:verify -e -c 2 -q
159
+
pnpm run docs:verify -e -c 2 -q
166
160
```
167
161
168
162
#### Defining exclusions for web crawler
@@ -232,7 +226,7 @@ In addition to the possibility of defining exclusions in the `<meta>` tag, it is
232
226
It is possible to generate a style sheet containing content styles brought by all CKEditor 5 features. To do that, execute:
233
227
234
228
```
235
-
yarn docs:content-styles
229
+
pnpm docs:content-styles
236
230
```
237
231
238
232
The style sheet will be saved in the `build/content-styles` folder.
0 commit comments