Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(typo): rename esModules -> esModule to match the code #1548

Merged
merged 1 commit into from
Dec 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ All notable changes to this project will be documented in this file. See [standa

### Notes

* using `~` is deprecated when the `esModules` option is enabled (enabled by default) and can be removed from your code (**we recommend it**) (`url(~package/image.png)` -> `url(package/image.png)`, `@import url(~package/style.css)` -> `@import url(package/style.css)`, `composes: import from '~package/one.css';` -> `composes: import from 'package/one.css';`), but we still support it for historical reasons. Why can you remove it? The loader will first try to resolve `@import`/`url()`/etc as relative, if it cannot be resolved, the loader will try to resolve `@import`/`url()`/etc inside [`node_modules` or modules directories](https://webpack.js.org/configuration/resolve/#resolvemodules).
* using `~` is deprecated when the `esModule` option is enabled (enabled by default) and can be removed from your code (**we recommend it**) (`url(~package/image.png)` -> `url(package/image.png)`, `@import url(~package/style.css)` -> `@import url(package/style.css)`, `composes: import from '~package/one.css';` -> `composes: import from 'package/one.css';`), but we still support it for historical reasons. Why can you remove it? The loader will first try to resolve `@import`/`url()`/etc as relative, if it cannot be resolved, the loader will try to resolve `@import`/`url()`/etc inside [`node_modules` or modules directories](https://webpack.js.org/configuration/resolve/#resolvemodules).
* `file-loader` and `url-loader` are deprecated, please migrate on [`asset modules`](https://webpack.js.org/guides/asset-modules/), since v6 `css-loader` is generating `new URL(...)` syntax, it enables by default built-in [`assets modules`](https://webpack.js.org/guides/asset-modules/), i.e. `type: 'asset'` for all `url()`

### ⚠ BREAKING CHANGES
Expand All @@ -147,9 +147,9 @@ All notable changes to this project will be documented in this file. See [standa
* minimum supported `webpack` version is `5`, we recommend to update to the latest version for better performance
* for `url` and `import` options `Function` type was removed in favor `Object` type with the `filter` property, i.e. before `{ url: () => true }`, now `{ url: { filter: () => true } }` and before `{ import: () => true }`, now `{ import: { filter: () => true } }`
* the `modules.compileType` option was removed in favor the `modules.mode` option with `icss` value, also the `modules` option can have `icss` string value
* `new URL()` syntax used for `url()`, only when the `esModules` option is enabled (enabled by default), it means you can bundle CSS for libraries
* `new URL()` syntax used for `url()`, only when the `esModule` option is enabled (enabled by default), it means you can bundle CSS for libraries
* [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) are handling in `url()`, it means you can register loaders for them, [example](https://webpack.js.org/configuration/module/#rulescheme)
* aliases with `false` value for `url()` now generate empty data URI (i.e. `data:0,`), only when the `esModules` option is enabled (enabled by default)
* aliases with `false` value for `url()` now generate empty data URI (i.e. `data:0,`), only when the `esModule` option is enabled (enabled by default)
* `[ext]` placeholder don't need `.` (dot) before for the `localIdentName` option, i.e. please change `.[ext]` on `[ext]` (no dot before)
* `[folder]` placeholder was removed without replacement for the `localIdentName` option, please use a custom function if you need complex logic
* `[emoji]` placeholder was removed without replacement for the `localIdentName` option, please use a custom function if you need complex logic
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1538,7 +1538,7 @@ import "./styles.css";

> **Warning**
>
> The `esModules` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack-contrib/css-loader#modules), by default for locals will be used [named export](https://github.com/webpack-contrib/css-loader#namedexport).
> The `esModule` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack-contrib/css-loader#modules), by default for locals will be used [named export](https://github.com/webpack-contrib/css-loader#namedexport).

The default export is `string`.

Expand Down Expand Up @@ -1577,7 +1577,7 @@ console.log(sheet);

> **Warning**
>
> The `esModules` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack-contrib/css-loader#modules), by default for locals will be used [named export](https://github.com/webpack-contrib/css-loader#namedexport).
> The `esModule` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack-contrib/css-loader#modules), by default for locals will be used [named export](https://github.com/webpack-contrib/css-loader#namedexport).

> **Warning**
>
Expand Down
4 changes: 2 additions & 2 deletions src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ function getModulesOptions(rawOptions, exportType, loaderContext) {
if (needNamedExport) {
if (rawOptions.esModule === false) {
throw new Error(
"The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModules' option to be enabled"
"The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModule' option to be enabled"
);
}

Expand All @@ -673,7 +673,7 @@ function getModulesOptions(rawOptions, exportType, loaderContext) {
if (modulesOptions.namedExport === true) {
if (rawOptions.esModule === false) {
throw new Error(
"The 'modules.namedExport' option requires the 'esModules' option to be enabled"
"The 'modules.namedExport' option requires the 'esModule' option to be enabled"
);
}

Expand Down
4 changes: 2 additions & 2 deletions test/__snapshots__/exportType.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
exports[`'exportType' option should throw an error with 'css-style-sheet' value for CSS modules when \`esModule\` disabled, but 'modules.namedExport' enabled: errors 1`] = `
Array [
"ModuleBuildError: Module build failed (from \`replaced original path\`):
Error: The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModules' option to be enabled",
Error: The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModule' option to be enabled",
]
`;

Expand All @@ -12,7 +12,7 @@ exports[`'exportType' option should throw an error with 'css-style-sheet' value
exports[`'exportType' option should throw an error with 'css-style-sheet' value for CSS modules when \`esModule\` disabled: errors 1`] = `
Array [
"ModuleBuildError: Module build failed (from \`replaced original path\`):
Error: The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModules' option to be enabled",
Error: The 'exportType' option with the 'css-style-sheet' or 'string' value requires the 'esModule' option to be enabled",
]
`;

Expand Down
2 changes: 1 addition & 1 deletion test/__snapshots__/modules-option.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -2425,7 +2425,7 @@ exports[`"modules" option should throw an error when the "namedExport" is enable
exports[`"modules" option should throw an error when the "namedExport" option is "true", but the "esModule" is "false": errors 1`] = `
Array [
"ModuleBuildError: Module build failed (from \`replaced original path\`):
Error: The 'modules.namedExport' option requires the 'esModules' option to be enabled",
Error: The 'modules.namedExport' option requires the 'esModule' option to be enabled",
]
`;

Expand Down
16 changes: 8 additions & 8 deletions test/__snapshots__/url-option.test.js.snap
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`"url" option should resolve "file" protocol path when the "esModules" is "false": errors 1`] = `Array []`;
exports[`"url" option should resolve "file" protocol path when the "esModule" is "false": errors 1`] = `Array []`;

exports[`"url" option should resolve "file" protocol path when the "esModules" is "false": module 1`] = `
exports[`"url" option should resolve "file" protocol path when the "esModule" is "false": module 1`] = `
"// Imports
var ___CSS_LOADER_API_NO_SOURCEMAP_IMPORT___ = require(\\"../../../src/runtime/noSourceMaps.js\\");
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../src/runtime/api.js\\");
Expand All @@ -29,7 +29,7 @@ module.exports = ___CSS_LOADER_EXPORT___;
"
`;

exports[`"url" option should resolve "file" protocol path when the "esModules" is "false": result 1`] = `
exports[`"url" option should resolve "file" protocol path when the "esModule" is "false": result 1`] = `
Array [
Array [
"./url/url-file-protocol.css",
Expand All @@ -51,7 +51,7 @@ Array [
]
`;

exports[`"url" option should resolve "file" protocol path when the "esModules" is "false": warnings 1`] = `Array []`;
exports[`"url" option should resolve "file" protocol path when the "esModule" is "false": warnings 1`] = `Array []`;

exports[`"url" option should resolve "file" protocol path: errors 1`] = `Array []`;

Expand Down Expand Up @@ -106,9 +106,9 @@ Array [

exports[`"url" option should resolve "file" protocol path: warnings 1`] = `Array []`;

exports[`"url" option should resolve absolute path when the 'esModules' is 'false': errors 1`] = `Array []`;
exports[`"url" option should resolve absolute path when the 'esModule' is 'false': errors 1`] = `Array []`;

exports[`"url" option should resolve absolute path when the 'esModules' is 'false': module 1`] = `
exports[`"url" option should resolve absolute path when the 'esModule' is 'false': module 1`] = `
"// Imports
var ___CSS_LOADER_API_NO_SOURCEMAP_IMPORT___ = require(\\"../../../src/runtime/noSourceMaps.js\\");
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../src/runtime/api.js\\");
Expand All @@ -135,7 +135,7 @@ module.exports = ___CSS_LOADER_EXPORT___;
"
`;

exports[`"url" option should resolve absolute path when the 'esModules' is 'false': result 1`] = `
exports[`"url" option should resolve absolute path when the 'esModule' is 'false': result 1`] = `
Array [
Array [
"./url/url-absolute.css",
Expand All @@ -157,7 +157,7 @@ Array [
]
`;

exports[`"url" option should resolve absolute path when the 'esModules' is 'false': warnings 1`] = `Array []`;
exports[`"url" option should resolve absolute path when the 'esModule' is 'false': warnings 1`] = `Array []`;

exports[`"url" option should resolve absolute path: errors 1`] = `Array []`;

Expand Down
4 changes: 2 additions & 2 deletions test/url-option.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ describe('"url" option', () => {
expect(getErrors(stats)).toMatchSnapshot("errors");
});

it("should resolve absolute path when the 'esModules' is 'false'", async () => {
it("should resolve absolute path when the 'esModule' is 'false'", async () => {
// Create the file with absolute path
const fileDirectory = path.resolve(__dirname, "fixtures", "url");
const file = path.resolve(fileDirectory, "url-absolute.css");
Expand Down Expand Up @@ -227,7 +227,7 @@ describe('"url" option', () => {
expect(getErrors(stats)).toMatchSnapshot("errors");
});

it('should resolve "file" protocol path when the "esModules" is "false"', async () => {
it('should resolve "file" protocol path when the "esModule" is "false"', async () => {
// Create the file with absolute path
const fileDirectory = path.resolve(__dirname, "fixtures", "url");
const file = path.resolve(fileDirectory, "url-file-protocol.css");
Expand Down