fix: generate --description cwd

Author: brettstack

src/app-definition-generator.ts

@@ -3,7 +3,7 @@ import fs from 'node:fs'
 import path from 'node:path'
 import _s from 'underscore.string'
 import { dump as yamlDump } from 'js-yaml'
-import { getEntityNameStrings, paramCase } from './string-utils.js'
+import { getEntityNameStrings, kebabCase } from './string-utils.js'
 
 export interface App {
   entities: AppEntity[]
@@ -42,8 +42,12 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 const OUTPUT_DIR = process.cwd()
 
-export function getAppOutputDir({ appName }: { appName: string }) {
-  return path.join(OUTPUT_DIR, paramCase(appName))
+export function getAppNameKebabCase({ appName }: { appName: string }) {
+  return kebabCase(appName)
+}
+
+export function getAppOutputDir({ appName, absolute = true }: { appName: string; absolute?: boolean }) {
+  return absolute ? path.join(OUTPUT_DIR, getAppNameKebabCase({ appName })) : getAppNameKebabCase({ appName })
 }
 
 function getCodeGenieDir({ appName }: { appName: string }) {
@@ -103,7 +107,7 @@ function writeAppYamlToFileSystem({ app, appName, appDescription }: { app: App;
   const definitions: any = {}
   for (const entity of app.entities) {
     definitions[_s.camelize(_s.decapitalize(entity.name))] = {
-      $ref: `./entities/${paramCase(entity.name)}.yml`,
+      $ref: `./entities/${kebabCase(entity.name)}.yml`,
     }
   }
 
@@ -126,7 +130,7 @@ function writeAppYamlToFileSystem({ app, appName, appDescription }: { app: App;
 
 export function getJsonSchemasFromEntities({ app }: { app: App }) {
   return app.entities.map((entity) => {
-    const paramCasedEntityName = paramCase(entity.name)
+    const paramCasedEntityName = kebabCase(entity.name)
     const fileName = `${paramCasedEntityName}.yml`
     const codeGenieEntityJsonSchema = convertToCodeGenieEntityJsonSchema({
       app,
@@ -267,7 +271,7 @@ function getHasManySettings({ app, entity }: { app: App; entity: AppEntity }) {
   for (const appEntity of app.entities) {
     if (appEntity.belongsTo === entity.name) {
       hasMany[appEntity.name] = {
-        $ref: `./${paramCase(appEntity.name)}.yml`,
+        $ref: `./${kebabCase(appEntity.name)}.yml`,
       }
     }
   }

src/commands/generate.ts

@@ -6,7 +6,7 @@ import { cosmiconfig } from 'cosmiconfig'
 import createDebug from 'debug'
 // import codeGenieSampleOpenAiOutputJson from '../sample-api-output.js'
 import { App, convertOpenAiOutputToCodeGenieInput, getAppOutputDir } from '../app-definition-generator.js'
-import copyAwsProfile from '../copyAwsProfile.js'
+import copyAwsProfile, { awsCredentialsFileExists } from '../copyAwsProfile.js'
 import sleep from '../sleep.js'
 import { execSync } from 'node:child_process'
 import { Readable } from 'node:stream'
@@ -86,7 +86,7 @@ generating app...
     }),
   }
 
-  async run(): Promise<void | { description?: string; deploy: boolean; awsProfileToCopy: string }> {
+  async run(): Promise<{ description?: string; deploy: boolean; awsProfileToCopy: string; appDir: string }> {
     const { flags } = await this.parse(Generate)
     const { description, deploy, awsProfileToCopy, noCopyAwsProfile } = flags
 
@@ -97,37 +97,62 @@ generating app...
       })
     }
 
-    // If a description is provided we generate an App Definition .codegenie directory based on it
-    let appDir: string | undefined
+    let appDir = cwd()
+
+    // If a description is provided we create a new directory using the name provided (--name)
+    // or the AI-generated name, and generate an App Definition (.codegenie directory) within it based on the description
     if (description) {
-      await this.handleExistingAppDefinition()
+      // First check if we're within an existing Code Genie project directory by checking if a .codegnie directory already exists.
+      // handleExistingAppDefinition MUST be run before generateAppDefinition, since generateAppDefinition creates a .codegenie directory.
+      const hasExistingAppDefinition = await this.handleExistingAppDefinition()
       const generateAppDefinitionResult = await this.generateAppDefinition()
-      if (generateAppDefinitionResult) {
-        const { appName } = generateAppDefinitionResult
-        appDir = getAppOutputDir({ appName })
+
+      // Usually we expect that `generate --description` is run NOT within an existing Code Genie project directory; therefore
+      // hasExistingAppDefinition will usually be false. If `generate --description` is run within an existing Code Genie project directory,
+      // handleExistingAppDefinition will throw unless --replaceAppDefinitionf is included, in which case we want `appDir` to remain as cwd().
+      if (!hasExistingAppDefinition) {
+        appDir = getAppOutputDir({ appName: generateAppDefinitionResult.appName })
       }
-      return
     }
 
     const { headObjectPresignedUrl, getObjectPresignedUrl } = await this.uploadAppDefinition({ appDir })
-    await this.downloadS3OutputObject({
+
+    await this.downloadProject({
       headObjectPresignedUrl,
       getObjectPresignedUrl,
+      appDir,
     })
 
+    const appName = await this.getAppName({ appDir })
+    if (deploy && !awsCredentialsFileExists()) {
+      const appDirRelative = getAppOutputDir({ appName, absolute: false })
+      this.log(`The project has successfully been generated and downloaded to \`./${appDirRelative}\`.
+
+The project wasn't able to be automatically built and deployed to AWS because the AWS CLI isn\'t set up on this machine. Install the AWS CLI and then run \`npm run init:dev\` inside the \`./${appDirRelative}\` directory.
+
+For now you can open \`./${appDirRelative}\` in your favorite IDE like VS Code. Tip: You may even be able to simply run \`code ./${appDirRelative}\` to open it now.`)
+
+      return {
+        description,
+        deploy,
+        awsProfileToCopy,
+        appDir,
+      }
+    }
+
     if (!noCopyAwsProfile) {
-      const appName = await this.getAppName({ appDir })
       copyAwsProfile({ appName })
     }
 
     if (deploy) {
-      await this.runInitDev()
+      await this.runInitDev({ appDir })
     }
 
     return {
       description,
       deploy,
       awsProfileToCopy,
+      appDir,
     }
   }
 
@@ -155,13 +180,13 @@ generating app...
     const { flags } = await this.parse(Generate)
     const { replaceAppDefinition } = flags
 
-    if (!existsSync('.codegenie')) return
+    if (!existsSync('.codegenie')) return false
 
     if (replaceAppDefinition) {
       ux.action.start('Deleting .codegenie')
       rmSync('.codegenie', { recursive: true, force: true })
       ux.action.stop('✅')
-      return
+      return true
     }
 
     this.error('A .codegenie directory already exists.', {
@@ -176,7 +201,7 @@ generating app...
   /**
    * Generates a [.codegenie app definition](https://codegenie.codes/docs) based on the provided description
    */
-  async generateAppDefinition(): Promise<void | { app: App; appName: string; appDescription: string }> {
+  async generateAppDefinition(): Promise<{ app: App; appName: string; appDescription: string }> {
     const { flags } = await this.parse(Generate)
     const { description, name } = flags
     ux.action.start('🧞  Generating App Definition')
@@ -223,12 +248,12 @@ generating app...
    * @param root0
    * @param root0.appDir
    */
-  async uploadAppDefinition({ appDir }: { appDir?: string } = {}) {
+  async uploadAppDefinition({ appDir }: { appDir: string }) {
     ux.action.start('⬆️📦 Uploading App Definition')
     const appName = await this.getAppName({ appDir })
     const output = await axios.get(`/build-upload-presigned-url?appName=${appName}`)
     const { putObjectPresignedUrl, headObjectPresignedUrl, getObjectPresignedUrl } = output.data.data
-    const appDefinitionZip = await this.createZip(path.resolve(appDir || cwd(), '.codegenie'))
+    const appDefinitionZip = await this.createZip(path.resolve(appDir, '.codegenie'))
     const zipFileSizeBytes = Buffer.byteLength(appDefinitionZip)
     const readable = getReadableFromBuffer(appDefinitionZip)
 
@@ -305,12 +330,14 @@ generating app...
     }
   }
 
-  async downloadS3OutputObject({
+  async downloadProject({
     headObjectPresignedUrl,
     getObjectPresignedUrl,
+    appDir,
   }: {
     headObjectPresignedUrl: string
     getObjectPresignedUrl: string
+    appDir: string
   }): Promise<undefined> {
     ux.action.start('🏗️   Generating project')
     await this.pollS3ObjectExistence({ headObjectPresignedUrl })
@@ -319,14 +346,15 @@ generating app...
     const response = await axios.get(getObjectPresignedUrl, { responseType: 'arraybuffer' })
     const zip = new AdmZip(response.data)
     const overwrite = false
-    zip.extractAllTo('.', overwrite)
+    zip.extractAllTo(appDir, overwrite)
     ux.action.stop('✅')
   }
 
-  async runInitDev(): Promise<undefined> {
+  async runInitDev({ appDir }: { appDir: string }): Promise<undefined> {
     ux.action.start('🌩️   Deploying to AWS. The first deploy may take up to 10 minutes')
     execSync('npm run init:dev', {
       stdio: 'inherit',
+      cwd: appDir,
     })
     ux.action.stop('✅')
   }

src/copyAwsProfile.ts

@@ -1,12 +1,20 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import os from 'node:os'
-import { paramCase } from './string-utils.js'
+import { kebabCase } from './string-utils.js'
+
+const awsCredentialsFilePath = path.resolve(os.homedir(), '.aws/credentials')
+
+export function awsCredentialsFileExists() {
+  return fs.existsSync(awsCredentialsFilePath)
+}
 
 export default function copyAwsProfile({ appName }: { appName: string }) {
-  const awsCredentialsFile = path.resolve(os.homedir(), '.aws/credentials')
-  const awsCredentials = fs.readFileSync(awsCredentialsFile, 'utf8')
-  const newProfileNameWithoutEnvSuffix = paramCase(appName)
+  // Backup the credentials file before we touch it just to be safe
+  fs.copyFileSync(awsCredentialsFilePath, `${awsCredentialsFilePath}_cg.bak`)
+
+  const awsCredentials = fs.readFileSync(awsCredentialsFilePath, 'utf8')
+  const newProfileNameWithoutEnvSuffix = kebabCase(appName)
   const newDevProfileName = `${newProfileNameWithoutEnvSuffix}_dev`
   const newStagingProfileName = `${newProfileNameWithoutEnvSuffix}_staging`
   const newProdProfileName = `${newProfileNameWithoutEnvSuffix}_prod`
@@ -18,7 +26,7 @@ export default function copyAwsProfile({ appName }: { appName: string }) {
   const [profileToCopyCreds] = profileToCopySplit.split(/\[.*]/)
   const profileToCopyCredsNewlineCleaned = profileToCopyCreds.replace('\n\n', '\n')
   fs.appendFileSync(
-    awsCredentialsFile,
+    awsCredentialsFilePath,
     `
 
 [${newDevProfileName}]${profileToCopyCredsNewlineCleaned}

src/string-utils.ts

@@ -12,4 +12,4 @@ export function getEntityNameStrings({ entityName }: { entityName: string }) {
   }
 }
 
-export const paramCase = (v: string) => _s.dasherize(_s.decapitalize(v))
+export const kebabCase = (v: string) => _s.dasherize(_s.decapitalize(v))