Skip to content

feat: support [folder] template string in localIdentName option #11356

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

Merged
merged 2 commits into from
Aug 13, 2025
Merged

feat: support [folder] template string in localIdentName option #11356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebf8eb4
feat: support [folder] template strings in localIdentName option
mochiya98 Aug 11, 2025
74962e0
chore: add tests
mochiya98 Aug 12, 2025
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
8 changes: 8 additions & 0 deletions crates/rspack_plugin_css/src/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use std::{
borrow::Cow,
fmt::Write,
hash::Hasher,
path::Path,
sync::{Arc, LazyLock},
};

Expand Down Expand Up @@ -85,6 +86,11 @@ impl<'a> LocalIdentOptions<'a> {
)),
local,
unique_name: &output.unique_name,
folder: Path::new(&self.relative_resource)
.parent()
.and_then(|p| p.file_name())
.and_then(|s| s.to_str())
.unwrap_or(""),
}
.render_local_ident_name(self.local_name_ident)
.await
Expand All @@ -95,6 +101,7 @@ struct LocalIdentNameRenderOptions<'a> {
path_data: PathData<'a>,
local: &'a str,
unique_name: &'a str,
folder: &'a str,
}

impl LocalIdentNameRenderOptions<'_> {
Expand All @@ -108,6 +115,7 @@ impl LocalIdentNameRenderOptions<'_> {
Ok(
s.cow_replace("[uniqueName]", self.unique_name)
.cow_replace("[local]", self.local)
.cow_replace("[folder]", self.folder)
.into_owned(),
)
}
Expand Down
60 changes: 52 additions & 8 deletions tests/webpack-test/__snapshots__/ConfigTestCases.basictest.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,6 +530,28 @@ Object {
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 8`] = `
Object {
"btn--info_is-disabled_1": "-btn--info_is-disabled_1",
"btn-info_is-disabled": "-btn-info_is-disabled",
"foo": "bar",
"foo_bar": "-foo_bar",
"my-btn-info_is-disabled": "value",
"simple": "-simple",
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 9`] = `
Object {
"btn--info_is-disabled_1": "nested2-btn--info_is-disabled_1",
"btn-info_is-disabled": "nested2-btn-info_is-disabled",
"foo": "bar",
"foo_bar": "nested2-foo_bar",
"my-btn-info_is-disabled": "value",
"simple": "nested2-simple",
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 10`] = `
Object {
"btn--info_is-disabled_1": "./style.module.less__btn--info_is-disabled_1",
"btn-info_is-disabled": "./style.module.less__btn-info_is-disabled",
Expand All @@ -540,7 +562,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 9`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 11`] = `
Object {
"btn--info_is-disabled_1": "_style_module_css-btn--info_is-disabled_1",
"btn-info_is-disabled": "_style_module_css-btn-info_is-disabled",
Expand All @@ -551,7 +573,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 10`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 12`] = `
Object {
"btn--info_is-disabled_1": "feb1ff69382c6202",
"btn-info_is-disabled": "f9df66ace1f48520",
Expand All @@ -562,7 +584,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 11`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 13`] = `
Object {
"btn--info_is-disabled_1": "_6fc78548db75122e-btn--info_is-disabled_1",
"btn-info_is-disabled": "_6fc78548db75122e-btn-info_is-disabled",
Expand All @@ -573,7 +595,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 12`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 14`] = `
Object {
"btn--info_is-disabled_1": "./style.module__btn--info_is-disabled_1",
"btn-info_is-disabled": "./style.module__btn-info_is-disabled",
Expand All @@ -584,7 +606,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 13`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 15`] = `
Object {
"btn--info_is-disabled_1": "./style.module.css__btn--info_is-disabled_1",
"btn-info_is-disabled": "./style.module.css__btn-info_is-disabled",
Expand All @@ -595,7 +617,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 14`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 16`] = `
Object {
"btn--info_is-disabled_1": "./style.module.css?q#f__btn--info_is-disabled_1",
"btn-info_is-disabled": "./style.module.css?q#f__btn-info_is-disabled",
Expand All @@ -606,7 +628,7 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 15`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 17`] = `
Object {
"btn--info_is-disabled_1": "-_style_module_css_uniqueName-id-contenthash-[contenthash]",
"btn-info_is-disabled": "-_style_module_css_uniqueName-id-contenthash-[contenthash]",
Expand All @@ -617,7 +639,29 @@ Object {
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 16`] = `
exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 18`] = `
Object {
"btn--info_is-disabled_1": "-btn--info_is-disabled_1",
"btn-info_is-disabled": "-btn-info_is-disabled",
"foo": "bar",
"foo_bar": "-foo_bar",
"my-btn-info_is-disabled": "value",
"simple": "-simple",
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 19`] = `
Object {
"btn--info_is-disabled_1": "nested2-btn--info_is-disabled_1",
"btn-info_is-disabled": "nested2-btn-info_is-disabled",
"foo": "bar",
"foo_bar": "nested2-foo_bar",
"my-btn-info_is-disabled": "value",
"simple": "nested2-simple",
}
`;

