Skip to content

Commit e21ab00

Browse files
JIENIU$evilebottnawi
JIENIU$
authored andcommitted
docs(readme): update default values for options (#1000)
1 parent 0961304 commit e21ab00

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,15 @@ module.exports = {
109109

110110
## Options
111111

112-
| Name | Type | Default | Description |
113-
| :-----------------------------------------: | :-------------------------: | :-----: | :--------------------------------------------------------------------- |
114-
| **[`url`](#url)** | `{Boolean\|Function}` | `true` | Enables/Disables `url`/`image-set` functions handling |
115-
| **[`import`](#import)** | `{Boolean\|Function}` | `true` | Enables/Disables `@import` at-rules handling |
116-
| **[`modules`](#modules)** | `{Boolean\|String\|Object}` | `false` | Enables/Disables CSS Modules and their configuration |
117-
| **[`sourceMap`](#sourcemap)** | `{Boolean}` | `false` | Enables/Disables generation of source maps |
118-
| **[`importLoaders`](#importloaders)** | `{Number}` | `0` | Enables/Disables or setups number of loaders applied before CSS loader |
119-
| **[`localsConvention`](#localsconvention)** | `{String}` | `asIs` | Style of exported classnames |
120-
| **[`onlyLocals`](#onlylocals)** | `{Boolean}` | `false` | Export only locals |
112+
| Name | Type | Default | Description |
113+
| :-----------------------------------------: | :-------------------------: | :------: | :--------------------------------------------------------------------- |
114+
| **[`url`](#url)** | `{Boolean\|Function}` | `true` | Enables/Disables `url`/`image-set` functions handling |
115+
| **[`import`](#import)** | `{Boolean\|Function}` | `true` | Enables/Disables `@import` at-rules handling |
116+
| **[`modules`](#modules)** | `{Boolean\|String\|Object}` | `false` | Enables/Disables CSS Modules and their configuration |
117+
| **[`sourceMap`](#sourcemap)** | `{Boolean}` | `false` | Enables/Disables generation of source maps |
118+
| **[`importLoaders`](#importloaders)** | `{Number}` | `0` | Enables/Disables or setups number of loaders applied before CSS loader |
119+
| **[`localsConvention`](#localsconvention)** | `{String}` | `'asIs'` | Style of exported classnames |
120+
| **[`onlyLocals`](#onlylocals)** | `{Boolean}` | `false` | Export only locals |
121121

122122
### `url`
123123

@@ -201,7 +201,7 @@ module.exports = {
201201

202202
### `import`
203203

204-
Type: `Boolean`
204+
Type: `Boolean|Function`
205205
Default: `true`
206206

207207
Enables/Disables `@import` at-rules handling.
@@ -540,7 +540,7 @@ module.exports = {
540540
##### `mode`
541541

542542
Type: `String`
543-
Default: `local`
543+
Default: `'local'`
544544

545545
Setup `mode` option. You can omit the value when you want `local` mode.
546546

@@ -567,15 +567,15 @@ module.exports = {
567567
##### `localIdentName`
568568

569569
Type: `String`
570-
Default: `[hash:base64]`
570+
Default: `'[hash:base64]'`
571571

572572
You can configure the generated ident with the `localIdentName` query parameter.
573573
See [loader-utils's documentation](https://github.com/webpack/loader-utils#interpolatename) for more information on options.
574574

575575
Recommendations:
576576

577-
- use `[path][name]__[local]` for development
578-
- use `[hash:base64]` for production
577+
- use `'[path][name]__[local]'` for development
578+
- use `'[hash:base64]'` for production
579579

580580
The `[local]` placeholder contains original class.
581581

@@ -782,7 +782,7 @@ This may change in the future when the module system (i. e. webpack) supports lo
782782
### `localsConvention`
783783

784784
Type: `String`
785-
Default: `undefined`
785+
Default: `'asIs'`
786786

787787
Style of exported classnames.
788788

0 commit comments

Comments
 (0)