From 1457038ab412ff89347c51b6ac685bb89fb65f83 Mon Sep 17 00:00:00 2001 From: Ben Holloway Date: Thu, 10 Jun 2021 09:45:08 +1000 Subject: [PATCH] update changelog and readme --- README.md | 11 +++++++---- packages/resolve-url-loader/CHANGELOG.md | 16 ++++++++++++++++ packages/resolve-url-loader/README.md | 23 ++++++++++------------- 3 files changed, 33 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d890b06..89a96b1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # Resolve URL Loader -We're working on **version 5** right now. +We're working on **version 5** right now. * Update `node` to recent LTS. -* Update `postcss` to latest -* Remove `rework` completely +* Update `postcss` to latest (resolves security vulnerabilities). +* Remove `rework` completely. -Stay tuned for a `resolve-url-loader@next` coming soon. +Install `resolve-url-loader@next` today! 🤓 + +Read the [documentation](../v5/packages/resolve-url-loader/README.md). +Migrate using the [changelog](../v5/packages/resolve-url-loader/CHANGELOG.md). ---- diff --git a/packages/resolve-url-loader/CHANGELOG.md b/packages/resolve-url-loader/CHANGELOG.md index d89e4dd..ba62a18 100644 --- a/packages/resolve-url-loader/CHANGELOG.md +++ b/packages/resolve-url-loader/CHANGELOG.md @@ -1,5 +1,21 @@ # resolve-url-loader +## Version 5 + +**Features** + +* Update `postcss` and completely remove `rework` parser. + +**Breaking Changes** + +* Require `node@>=12`. +* Support `webpack@>=4` (no longer tested for earlier versions). +* The `engine` option has been removed. + +**Migrating** + +Remove the `engine` option if you are using it. + ## Version 4 **Features** diff --git a/packages/resolve-url-loader/README.md b/packages/resolve-url-loader/README.md index 8f82341..eecc866 100644 --- a/packages/resolve-url-loader/README.md +++ b/packages/resolve-url-loader/README.md @@ -113,28 +113,25 @@ rules: [ The loader should work without options but use these as required. -| option | type | default | | description | -|-------------|----------------------------|-----------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `sourceMap` | boolean | `false` | | Generate an outgoing source-map. | -| `removeCR` | boolean | `true` Windows OS
`false` otherwise | | Convert orphan CR to whitespace.
See known issues below. | -| `debug` | boolean | `false` | | Display debug information. | -| `silent` | boolean | `false` | | Do **not** display warnings or deprecation messages. | -| `root` | string | _unset_ | | Similar to the (now defunct) option in `css-loader`.
This string, possibly empty, is prepended to absolute URIs.
Absolute URIs are only processed if this option is set. | -| `join` | function | _inbuilt_ | advanced | Custom join function.
Use custom javascript to fix asset paths on a per-case basis.
Refer to the [advanced features](docs/advanced-features.md) docs. | -| `engine` | `'rework'`
`'postcss'` | `'postcss'` | deprecated | The css parser engine.
Using this option produces a deprecation warning. | +| option | type | default | | description | +|-------------|----------|-----------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `sourceMap` | boolean | `false` | | Generate an outgoing source-map. | +| `removeCR` | boolean | `true` Windows OS
`false` otherwise | | Convert orphan CR to whitespace.
See known issues below. | +| `debug` | boolean | `false` | | Display debug information. | +| `silent` | boolean | `false` | | Do **not** display warnings or deprecation messages. | +| `root` | string | _unset_ | | Similar to the (now defunct) option in `css-loader`.
This string, possibly empty, is prepended to absolute URIs.
Absolute URIs are only processed if this option is set. | +| `join` | function | _inbuilt_ | advanced | Custom join function.
Use custom javascript to fix asset paths on a per-case basis.
Refer to the [advanced features](docs/advanced-features.md) docs. | ## Limitations -### Compatiblity +### Compatibility Tested `macOS` and `Windows`. -All `webpack2`-`webpack4` with contemporaneous loaders/plugins using `node 8.9`. And `webpack5` with latest loaders/plugins using `node 10.0`. +All `webpack@4`-`webpack@5` with contemporaneous loaders/plugins using `node@12`. Refer to `test` directory for full webpack configurations as used in automated tests. -Some edge cases with `libsass` on `Windows` (see [troubleshooting](docs/troubleshooting.md) docs). - ### Known issues Read the [troubleshooting](docs/troubleshooting.md) docs before raising an issue.