fix(extract): escape special regex characters used in file-based routing systems

[jjonesrs]

Description

We recently migrated to TanStack Router, which uses file-based routing with several file naming conventions. The lingui extract --watch command stopped working on any routes with these special characters. However, lingui extract continued to work.

Debugging revealed that --watch sets options.files, and these paths are formed into a regular expression. If any of these paths contains a character with special regex meaning, like $, then paths won't be correctly filtered.

if (options.files) {
    options.files = options.files.map((p) =>normalize(p, false))
    const regex = new RegExp(options.files.join("|"), "i")
    paths = paths.filter((path: string) => regex.test(path))
}

To fix this, I created a new utility that escapes characters allowed in file paths, but with special regex meaning. I'm not sure if I captured all possible characters used in file-based routing conventions, or if I over specified too many.

I added tests for both the utility itself and the extractor's collect function. If you remove makePathRegexSafe from collect, you should see components C, D, and E removed from the snapshot because the extractor fails to handle them.

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Examples update

Checklist

• I have read the CONTRIBUTING and CODE_OF_CONDUCT docs
• I have added tests that prove my fix is effective or that my feature works
• I have added the necessary documentation (if appropriate)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
js-lingui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 24, 2024 6:13am

[github-actions]

size-limit report 📦

Path	Size
./packages/core/dist/index.mjs	2.88 KB (0%)
./packages/detect-locale/dist/index.mjs	723 B (0%)
./packages/react/dist/index.mjs	1.67 KB (0%)
./packages/remote-loader/dist/index.mjs	7.26 KB (0%)

[timofei-iatsenko]

LGTM, thanks for your work!