| 1 | # resolve-url-loader
|
|---|
| 2 |
|
|---|
| 3 | ## Version 4
|
|---|
| 4 |
|
|---|
| 5 | **Features**
|
|---|
| 6 |
|
|---|
| 7 | * Better resolution of the original source location - You can more successfully use `url()` in variables and mixins.
|
|---|
| 8 | * Dependencies now accept a wider range and explicit dependency on `rework` and `rework-visit` has been removed.
|
|---|
| 9 |
|
|---|
| 10 | **Breaking Changes**
|
|---|
| 11 |
|
|---|
| 12 | * The `engine` option is deprecated which means the old `rework` engine is deprecated.
|
|---|
| 13 | * The `keepQuery` behaviour is now the default, the `keepQuery` option has been removed.
|
|---|
| 14 | * The `removeCR` option defaults to `true` when executing on Windows OS.
|
|---|
| 15 | * The `absolute` option has been removed.
|
|---|
| 16 | * The `join` option has changed.
|
|---|
| 17 |
|
|---|
| 18 | **Migrating**
|
|---|
| 19 |
|
|---|
| 20 | Remove the `engine` option if you are using it - the default "postcss" engine is much more reliable. The "rework" engine will still work for now but will be removed in the next major version.
|
|---|
| 21 |
|
|---|
| 22 | Remove the `keepQuery` option if you are using it.
|
|---|
| 23 |
|
|---|
| 24 | Remove the `absolute` option, webpack should work fine without it. If you have a specific need to rebase `url()` then you should use a separate loader.
|
|---|
| 25 |
|
|---|
| 26 | If you use a custom `join` function then you will need to refactor it to the new API. Refer to the advanced usage documentation.
|
|---|
| 27 |
|
|---|
| 28 | If you wish to still use `engine: "rework"` then note that `rework` and `rework-visit` packages are now `peerDependencies` that must be explicitly installed by you.
|
|---|
| 29 |
|
|---|
| 30 | ## Version 3
|
|---|
| 31 |
|
|---|
| 32 | **Features**
|
|---|
| 33 |
|
|---|
| 34 | * Use `postcss` parser by default. This is long overdue as the old `rework` parser doesn't cope with modern css.
|
|---|
| 35 |
|
|---|
| 36 | * Lots of automated tests running actual webpack builds. If you have an interesting use-case let me know.
|
|---|
| 37 |
|
|---|
| 38 | **Breaking Changes**
|
|---|
| 39 |
|
|---|
| 40 | * Multiple options changed or deprecated.
|
|---|
| 41 | * Removed file search "magic" in favour of `join` option.
|
|---|
| 42 | * Errors always fail and are no longer swallowed.
|
|---|
| 43 | * Processing absolute asset paths requires `root` option to be set.
|
|---|
| 44 |
|
|---|
| 45 | **Migrating**
|
|---|
| 46 |
|
|---|
| 47 | Initially set option `engine: 'rework'` for parity with your existing build. Once working you can remove this option **or** set `engine: 'postcss'` explicitly.
|
|---|
| 48 |
|
|---|
| 49 | Retain `keepQuery` option if you are already using it.
|
|---|
| 50 |
|
|---|
| 51 | The `root` option now has a different meaning. Previously it limited file search. Now it is the base path for absolute or root-relative URIs, consistent with `css-loader`. If you are already using it you can probably remove it.
|
|---|
| 52 |
|
|---|
| 53 | If you build on Windows platform **and** your content contains absolute asset paths, then `css-loader` could fail. The `root` option here may fix the URIs before they get to `css-loader`. Try to leave it unspecified, otherwise (windows only) set to empty string `root: ''`.
|
|---|
