comment boundaries for react refresh transforms

[pcattori]

to make it easier to read transformed modules in dev

once we switch to better interop with vite-plugin-react this may become obsolete, but until then its nice to have

Example

see the newly added [BEGIN] & [END] comment boundaries below

import { createHotContext as __vite__createHotContext } from "/@vite/client";import.meta.hot = __vite__createHotContext("/app/routes/_index.tsx");

// [BEGIN] REACT REFRESH HEADER ------------------------------------------------
import RefreshRuntime from "/@id/__x00__virtual:react-router/hmr-runtime";

const inWebWorker = typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope;
let prevRefreshReg;
let prevRefreshSig;

if (import.meta.hot && !inWebWorker) {
  if (!window.__vite_plugin_react_preamble_installed__) {
    throw new Error(
      "React Router Vite plugin can't detect preamble. Something is wrong."
    );
  }

  prevRefreshReg = window.$RefreshReg$;
  prevRefreshSig = window.$RefreshSig$;
  window.$RefreshReg$ = (type, id) => {
    RefreshRuntime.register(type, "/Users/pedrocattori/remix-run/react-router/playground-local/compiler-1725468106777/app/routes/_index.tsx" + " " + id)
  };
  window.$RefreshSig$ = RefreshRuntime.createSignatureFunctionForTransform;
}
// [END] REACT REFRESH HEADER --------------------------------------------------

// [BEGIN] REACT REFRESH BODY --------------------------------------------------
import __vite__cjsImport2_react_jsxDevRuntime from "/node_modules/.vite/deps/react_jsx-dev-runtime.js?v=a2c717b5"; const jsxDEV = __vite__cjsImport2_react_jsxDevRuntime["jsxDEV"];
export const meta = () => {
  return [{
    title: "New React Router App"
  }, {
    name: "description",
    content: "Welcome to React Router!"
  }];
};
export default function Index() {
  return /* @__PURE__ */jsxDEV("div", {
    style: {
      fontFamily: "system-ui, sans-serif",
      lineHeight: "1.8"
    },
    children: /* @__PURE__ */jsxDEV("h1", {
      children: "Welcome to React Router"
    }, void 0, false, {
      fileName: "/Users/pedrocattori/remix-run/react-router/playground-local/compiler-1725468106777/app/routes/_index.tsx",
      lineNumber: 13,
      columnNumber: 7
    }, this)
  }, void 0, false, {
    fileName: "/Users/pedrocattori/remix-run/react-router/playground-local/compiler-1725468106777/app/routes/_index.tsx",
    lineNumber: 12,
    columnNumber: 5
  }, this);
}
_c = Index;
var _c;
$RefreshReg$(_c, "Index");
// [END] REACT REFRESH BODY ----------------------------------------------------

// [BEGIN] REACT REFRESH FOOTER ------------------------------------------------
if (import.meta.hot && !inWebWorker) {
  window.$RefreshReg$ = prevRefreshReg;
  window.$RefreshSig$ = prevRefreshSig;
  RefreshRuntime.__hmr_import(import.meta.url).then((currentExports) => {
    RefreshRuntime.registerExportsForReactRefresh("/Users/pedrocattori/remix-run/react-router/playground-local/compiler-1725468106777/app/routes/_index.tsx", currentExports);
    import.meta.hot.accept((nextExports) => {
      if (!nextExports) return;
      "routes/_index" && window.__reactRouterRouteModuleUpdates.set("routes/_index", nextExports);
      const invalidateMessage = RefreshRuntime.validateRefreshBoundaryAndEnqueueUpdate(currentExports, nextExports, ["clientAction","clientLoader","handle","meta","links","shouldRevalidate"]);
      if (invalidateMessage) import.meta.hot.invalidate(invalidateMessage);
    });
  });
}
// [END] REACT REFRESH FOOTER --------------------------------------------------

