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/CONTRIBUTING.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Table of Contents
11
11
-[Your first Contribution](#your-first-contribution)
12
12
-[Setup](#setup)
13
13
-[Running Tests](#running-tests)
14
-
-[Using yarn](#using-yarn)
14
+
-[Using npm](#using-npm)
15
15
-[Editor Config](#editor-config)
16
16
-[Dependencies](#dependencies)
17
17
-[Branching Model](#branching-model)
@@ -57,67 +57,65 @@ In case you are suggesting a new feature, we will match your idea with our curre
57
57
- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli).
58
58
-`git clone <your-clone-url> && cd webpack-cli`
59
59
60
-
- We use [yarn](https://yarnpkg.com/lang/en/) workspaces, please install it:
60
+
- We use [npm](https://docs.npmjs.com/), please install it:
61
61
62
-
Read the [Installation Guide](https://yarnpkg.com/en/docs/install) on their official website for detailed instructions on how to install Yarn.
63
-
64
-
> Using yarn is not a requirement, [npm](https://www.npmjs.com/) is included in node.
62
+
Read the [Installation Guide](https://docs.npmjs.com/cli/v11/configuring-npm/install) on their official website for detailed instructions on how to install NPM.
65
63
66
64
- Install the dependencies:
67
65
68
66
```bash
69
-
yarn install
67
+
npm install
70
68
```
71
69
72
70
- Build all the submodules before building for the first time
73
71
74
72
```bash
75
-
yarn build
73
+
npm run build
76
74
```
77
75
78
76
> If you are a Docker and Visual Studio Code user, you can quickstart development using [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) Extension
79
77
80
78
## Running Tests
81
79
82
-
### Using yarn
80
+
### Using npm
83
81
84
82
- Run all the tests with:
85
83
86
84
```bash
87
-
yarntest
85
+
npm runtest
88
86
```
89
87
90
88
- Run CLI tests with:
91
89
92
90
```bash
93
-
yarn test:cli
91
+
npm run test:cli
94
92
```
95
93
96
94
- Run tests of all packages:
97
95
98
96
```bash
99
-
yarn test:packages
97
+
npm run test:packages
100
98
```
101
99
102
100
- Test a single CLI test case:
103
101
104
102
> Must run from root of the project
105
103
106
104
```bash
107
-
yarn jest path/to/my-test.js
105
+
npm run jest path/to/my-test.js
108
106
```
109
107
110
108
- You can also install jest globally and run tests without npx:
111
109
112
110
```bash
113
-
yarn global add jest
111
+
npm install --global jest
114
112
jest path/to/my-test.js
115
113
```
116
114
117
115
- You can run the linters:
118
116
119
117
```bash
120
-
yarn lint
118
+
npm run lint
121
119
```
122
120
123
121
## Editor Config
@@ -128,7 +126,7 @@ The [.editorconfig](https://github.com/webpack/webpack-cli/blob/main/.editorconf
128
126
129
127
This is a multi-package repository and dependencies are managed using [lerna](https://lerna.js.org/)
130
128
131
-
> If you are adding or updating any dependency, please commit the updated `yarn.lock` file.
129
+
> If you are adding or updating any dependency, please commit the updated `package-lock.json` file.
132
130
133
131
To update dependencies, import each dependency and make sure the command line build passes. The dependency should support our minimal supported node version for webpack, found in `package.json`.
134
132
@@ -249,7 +247,7 @@ documentation.
249
247
250
248
## Releasing
251
249
252
-
Run `yarn publish:monorepo` to build all packages and bump versions, this will then get published on npm.
250
+
Run `npm run publish:monorepo` to build all packages and bump versions, this will then get published on npm.
0 commit comments