Skip to content
This repository was archived by the owner on Oct 1, 2020. It is now read-only.

Commit 51b9639

Browse files
committed
fix: no longer requires node version and update compatibility notes
1 parent 1c39e7f commit 51b9639

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ Cypress preprocessor for bundling JavaScript via webpack
44

55
## Installation
66

7-
Requires [Node](https://nodejs.org/en/) version 6.5.0 or above.
8-
97
```sh
108
npm install --save-dev @cypress/webpack-preprocessor
119
```
1210

11+
## Compatibility
12+
13+
This version is only compatible with webpack 4.x+. If you need webpack 2 or 3 support, use `@cypress/webpack-preprocessor` 1.x
14+
15+
This plugin (and all Cypress plugins) run in Cypress's own version of Node. If you require npm packages or your own code into the pluginsFile, they needs to be compatible with [the version of Node that Cypress uses]((https://github.com/cypress-io/cypress/blob/develop/.node-version)), currently `8.2.1`.
16+
1317
## Usage
1418

1519
In your project's [plugins file](https://on.cypress.io/guides/guides/plugins.html):
@@ -91,13 +95,10 @@ module.exports = (on) => {
9195
}
9296
```
9397

94-
## Compatibility
95-
96-
* webpack: 4.x+ (use `@cypress/webpack-preprocessor` 1.x if you need webpack 2 or 3 support)
97-
* node: 8.2.1 minimum (aligned with Cypress 2.x)
98-
9998
## Contributing
10099

100+
Use the [version of Node that matches Cypress](https://github.com/cypress-io/cypress/blob/develop/.node-version). Currently that's `8.2.1`.
101+
101102
Run all tests once:
102103

103104
```shell

package.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
"version": "0.0.0-development",
55
"author": "Chris Breiding <chris@cypress.io>",
66
"bugs": "https://github.com/cypress-io/cypress-webpack-preprocessor/issues",
7-
"engines": {
8-
"node": ">=8.2.1"
9-
},
107
"files": [
118
"*.js"
129
],

0 commit comments

Comments
 (0)