//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJtYXBwaW5ncyI6IkFBWU0sU0FBQUEsTUFBQTtBQVZDLGFBQU1DLElBQUEsR0FBcUJBLE1BQU07RUFDdEMsT0FBTyxDQUNMO0lBQUVDLEtBQUEsRUFBTztFQUF1QixHQUNoQztJQUFFQyxJQUFBLEVBQU07SUFBZUMsT0FBQSxFQUFTO0VBQTJCLEVBQzdEO0FBQ0Y7QUFFQSx3QkFBd0JDLFFBQVE7RUFDOUIsT0FDRSxlQUFBTCxNQUFBLENBQUM7SUFBSU0sS0FBQSxFQUFPO01BQUVDLFVBQUEsRUFBWTtNQUF5QkMsVUFBQSxFQUFZO0lBQU07SUFDbkVDLFFBQUEsaUJBQUFULE1BQUEsQ0FBQztNQUFHUyxRQUFBO0lBQUEsR0FBSjtNQUFBQyxRQUFBO01BQUFDLFVBQUE7TUFBQUMsWUFBQTtJQUFBLE9BQTJCO0VBQUEsR0FEN0I7SUFBQUYsUUFBQTtJQUFBQyxVQUFBO0lBQUFDLFlBQUE7RUFBQSxPQUVBO0FBRUo7QUFBQUMsRUFBQSxHQU53QlI7QUFBQUE7QUFBQUEiLCJuYW1lcyI6WyJqc3hERVYiLCJtZXRhIiwidGl0bGUiLCJuYW1lIiwiY29udGVudCIsIkluZGV4Iiwic3R5bGUiLCJmb250RmFtaWx5IiwibGluZUhlaWdodCIsImNoaWxkcmVuIiwiZmlsZU5hbWUiLCJsaW5lTnVtYmVyIiwiY29sdW1uTnVtYmVyIiwiX2MiXSwic291cmNlcyI6WyJfaW5kZXgudHN4Il0sInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgTWV0YUZ1bmN0aW9uIH0gZnJvbSBcInJlYWN0LXJvdXRlclwiO1xuXG5leHBvcnQgY29uc3QgbWV0YTogTWV0YUZ1bmN0aW9uID0gKCkgPT4ge1xuICByZXR1cm4gW1xuICAgIHsgdGl0bGU6IFwiTmV3IFJlYWN0IFJvdXRlciBBcHBcIiB9LFxuICAgIHsgbmFtZTogXCJkZXNjcmlwdGlvblwiLCBjb250ZW50OiBcIldlbGNvbWUgdG8gUmVhY3QgUm91dGVyIVwiIH0sXG4gIF07XG59O1xuXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBJbmRleCgpIHtcbiAgcmV0dXJuIChcbiAgICA8ZGl2IHN0eWxlPXt7IGZvbnRGYW1pbHk6IFwic3lzdGVtLXVpLCBzYW5zLXNlcmlmXCIsIGxpbmVIZWlnaHQ6IFwiMS44XCIgfX0+XG4gICAgICA8aDE+V2VsY29tZSB0byBSZWFjdCBSb3V0ZXI8L2gxPlxuICAgIDwvZGl2PlxuICApO1xufVxuIl0sImZpbGUiOiIvVXNlcnMvcGVkcm9jYXR0b3JpL3JlbWl4LXJ1bi9yZWFjdC1yb3V0ZXIvcGxheWdyb3VuZC1sb2NhbC9jb21waWxlci0xNzI1NDY4MTA2Nzc3L2FwcC9yb3V0ZXMvX2luZGV4LnRzeCJ9

[changeset-bot]

⚠️ No Changeset found

Latest commit: 14e3626

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[markdalgleish]

Should this one be left off? When reading the compiled source code, typically I'm looking for this bit — it's only the other blocks I'm trying to ignore, which is where the comments are nice.

[pcattori]

I don't feel strongly either way. I thought it was nice to give it a name so there's a ubiquitous language for it when debugging or asking users about it, but if you feel its mostly noise I'm ok with removing it.