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
-[pnpm](https://pnpm.io/), `>= 8.x` (install using [corepack](https://nodejs.org/docs/latest-v20.x/api/corepack.html))
24
24
25
25
### Dependencies
26
26
27
27
From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:
28
28
29
29
```
30
-
yarn
30
+
pnpm install
31
31
```
32
32
33
33
### Build
34
34
35
35
From a terminal, where you have cloned the repository, execute the following command to re-build the project from scratch:
36
36
37
37
```
38
-
yarn run rebuild
38
+
pnpm run rebuild
39
39
```
40
40
41
41
👉 **NOTE!** This will run a complete rebuild of the project.
42
42
43
43
Or to just run a quick build, use:
44
44
45
45
```
46
-
yarn run build
46
+
pnpm run build
47
47
```
48
48
49
49
### Watch
50
50
51
51
During development you can use a watcher to make builds on changes quick and easy. From a terminal, where you have cloned the repository, execute the following command:
52
52
53
53
```
54
-
yarn run watch
54
+
pnpm run watch
55
55
```
56
56
57
57
Or use the provided `watch` task in VS Code, execute the following from the command palette (be sure there is no `>` at the start):
@@ -68,7 +68,7 @@ This will first do an initial full build and then watch for file changes, compil
68
68
69
69
### Formatting
70
70
71
-
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `yarn run pretty` from a terminal.
71
+
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `pnpm run pretty` from a terminal.
72
72
73
73
To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.
74
74
@@ -80,7 +80,7 @@ Add the following to your User Settings to run prettier:
80
80
81
81
### Linting
82
82
83
-
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `yarn run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.
83
+
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `pnpm run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.
84
84
85
85
To lint the code as you make changes you can install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
86
86
@@ -89,13 +89,13 @@ To lint the code as you make changes you can install the [ESLint](https://market
89
89
To generate a production bundle (without packaging) run the following from a terminal:
90
90
91
91
```
92
-
yarn run bundle
92
+
pnpm run bundle
93
93
```
94
94
95
95
To generate a VSIX (installation package) run the following from a terminal:
96
96
97
97
```
98
-
yarn run package
98
+
pnpm run package
99
99
```
100
100
101
101
### Debugging
@@ -202,13 +202,13 @@ Then, use the [prep-release](scripts/prep-release.js) script to prepare a new re
202
202
203
203
1. Ensure you are on the `main` branch and have a clean working tree
204
204
2. Ensure the [CHANGELOG.md](CHANGELOG.md) has been updated with the release notes
205
-
3. Run `yarn run prep-release` and enter the desired `{major}.{minor}.{patch}` version when prompted
205
+
3. Run `pnpm run prep-release` and enter the desired `{major}.{minor}.{patch}` version when prompted
206
206
4. Review the `Bumps to v{major}.{minor}.{patch}` commit
207
207
5. Run `git push --follow-tags` to push the commit and tag
208
208
209
209
Pushing the `v{major}.{minor}.{patch}` tag will trigger the [Publish Stable workflow](.github/workflows/cd-stable.yml) to automatically package the extension, create a [GitHub release](https://github.com/gitkraken/vscode-gitlens/releases/latest), and deploy it to the [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens).
210
210
211
-
If the action fails and retries are unsuccessful, the VSIX can be built locally with `yarn package` and uploaded manually to the marketplace. A GitHub release can also be [created manually](https://github.com/gitkraken/vscode-gitlens/releases/new) using `v{major}.{minor}.{patch}` as the title and the notes from the [CHANGELOG.md](CHANGELOG.md) with the VSIX attached.
211
+
If the action fails and retries are unsuccessful, the VSIX can be built locally with `pnpm run package` and uploaded manually to the marketplace. A GitHub release can also be [created manually](https://github.com/gitkraken/vscode-gitlens/releases/new) using `v{major}.{minor}.{patch}` as the title and the notes from the [CHANGELOG.md](CHANGELOG.md) with the VSIX attached.
212
212
213
213
#### Preparing a Patch Release
214
214
@@ -240,8 +240,8 @@ To add new icons to the GL Icons font follow the steps below:
240
240
- Optimize and build the icons by running the following from a terminal:
0 commit comments