Skip to content

Commit

Permalink
update branch references to v5
Browse files Browse the repository at this point in the history
  • Loading branch information
bholloway committed Jan 17, 2022
1 parent 8091b2d commit 78393f6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 21 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# Resolve URL Loader

We're working on **version 5** right now.
* Update `node` to recent LTS.
* Update `postcss` to latest (resolves security vulnerabilities).
* Remove `rework` completely.
The **version 5** is released. 🥳

Install `resolve-url-loader@next` today! 🤓
Install `resolve-url-loader@latest` in your project!

Read the [documentation](../v5/packages/resolve-url-loader/README.md).
Migrate using the [changelog](../v5/packages/resolve-url-loader/CHANGELOG.md).

----

The **version 4** is released. 🥳

Install `resolve-url-loader@latest` in your project!
The **version 4** is now maintenance only.

Read the [documentation](../v4-maintenance/packages/resolve-url-loader/README.md).
Migrate using the [changelog](../v4-maintenance/packages/resolve-url-loader/CHANGELOG.md).
Refer to [v4-maintenance](../v4-maintenance/packages/resolve-url-loader/README.md) branch.

----

Expand Down
21 changes: 10 additions & 11 deletions packages/resolve-url-loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ When you use **fully relative paths** in `url()` statements then Webpack expects

To illustrate here are 3 simple examples of SASS and Webpack _without_ `resolve-url-loader`.

[![the basic problem](https://raw.githubusercontent.com/bholloway/resolve-url-loader/v4-maintenance/packages/resolve-url-loader/docs/basic-problem.svg)](docs/basic-problem.svg)
[![the basic problem](https://raw.githubusercontent.com/bholloway/resolve-url-loader/v5/packages/resolve-url-loader/docs/basic-problem.svg)](docs/basic-problem.svg)

The first 2 cases are trivial and work fine. The asset is specified in the root SCSS file and Webpack finds it.

Expand Down Expand Up @@ -99,8 +99,7 @@ rules: [
}, {
loader: 'sass-loader',
options: {
sourceMap: true,
sourceMapContents: false
sourceMap: true, // <-- !!IMPORTANT!!
}
}
]
Expand All @@ -113,14 +112,14 @@ 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. |
| 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

Expand Down

0 comments on commit 78393f6

Please sign in to comment.