Skip to content

Commit 75a1b90

Browse files
committed
update docs removeCR
1 parent 61cb2c5 commit 75a1b90

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

packages/resolve-url-loader/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
* The `engine` option is deprecated which means the old `rework` engine is deprecated.
1313
* 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.
1415
* The `absolute` option has been removed.
1516
* The `join` option has changed.
1617

packages/resolve-url-loader/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,15 @@ 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 | `false` | | 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. |
124+
| `engine` | `'rework'`<br/>`'postcss'` | `'postcss'` | deprecated | The css parser engine.<br/>Using this option produces a deprecation warning. |
125125

126126
## Limitations
127127

packages/resolve-url-loader/docs/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Some users find the node-sass `linefeed` option solves the problem.
6262

6363
**Work arounds**
6464

65-
* Enable `removeCR` option [here](../README.md#options).
65+
* Enable `removeCR` option [here](../README.md#options) (enabled by default on Window OS).
6666
* Remove linebreaks in declarations in your `.scss` sources.
6767

6868
**Diagnosis**

0 commit comments

Comments
 (0)