#3748 Add custom template option back to blitz generate command

apps/toolkit-app/app/blitz-server.ts

@@ -1,3 +1,4 @@
+import type { BlitzServerConfig } from "blitz"
 import { setupBlitzServer } from "@blitzjs/next"
 import { AuthServerPlugin, PrismaStorage } from "@blitzjs/auth"
 import db from "db"
@@ -14,3 +15,7 @@ const { gSSP, gSP, api } = setupBlitzServer({
 })
 
 export { gSSP, gSP, api }
+
+export const cliConfig: BlitzServerConfig = {
+  customTemplates: "app/templates",
+}

packages/blitz/src/cli/commands/generate.ts

@@ -32,6 +32,7 @@ enum ResourceType {
   Mutations = "mutations",
   Mutation = "mutation",
   Resource = "resource",
+  CustomTemplates = "custom-templates",
 }
 
 function modelName(input: string = "") {
@@ -47,6 +48,39 @@ function ModelNames(input: string = "") {
   return pluralPascal(input)
 }
 
+const createCustomTemplates = async () => {
+  const continuePrompt = await prompts({
+    type: "confirm",
+    name: "value",
+    message: `This will copy the default templates to your app/templates folder. Do you want to continue?`,
+  })
+  if (!continuePrompt.value) {
+    process.exit(0)
+  }
+  const templatesPath = await prompts({
+    type: "text",
+    name: "value",
+    message: `Enter the path to save the custom templates folder`,
+    initial: "app/templates",
+  })
+  const templatesPathValue: string = templatesPath.value
+  const isTypeScript = await getIsTypeScript()
+  addCustomTemplatesBlitzConfig(templatesPathValue, isTypeScript)
+  log.success(`🚀 Custom templates path added/updated in app/blitz-server file`)
+  const customTemplatesPath = require("path").join(process.cwd(), templatesPathValue)
+  const fsExtra = await import("fs-extra")
+  const blitzGeneratorPath = require.resolve("@blitzjs/generator")
+  const templateFolder = ["form", "page", "query", "mutation", "queries", "mutations"]
+  for (const template of templateFolder) {
+    await fsExtra.copy(
+      require("path").join(blitzGeneratorPath, "..", "templates", template),
+      require("path").join(customTemplatesPath, template),
+    )
+  }
+  log.success(`🚀 Custom templates created in ${templatesPathValue} directory`)
+  process.exit(0)
+}
+
 const generatorMap = {
   [ResourceType.All]: [
     PageGenerator,
@@ -63,6 +97,7 @@ const generatorMap = {
   [ResourceType.Mutations]: [MutationsGenerator],
   [ResourceType.Mutation]: [MutationGenerator],
   [ResourceType.Resource]: [QueriesGenerator, MutationsGenerator, ModelGenerator],
+  [ResourceType.CustomTemplates]: [],
 }
 
 const args = arg(
@@ -74,7 +109,6 @@ const args = arg(
     "--parent": String,
     "--dry-run": Boolean,
     "--env": String,
-    "--generate-custom-templates": Boolean,
 
     // Aliases
     "-e": "--env",
@@ -201,11 +235,13 @@ const getHelp = async () => {
       For example, this command generates pages under pages/projects/[projectId]/tasks/
 
         > blitz generate all tasks --parent=projects
-
-      # The '--generate-custom-templates' flag will copy the default templates to your app. 
-      This is useful if you want to customize the templates for your app
+
+      # To customize the templates used by the blitz generate command,
 
-        > blitz generate --generate-custom-templates
+        > blitz generate custom-templates
+
+        This command will copy the default templates to your app and update the app/blitz-server file to enable
+        the custom templating feature of the blitz CLI
 
       # Database models can also be generated directly from the CLI.
         Model fields can be specified with any generator that generates a database model ("all", "model", "resource").
@@ -221,45 +257,12 @@ const getHelp = async () => {
   }
 }
 
-const createCustomTemplates = async () => {
-  if (args["--generate-custom-templates"]) {
-    const continuePrompt = await prompts({
-      type: "confirm",
-      name: "value",
-      message: `This will copy the default templates to your app/templates folder. Do you want to continue?`,
-    })
-    if (!continuePrompt.value) {
-      process.exit(0)
-    }
-    const templatesPath = await prompts({
-      type: "text",
-      name: "value",
-      message: `Enter the path to save the custom templates folder`,
-      initial: "app/templates",
-    })
-    const templatesPathValue: string = templatesPath.value
-    const isTypeScript = await getIsTypeScript()
-    addCustomTemplatesBlitzConfig(templatesPathValue, isTypeScript)
-    log.success(`🚀 Custom templates path added/updated in app/blitz-server file`)
-    const customTemplatesPath = require("path").join(process.cwd(), templatesPathValue)
-    const fsExtra = await import("fs-extra")
-    const blitzGeneratorPath = require.resolve("@blitzjs/generator")
-    const templateFolder = ["form", "page", "query", "mutation", "queries", "mutations"]
-    for (const template of templateFolder) {
-      await fsExtra.copy(
-        require("path").join(blitzGeneratorPath, "..", "templates", template),
-        require("path").join(customTemplatesPath, template),
-      )
-    }
-    log.success(`🚀 Custom templates created in ${templatesPathValue} directory`)
-    process.exit(0)
-  }
-}
-
 const generate: CliCommand = async () => {
   await getHelp()
-  await createCustomTemplates()
   await determineType()
+  if (selectedType === "custom-templates") {
+    await createCustomTemplates()
+  }
   if (!selectedModelName) {
     await determineName()
   }
@@ -278,13 +281,14 @@ const generate: CliCommand = async () => {
     const {unregister} = register({
       target: "es6",
     })
-    const blitzConfig = require(blitzServer).default
+    const blitzConfig = require(blitzServer)
+    const {cliConfig} = blitzConfig
     unregister()
 
     for (const GeneratorClass of generators) {
       const generator = new GeneratorClass({
         destinationRoot: require("path").resolve(),
-        templateDir: blitzConfig?.customTemplates,
+        templateDir: cliConfig?.customTemplates,
         extraArgs: args["_"].slice(3) as string[],
         modelName: singularRootContext,
         modelNames: modelNames(singularRootContext),

packages/generator/src/generator.ts

@@ -25,10 +25,23 @@ export const addCustomTemplatesBlitzConfig = (
   const userConfigModuleSource = fs.readFileSync(blitzServerPath, {encoding: "utf-8"})
   const userConfigModule = j(userConfigModuleSource, {parser: customTsParser})
   const program = userConfigModule.get()
-  const defaultDeclaration = userConfigModule.find(j.ExportDefaultDeclaration)
-  const defaultConfig = defaultDeclaration.paths()[0]?.value
-  if (!defaultConfig) {
-    const config = j.identifier("config")
+  const cliConfigDeclaration = userConfigModule
+    .find(j.ExportNamedDeclaration, {
+      declaration: {
+        type: "VariableDeclaration",
+        declarations: [
+          {
+            id: {
+              name: "cliConfig",
+            },
+          },
+        ],
+      },
+    })
+    .paths()
+    .at(0)
+  if (!cliConfigDeclaration) {
+    const config = j.identifier("cliConfig")
     const configVariable = j.variableDeclaration("const", [
       j.variableDeclarator(
         config,
@@ -48,31 +61,32 @@ export const addCustomTemplatesBlitzConfig = (
       typeImport.importKind = "type"
       program.node.program.body.unshift(typeImport)
     }
-    const defaultConfig = j.exportDefaultDeclaration(j.identifier("config"))
-    program.node.program.body.push(configVariable)
-    program.node.program.body.push(defaultConfig)
+    const exportConfig = j.exportNamedDeclaration(configVariable)
+    program.node.program.body.push(exportConfig)
   } else {
-    const config = defaultConfig.declaration
-    if (config.type === "Identifier") {
-      const configVariable = userConfigModule.find(j.VariableDeclarator, {id: {name: config.name}})
-      const customTemplates = configVariable.find(j.ObjectProperty, {
-        key: {name: "customTemplates"},
-      })
-      customTemplates.remove()
-      configVariable
-        .find(j.ObjectExpression)
-        .get()
-        .node.properties.push(
-          j.objectProperty(j.identifier("customTemplates"), j.literal(customTemplatesPath)),
-        )
-    } else if (config.type === "ObjectExpression") {
-      const customTemplates = userConfigModule.find(j.ObjectProperty, {
-        key: {name: "customTemplates"},
-      })
-      customTemplates.remove()
-      config.properties.push(
-        j.objectProperty(j.identifier("customTemplates"), j.literal(customTemplatesPath)),
-      )
+    const configType = cliConfigDeclaration.value.declaration?.type
+    if (configType === "VariableDeclaration") {
+      const config = cliConfigDeclaration.value.declaration.declarations[0]
+      if (config?.type === "VariableDeclarator") {
+        const configProperties = config.init
+        if (configProperties?.type === "ObjectExpression") {
+          const customTemplatesProperty = configProperties.properties.find(
+            (property: any) => property.key.name === "customTemplates",
+          )
+          if (!customTemplatesProperty) {
+            configProperties.properties.push(
+              j.objectProperty(j.identifier("customTemplates"), j.literal(customTemplatesPath)),
+            )
+          } else {
+            if (customTemplatesProperty.type === "ObjectProperty") {
+              const customValue = customTemplatesProperty.value
+              if (customValue.type === "StringLiteral") {
+                customValue.value = customTemplatesPath
+              }
+            }
+          }
+        }
+      }
     }
   }
   const newSource = userConfigModule.toSource()