Skip to content

Commit

Permalink
webpack/next: Fix webpack template strings by using a modified regex …
Browse files Browse the repository at this point in the history
…from the webpack source (#1333)
  • Loading branch information
askoufis authored Mar 8, 2024
1 parent bffdabd commit 6ac9f66
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 1 deletion.
11 changes: 11 additions & 0 deletions .changeset/eleven-seals-invent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
'@vanilla-extract/webpack-plugin': patch
'@vanilla-extract/next-plugin': patch
---

Use a more accurate regex for detecting [webpack template strings] in paths

We now use a modified version of the regex from the webpack source code to detect template strings in paths.
As long as the path isn't already escaped, we should detect it.

[webpack template strings]: https://webpack.js.org/configuration/output/#template-strings
3 changes: 3 additions & 0 deletions fixtures/template-string-paths/src/[blog-id]/index.css.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { style } from '@vanilla-extract/css';

export const withHyphen = style({ color: 'indigo' });
2 changes: 2 additions & 0 deletions fixtures/template-string-paths/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { singleSquareBracketsId } from './[id]/index.css';
import { doubleSquareBracketId } from './[[id]]/index.css';
import { catchAllSegment } from './[...slug]/index.css';
import { optionalCatchAllSegment } from './[[...slug]]/index.css';
import { withHyphen } from './[blog-id]/index.css';

// Fixture for testing escaping of webpack template strings and Next.js dyanmic routes
// https://webpack.js.org/configuration/output/#template-strings
Expand All @@ -14,6 +15,7 @@ function render() {
<div class="${doubleSquareBracketId}">[[id]] path</div>
<div class="${catchAllSegment}">[...slug] path</div>
<div class="${optionalCatchAllSegment}">[[...slug]] path</div>
<div class="${withHyphen}">[blog-id] path</div>
`;
}

Expand Down
5 changes: 4 additions & 1 deletion packages/webpack-plugin/src/compiler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ function getRootCompilation(loader: LoaderContext) {
return compilation;
}

const templateStringRegexp = /\[([^\[\]\.]+)\]/g;
// Modified version of webpack's regex for detecting template strings.
// We only want to match un-escaped strings so we can escape them ourselves.
// https://github.com/webpack/webpack/blob/87660921808566ef3b8796f8df61bd79fc026108/lib/TemplatedPathPlugin.js#L19
const templateStringRegexp = /\[([\w:]+)\]/g;

export const escapeWebpackTemplateString = (s: string) =>
s.replaceAll(templateStringRegexp, '[\\$1\\]');
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@
.\[\[\.\.\.slug\]\]_optionalCatchAllSegment__1kvknas0 {
color: orchid;
}
.\[blog-id\]_withHyphen__1e83mlh0 {
color: indigo;
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@
._1kvknas0 {
color: orchid;
}
._1e83mlh0 {
color: indigo;
}

0 comments on commit 6ac9f66

Please sign in to comment.