Skip to content

Commit

Permalink
update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@bholloway
bholloway committed Jun 9, 2021
1 parent a01faf9 commit 1457038
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 17 deletions.
11 changes: 7 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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).

----

Expand Down
16 changes: 16 additions & 0 deletions packages/resolve-url-loader/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -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**
Expand Down
23 changes: 10 additions & 13 deletions packages/resolve-url-loader/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<br/>`false` otherwise | | Convert orphan CR to whitespace.<br/>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`.<br/>This string, possibly empty, is prepended to absolute URIs.<br/>Absolute URIs are only processed if this option is set. |
| `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. |
| `engine` | `'rework'`<br/>`'postcss'` | `'postcss'` | deprecated | The css parser engine.<br/>Using this option produces a deprecation warning. |
| option | type | default | | description |
|-------------|----------|-----------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sourceMap` | boolean | `false` | | Generate an outgoing source-map. |
| `removeCR` | boolean | `true` Windows OS<br/>`false` otherwise | | Convert orphan CR to whitespace.<br/>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`.<br/>This string, possibly empty, is prepended to absolute URIs.<br/>Absolute URIs are only processed if this option is set. |
| `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. |

## 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.

0 comments on commit 1457038

Please sign in to comment.