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: CONTRIBUTING.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -72,9 +72,9 @@ Small pull requests are much easier to review and more likely to get merged.
72
72
73
73
### Installation
74
74
75
-
1. Ensure you have [npm](https://www.npmjs.com/get-npm) installed.
76
-
1. After cloning the repository, run `npm install` in the root of the repository.
77
-
1. To start a development server, run `npm run dev`.
75
+
1. Ensure you have [pnpm](https://pnpm.io/installation) installed.
76
+
1. After cloning the repository, run `pnpm install` in the root of the repository.
77
+
1. To compile in watch mode, run `pnpm dev`.
78
78
79
79
### Creating a branch
80
80
@@ -94,8 +94,8 @@ Test samples are kept in `/test/xxx/samples` folder.
94
94
95
95
#### Running tests
96
96
97
-
1. To run test, run `npm run test`.
98
-
1. To run test for a specific feature, you can use the `-g` (aka `--grep`) option. For example, to only run test involving transitions, run `npm run test -- -g transition`.
97
+
1. To run test, run `pnpm test`.
98
+
1. To run test for a specific feature, you can use the `-g` (aka `--grep`) option. For example, to only run test involving transitions, run `pnpm test -- -g transition`.
99
99
100
100
##### Running solo test
101
101
@@ -106,11 +106,11 @@ Test samples are kept in `/test/xxx/samples` folder.
106
106
##### Updating `.expected` files
107
107
108
108
1. Tests suites like `css`, `js`, `server-side-rendering` asserts that the generated output has to match the content in the `.expected` file. For example, in the `js` test suites, the generated js code is compared against the content in `expected.js`.
109
-
1. To update the content of the `.expected` file, run the test with `--update` flag. (`npm run test --update`)
109
+
1. To update the content of the `.expected` file, run the test with `--update` flag. (`pnpm test --update`)
110
110
111
111
### Style guide
112
112
113
-
[Eslint](https://eslint.org) will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running `npm run lint`.
113
+
[Eslint](https://eslint.org) will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running `pnpm lint`.
114
114
115
115
#### Code conventions
116
116
@@ -122,8 +122,8 @@ Test samples are kept in `/test/xxx/samples` folder.
122
122
Please make sure the following is done when submitting a pull request:
123
123
124
124
1. Describe your **test plan** in your pull request description. Make sure to test your changes.
125
-
1. Make sure your code lints (`npm run lint`).
126
-
1. Make sure your tests pass (`npm run test`).
125
+
1. Make sure your code lints (`pnpm lint`).
126
+
1. Make sure your tests pass (`pnpm test`).
127
127
128
128
All pull requests should be opened against the `master` branch. Make sure the PR does only one thing, otherwise please split it.
> Do not use Yarn to install the dependencies, as the specific package versions in `package-lock.json` are used to build and test Svelte.
41
41
42
42
To build the compiler and all the other modules included in the package:
43
43
44
44
```bash
45
-
npm run build
45
+
pnpm build
46
46
```
47
47
48
-
To watch for changes and continually rebuild the package (this is useful if you're using [npm link](https://docs.npmjs.com/cli/link.html) to test out changes in a project locally):
48
+
To watch for changes and continually rebuild the package (this is useful if you're using [`pnpm link`](https://pnpm.io/cli/link) to test out changes in a project locally):
49
49
50
50
```bash
51
-
npm run dev
51
+
pnpm dev
52
52
```
53
53
54
54
The compiler is written in [TypeScript](https://www.typescriptlang.org/), but don't let that put you off — it's basically just JavaScript with type annotations. You'll pick it up in no time. If you're using an editor other than [Visual Studio Code](https://code.visualstudio.com/), you may need to install a plugin in order to get syntax highlighting and code hints, etc.
@@ -57,13 +57,13 @@ The compiler is written in [TypeScript](https://www.typescriptlang.org/), but do
57
57
### Running Tests
58
58
59
59
```bash
60
-
npm runtest
60
+
pnpmtest
61
61
```
62
62
63
63
To filter tests, use `-g` (aka `--grep`). For example, to only run tests involving transitions:
0 commit comments