chore(rename): Be consistent with 'for' prefix for babel plugin option (#10059)

Author: Tobbe

packages/babel-config/src/plugins/babel-plugin-redwood-routes-auto-loader.ts

@@ -12,8 +12,8 @@ import {
 } from '@redwoodjs/project-config'
 
 interface PluginOptions {
-  prerender?: boolean
-  vite?: boolean
+  forPrerender?: boolean
+  forVite?: boolean
 }
 
 /**
@@ -39,7 +39,7 @@ const withRelativeImports = (page: PagesDependency) => {
 
 export default function (
   { types: t }: { types: typeof types },
-  { prerender = false, vite = false }: PluginOptions
+  { forPrerender = false, forVite = false }: PluginOptions
 ): PluginObj {
   // @NOTE: This var gets mutated inside the visitors
   let pages = processPagesDir().map(withRelativeImports)
@@ -102,7 +102,7 @@ export default function (
         // This is to make sure that all the imported "Page modules" are normal
         // imports and not asynchronous ones.
         // Note that jest in a user's project does not enter this block, but our tests do
-        if (prerender) {
+        if (forPrerender) {
           // Match import paths, const name could be different
 
           const pageThatUserImported = pages.find((page) => {
@@ -195,7 +195,12 @@ export default function (
                       t.identifier('prerenderLoader'),
                       t.arrowFunctionExpression(
                         [t.identifier('name')],
-                        prerenderLoaderImpl(prerender, vite, relativeImport, t)
+                        prerenderLoaderImpl(
+                          forPrerender,
+                          forVite,
+                          relativeImport,
+                          t
+                        )
                       )
                     ),
                     t.objectProperty(
@@ -224,12 +229,12 @@ export default function (
 }
 
 function prerenderLoaderImpl(
-  prerender: boolean,
-  vite: boolean,
+  forPrerender: boolean,
+  forVite: boolean,
   relativeImport: string,
   t: typeof types
 ) {
-  if (prerender) {
+  if (forPrerender) {
     // This works for both vite and webpack
     return t.callExpression(t.identifier('require'), [
       t.stringLiteral(relativeImport),
@@ -243,7 +248,7 @@ function prerenderLoaderImpl(
   // Manually imported pages will be bundled in the main bundle and will be
   // loaded by the code in `normalizePage` in util.ts
   let implForBuild
-  if (vite) {
+  if (forVite) {
     implForBuild = t.objectExpression([
       t.objectProperty(
         t.identifier('default'),

packages/babel-config/src/web.ts

@@ -15,6 +15,13 @@ import {
   getPathsFromTypeScriptConfig,
 } from './common'
 
+// These flags toggle on/off certain features
+export interface Flags {
+  forJest?: boolean // will change the alias for module-resolver plugin
+  forPrerender?: boolean // changes what babel-plugin-redwood-routes-auto-loader does
+  forVite?: boolean
+}
+
 export const getWebSideBabelPlugins = (
   { forJest, forVite }: Flags = { forJest: false, forVite: false }
 ) => {
@@ -99,8 +106,8 @@ export const getWebSideBabelPlugins = (
 }
 
 export const getWebSideOverrides = (
-  { prerender, forVite }: Flags = {
-    prerender: false,
+  { forPrerender, forVite }: Flags = {
+    forPrerender: false,
     forVite: false,
   }
 ): Array<TransformOptions> => {
@@ -119,8 +126,8 @@ export const getWebSideOverrides = (
         [
           require('./plugins/babel-plugin-redwood-routes-auto-loader').default,
           {
-            prerender,
-            vite: forVite,
+            forPrerender,
+            forVite,
           },
         ],
       ],
@@ -202,13 +209,6 @@ export const getWebSideBabelConfigPath = () => {
   }
 }
 
-// These flags toggle on/off certain features
-export interface Flags {
-  forJest?: boolean // will change the alias for module-resolver plugin
-  prerender?: boolean // changes what babel-plugin-redwood-routes-auto-loader does
-  forVite?: boolean
-}
-
 export const getWebSideDefaultBabelConfig = (options: Flags = {}) => {
   // NOTE:
   // Even though we specify the config file, babel will still search for .babelrc
@@ -240,7 +240,7 @@ export const registerWebSideBabelHook = ({
     // We only register for prerender currently
     // Static importing pages makes sense
     overrides: [
-      ...getWebSideOverrides({ prerender: true, forVite }),
+      ...getWebSideOverrides({ forPrerender: true, forVite }),
       ...overrides,
     ],
   })

packages/internal/src/__tests__/build_web.test.ts

@@ -64,7 +64,7 @@ test('Check routes are imported with require when staticImports flag is enabled'
   const routesFile = getPaths().web.routes
 
   const prerendered = prebuildWebFile(routesFile, {
-    prerender: true,
+    forPrerender: true,
     forJest: true,
   })?.code
 

packages/internal/src/__tests__/nestedPages.test.ts

@@ -35,7 +35,7 @@ describe('User specified imports, with static imports', () => {
     const routesFile = getPaths().web.routes
 
     outputWithStaticImports = prebuildWebFile(routesFile, {
-      prerender: true,
+      forPrerender: true,
       forJest: true,
     })?.code
     outputWithStaticImports &&= normalizeStr(outputWithStaticImports)

packages/prerender/src/runPrerender.tsx

@@ -150,7 +150,7 @@ async function recursivelyRender(
 function insertChunkLoadingScript(
   indexHtmlTree: CheerioAPI,
   renderPath: string,
-  vite: boolean
+  forVite: boolean
 ) {
   const prerenderRoutes = detectPrerenderRoutes()
 
@@ -175,7 +175,7 @@ function insertChunkLoadingScript(
 
   const chunkPaths: Array<string> = []
 
-  if (!vite) {
+  if (!forVite) {
     // Webpack
 
     const pageChunkPath = buildManifest[`${route?.pageIdentifier}.js`]
@@ -219,7 +219,7 @@ function insertChunkLoadingScript(
         })
       }
     }
-  } else if (vite && route?.filePath) {
+  } else if (forVite && route?.filePath) {
     const pagesIndex =
       route.filePath.indexOf(path.join('web', 'src', 'pages')) + 8
     const pagePath = ensurePosixPath(route.filePath.slice(pagesIndex))
@@ -245,12 +245,12 @@ function insertChunkLoadingScript(
   chunkPaths.forEach((chunkPath) => {
     indexHtmlTree('head').prepend(
       `<script defer="defer" src="${chunkPath}" ${
-        vite ? 'type="module"' : ''
+        forVite ? 'type="module"' : ''
       }></script>`
     )
   })
 
-  if (!vite) {
+  if (!forVite) {
     return
   }
 
@@ -323,12 +323,12 @@ export const runPrerender = async ({
   })
 
   const gqlHandler = await getGqlHandler()
-  const vite = getConfig().web.bundler !== 'webpack'
+  const forVite = getConfig().web.bundler !== 'webpack'
 
   // Prerender specific configuration
   // extends projects web/babelConfig
   registerWebSideBabelHook({
-    forVite: vite,
+    forVite,
     overrides: [
       {
         plugins: [
@@ -400,7 +400,7 @@ export const runPrerender = async ({
   // or possible cache merge conflicts
   prerenderApolloClient.resetStore()
 
-  insertChunkLoadingScript(indexHtmlTree, renderPath, vite)
+  insertChunkLoadingScript(indexHtmlTree, renderPath, forVite)
 
   indexHtmlTree('#redwood-app').append(componentAsHtml)
 

packages/vite/src/__tests__/viteNestedPages.test.mts

@@ -71,7 +71,7 @@ describe('User specified imports, with static imports', () => {
 
     const routesFile = getPaths().web.routes
     const prerenderResult = await vitePrebuildWebFile(routesFile, {
-      prerender: true,
+      forPrerender: true,
       forJest: true,
       forVite: true,
     })