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.

Sign up for GitHub

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

Jump to bottom

feat: the exportGlobals option for export global classes and ids #1069

Merged
merged 1 commit into from Apr 6, 2020
Merged

feat: the exportGlobals option for export global classes and ids #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -528,6 +528,7 @@ module.exports = {
options: {
modules: {
mode: 'local',
exportGlobals: true,
localIdentName: '[path][name]__[local]--[hash:base64:5]',
context: path.resolve(__dirname, 'src'),
hashPrefix: 'my-custom-hash',
Expand Down Expand Up @@ -605,6 +606,33 @@ module.exports = {
};
```

##### `exportGlobals`

Type: `Boolean`
Default: `false`

Allow `css-loader` to export names from global class or id, so you can use that as local name.

**webpack.config.js**

```js
module.exports = {
module: {
rules: [
{
test: /\.css$/i,
loader: 'css-loader',
options: {
modules: {
exportGlobals: true,
},
},
},
],
},
};
```

##### `localIdentName`

Type: `String`
Expand Down
3 changes: 3 additions & 0 deletions src/options.json
View file
Open in desktop
Expand Up @@ -46,6 +46,9 @@
}
]
},
"exportGlobals": {
"type": "boolean"
},
"localIdentName": {
"type": "string"
},
Expand Down
8 changes: 3 additions & 5 deletions src/utils.js
View file
Open in desktop
Expand Up @@ -99,6 +99,7 @@ function getFilter(filter, resourcePath, defaultFilter = null) {
function getModulesPlugins(options, loaderContext) {
let modulesOptions = {
mode: 'local',
exportGlobals: false,
localIdentName: '[hash:base64]',
getLocalIdent,
hashPrefix: '',
Expand All @@ -116,11 +117,7 @@ function getModulesPlugins(options, loaderContext) {
}

if (typeof modulesOptions.mode === 'function') {
const modeFromFunction = modulesOptions.mode(loaderContext.resourcePath);

if (modeFromFunction === 'local' || modeFromFunction === 'global') {
modulesOptions.mode = modeFromFunction;
}
modulesOptions.mode = modulesOptions.mode(loaderContext.resourcePath);
}

let plugins = [];
Expand Down Expand Up @@ -158,6 +155,7 @@ function getModulesPlugins(options, loaderContext) {

return localIdent;
},
exportGlobals: modulesOptions.exportGlobals,
}),
];
} catch (error) {
Expand Down
156 changes: 152 additions & 4 deletions test/__snapshots__/modules-option.test.js.snap
View file
Open in desktop
Expand Up @@ -368,6 +368,8 @@ Array [
"ModuleError: Module Error (from \`replaced original path\`):
options.mode must be either \\"global\\", \\"local\\" or \\"pure\\" (default \\"local\\")",
"ModuleError: Module Error (from \`replaced original path\`):
options.mode must be either \\"global\\", \\"local\\" or \\"pure\\" (default \\"local\\")",
"ModuleError: Module Error (from \`replaced original path\`):
options.mode must be either \\"global\\", \\"local\\" or \\"pure\\" (default \\"local\\")",
]
`;
Expand Down Expand Up @@ -409,14 +411,31 @@ exports[`"modules" option issue #1063 throw error: result 1`] = `
:local(.otherClassGlobalFile) {
color: coral;
}
.foo :local(.bar) {
color: red;
}
"
`;

exports[`"modules" option issue #1063 throw error: warnings 1`] = `Array []`;

exports[`"modules" option issue #1063: errors 1`] = `Array []`;

exports[`"modules" option issue #1063: module 1`] = `
exports[`"modules" option issue #1063: module with the \`global\` mode 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
// Module
exports.push([module.id, \\".classNameGlobalFile {\\\\n color: black;\\\\n}\\\\n\\\\n._2rcag09JpwrP4_hfyyRmm- {\\\\n color: coral;\\\\n}\\\\n\\", \\"\\"]);
// Exports
exports.locals = {
\\"otherClassGlobalFile\\": \\"_2rcag09JpwrP4_hfyyRmm-\\"
};
module.exports = exports;
"
`;

exports[`"modules" option issue #1063: module with the \`local\` mode 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
Expand All @@ -430,15 +449,16 @@ module.exports = exports;
"
`;

exports[`"modules" option issue #1063: module 2`] = `
exports[`"modules" option issue #1063: module with the \`pure\` mode 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
// Module
exports.push([module.id, \\".classNameGlobalFile {\\\\n color: black;\\\\n}\\\\n\\\\n._2rcag09JpwrP4_hfyyRmm- {\\\\n color: coral;\\\\n}\\\\n\\", \\"\\"]);
exports.push([module.id, \\"._1rycxa6QkLdgO7vayuTDvk ._3Otdq1jay-xaQGguOXb-0X {\\\\n color: red;\\\\n}\\\\n\\", \\"\\"]);
// Exports
exports.locals = {
\\"otherClassGlobalFile\\": \\"_2rcag09JpwrP4_hfyyRmm-\\"
\\"foo\\": \\"_1rycxa6QkLdgO7vayuTDvk\\",
\\"bar\\": \\"_3Otdq1jay-xaQGguOXb-0X\\"
};
module.exports = exports;
"
Expand All @@ -459,6 +479,9 @@ exports[`"modules" option issue #1063: result 1`] = `
._2rcag09JpwrP4_hfyyRmm- {
color: coral;
}
._1rycxa6QkLdgO7vayuTDvk ._3Otdq1jay-xaQGguOXb-0X {
color: red;
}
"
`;

Expand Down Expand Up @@ -11098,3 +11121,128 @@ Array [
`;

exports[`"modules" option should work with the "[local]" placeholder for the "localIdentName" option: warnings 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`global\`): errors 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`global\`): module 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
// Module
exports.push([module.id, \\".QLhabfC4HjcIBmobkGW_v {\\\\n background-color: red;\\\\n}\\\\n\\\\n._1fCLE6vkQLICB5aEeEaLgd {\\\\n background-color: green;\\\\n}\\\\n\\\\n.baz {\\\\n background-color: blue;\\\\n}\\\\n\\", \\"\\"]);
// Exports
exports.locals = {
\\"foo\\": \\"QLhabfC4HjcIBmobkGW_v\\",
\\"bar\\": \\"_1fCLE6vkQLICB5aEeEaLgd\\",
\\"baz\\": \\"baz\\"
};
module.exports = exports;
"
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`global\`): result 1`] = `
Array [
Array [
"./modules/exportGlobals-global/exportGlobals.css",
".QLhabfC4HjcIBmobkGW_v {
background-color: red;
}

._1fCLE6vkQLICB5aEeEaLgd {
background-color: green;
}

.baz {
background-color: blue;
}
",
"",
],
]
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`global\`): warnings 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`local\`): errors 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`local\`): module 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
// Module
exports.push([module.id, \\".foo {\\\\n background-color: red;\\\\n}\\\\n\\\\n._3loyPgwYlZ-RBGWccx71es {\\\\n background-color: green;\\\\n}\\\\n\\\\n.baz {\\\\n background-color: blue;\\\\n}\\\\n\\", \\"\\"]);
// Exports
exports.locals = {
\\"foo\\": \\"foo\\",
\\"bar\\": \\"_3loyPgwYlZ-RBGWccx71es\\",
\\"baz\\": \\"baz\\"
};
module.exports = exports;
"
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`local\`): result 1`] = `
Array [
Array [
"./modules/exportGlobals-local/exportGlobals.css",
".foo {
background-color: red;
}

._3loyPgwYlZ-RBGWccx71es {
background-color: green;
}

.baz {
background-color: blue;
}
",
"",
],
]
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`local\`): warnings 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`pure\`): errors 1`] = `Array []`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`pure\`): module 1`] = `
"// Imports
var ___CSS_LOADER_API_IMPORT___ = require(\\"../../../../src/runtime/api.js\\");
exports = ___CSS_LOADER_API_IMPORT___(false);
// Module
exports.push([module.id, \\"._3OALfsKrVzw8QnGzfteWls {\\\\n background-color: red;\\\\n}\\\\n\\\\n._3w1OTKuiiZvf8WY1tCPaZH ._1cmRmgT7HI056zoTdHDOVh {\\\\n background-color: green;\\\\n}\\\\n\\\\n._3pB9KhpUqVA1pPH1Y8ei3y .baz {\\\\n background-color: blue;\\\\n}\\\\n\\", \\"\\"]);
// Exports
exports.locals = {
\\"foo\\": \\"_3OALfsKrVzw8QnGzfteWls\\",
\\"one\\": \\"_3w1OTKuiiZvf8WY1tCPaZH\\",
\\"bar\\": \\"_1cmRmgT7HI056zoTdHDOVh\\",
\\"two\\": \\"_3pB9KhpUqVA1pPH1Y8ei3y\\",
\\"baz\\": \\"baz\\"
};
module.exports = exports;
"
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`pure\`): result 1`] = `
Array [
Array [
"./modules/exportGlobals-pure/exportGlobals.css",
"._3OALfsKrVzw8QnGzfteWls {
background-color: red;
}

._3w1OTKuiiZvf8WY1tCPaZH ._1cmRmgT7HI056zoTdHDOVh {
background-color: green;
}

._3pB9KhpUqVA1pPH1Y8ei3y .baz {
background-color: blue;
}
",
"",
],
]
`;

exports[`"modules" option should work with the \`exportGlobals\` option (the \`mode\` option is \`pure\`): warnings 1`] = `Array []`;