Skip to content

fix: escape Windows paths in esbuild plugin regex filter #18

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

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from
Open

fix: escape Windows paths in esbuild plugin regex filter #18

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion packages/htmldocs/src/utils/htmldocs-esbuild-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ import { Documentation, parse } from "react-docgen";
import * as tsj from "ts-json-schema-generator";
import { DOCUMENT_SCHEMAS_DIR } from "./paths";

/**
* Escapes special regex characters in a string to make it safe for use in RegExp.
* This is necessary for Windows paths that contain backslashes and other special characters.
*
* @param s - The string to escape
* @returns The escaped string safe for use in RegExp
*/
export function escapeForRegExp(s: string): string {
return String(s).replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
}

/**
* Made to export the `renderAsync` function out of the user's email template
* so that issues like https://github.com/resend/react-email/issues/649 don't
Expand All @@ -18,8 +29,10 @@ import { DOCUMENT_SCHEMAS_DIR } from "./paths";
export const htmldocsPlugin = (documentTemplates: string[], isBuild: boolean) => ({
name: "htmldocs-plugin",
setup: (b: PluginBuild) => {
// Escape each path to handle Windows backslashes and other special characters
const escapedPaths = documentTemplates.map(escapeForRegExp);
b.onLoad(
{ filter: new RegExp(documentTemplates.join("|")) },
{ filter: new RegExp(escapedPaths.join("|")) },
async ({ path: pathToFile }) => {
let contents = await fs.promises.readFile(pathToFile, "utf8");
await generateAndWriteSchema(contents, pathToFile);
Expand Down