Skip to content

Commit 1457038

Browse files
bhollowaybholloway
committed
update changelog and readme
1 parent a01faf9 commit 1457038

File tree

3 files changed

+33
-17
lines changed

3 files changed

+33
-17
lines changed

‎README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Resolve URL Loader
22

3-
We're working on **version 5** right now.
3+
We're working on **version 5** right now.
44
* Update `node` to recent LTS.
5-
* Update `postcss` to latest
6-
* Remove `rework` completely
5+
* Update `postcss` to latest (resolves security vulnerabilities).
6+
* Remove `rework` completely.
77

8-
Stay tuned for a `resolve-url-loader@next` coming soon.
8+
Install `resolve-url-loader@next` today! 🤓
9+
10+
Read the [documentation](../v5/packages/resolve-url-loader/README.md).
11+
Migrate using the [changelog](../v5/packages/resolve-url-loader/CHANGELOG.md).
912

1013
----
1114

‎packages/resolve-url-loader/CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# resolve-url-loader
22

3+
## Version 5
4+
5+
**Features**
6+
7+
* Update `postcss` and completely remove `rework` parser.
8+
9+
**Breaking Changes**
10+
11+
* Require `node@>=12`.
12+
* Support `webpack@>=4` (no longer tested for earlier versions).
13+
* The `engine` option has been removed.
14+
15+
**Migrating**
16+
17+
Remove the `engine` option if you are using it.
18+
319
## Version 4
420

521
**Features**

‎packages/resolve-url-loader/README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -113,28 +113,25 @@ rules: [
113113

114114
The loader should work without options but use these as required.
115115

116-
| option | type | default | | description |
117-
|-------------|----------------------------|-----------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
118-
| `sourceMap` | boolean | `false` | | Generate an outgoing source-map. |
119-
| `removeCR` | boolean | `true` Windows OS<br/>`false` otherwise | | Convert orphan CR to whitespace.<br/>See known issues below. |
120-
| `debug` | boolean | `false` | | Display debug information. |
121-
| `silent` | boolean | `false` | | Do **not** display warnings or deprecation messages. |
122-
| `root` | string | _unset_ | | Similar to the (now defunct) option in `css-loader`.<br/>This string, possibly empty, is prepended to absolute URIs.<br/>Absolute URIs are only processed if this option is set. |
123-
| `join` | function | _inbuilt_ | advanced | Custom join function.<br/>Use custom javascript to fix asset paths on a per-case basis.<br/>Refer to the [advanced features](docs/advanced-features.md) docs. |
124-
| `engine` | `'rework'`<br/>`'postcss'` | `'postcss'` | deprecated | The css parser engine.<br/>Using this option produces a deprecation warning. |
116+
| option | type | default | | description |
117+
|-------------|----------|-----------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
118+
| `sourceMap` | boolean | `false` | | Generate an outgoing source-map. |
119+
| `removeCR` | boolean | `true` Windows OS<br/>`false` otherwise | | Convert orphan CR to whitespace.<br/>See known issues below. |
120+
| `debug` | boolean | `false` | | Display debug information. |
121+
| `silent` | boolean | `false` | | Do **not** display warnings or deprecation messages. |
122+
| `root` | string | _unset_ | | Similar to the (now defunct) option in `css-loader`.<br/>This string, possibly empty, is prepended to absolute URIs.<br/>Absolute URIs are only processed if this option is set. |
123+
| `join` | function | _inbuilt_ | advanced | Custom join function.<br/>Use custom javascript to fix asset paths on a per-case basis.<br/>Refer to the [advanced features](docs/advanced-features.md) docs. |
125124

126125
## Limitations
127126

128-
### Compatiblity
127+
### Compatibility
129128

130129
Tested `macOS` and `Windows`.
131130

132-
All `webpack2`-`webpack4` with contemporaneous loaders/plugins using `node 8.9`. And `webpack5` with latest loaders/plugins using `node 10.0`.
131+
All `webpack@4`-`webpack@5` with contemporaneous loaders/plugins using `node@12`.
133132

134133
Refer to `test` directory for full webpack configurations as used in automated tests.
135134

136-
Some edge cases with `libsass` on `Windows` (see [troubleshooting](docs/troubleshooting.md) docs).
137-
138135
### Known issues
139136

140137
Read the [troubleshooting](docs/troubleshooting.md) docs before raising an issue.

0 commit comments

Comments
 (0)