exports[`ConfigTestCases css local-ident-name exported tests should have correct local ident for css export locals 20`] = `
Object {
"btn--info_is-disabled_1": "./style.module.less__btn--info_is-disabled_1",
"btn-info_is-disabled": "./style.module.less__btn-info_is-disabled",
Expand Down
17 changes: 16 additions & 1 deletion tests/webpack-test/configCases/css/local-ident-name/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,30 @@ it("should have correct local ident for css export locals", (done) => {
import("./style.module.css?file-local"),
import("./style.module.css?q#f"),
import("./style.module.css?uniqueName-id-contenthash"),
import("./style.module.css?folder-local"),
import("./nested1/nested2/style.module.css?folder-local"),
import("./style.module.less"),
]).then(([idLocal, hash, hashLocal, pathNameLocal, fileLocal, queryFragment, uniqueNameIdContenthash, less]) => {
]).then(([
idLocal,
hash,
hashLocal,
pathNameLocal,
fileLocal,
queryFragment,
uniqueNameIdContenthash,
folderLocalRoot,
folderLocal,
less
]) => {
expect(idLocal).toMatchSnapshot();
expect(hash).toMatchSnapshot();
expect(hashLocal).toMatchSnapshot();
expect(pathNameLocal).toMatchSnapshot();
expect(fileLocal).toMatchSnapshot();
expect(queryFragment).toMatchSnapshot();
expect(uniqueNameIdContenthash).toMatchSnapshot();
expect(folderLocalRoot).toMatchSnapshot();
expect(folderLocal).toMatchSnapshot();
expect(less).toMatchSnapshot();
done()
}).catch(done)
Expand Down
25 changes: 25 additions & 0 deletions tests/webpack-test/configCases/css/local-ident-name/nested1/nested2/style.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.btn-info_is-disabled {
color: blue;
}

.btn--info_is-disabled_1 {
color: blue;
}

.simple {
color: red;
}

a {
color: yellow;
}

:export {
foo: bar;
my-btn-info_is-disabled: value;
}

.foo_bar {
--color-red: red;
color: var(--color-red);
}
2 changes: 2 additions & 0 deletions tests/webpack-test/configCases/css/local-ident-name/test.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ module.exports = {
`style_module_css_file-local.bundle${i}.js`,
`style_module_css_q_f.bundle${i}.js`,
`style_module_css_uniqueName-id-contenthash.bundle${i}.js`,
`style_module_css_folder-local.bundle${i}.js`,
`nested1_nested2_style_module_css_folder-local.bundle${i}.js`,
`style_module_less.bundle${i}.js`,
`bundle${i}.js`
];
Expand Down
6 changes: 6 additions & 0 deletions tests/webpack-test/configCases/css/local-ident-name/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ const common = {
generator: {
localIdentName: "[uniqueName]-[id]-[contenthash]"
}
},
{
resourceQuery: /\?folder-local$/,
generator: {
localIdentName: "[folder]-[local]"
}
}
]
}
Expand Down
Loading