feat: supporting . as the package name

Author: jherr

frameworks/react-cra/src/checksum.ts

@@ -1,3 +1,3 @@
 // This file is auto-generated. Do not edit manually.
 // Generated from add-ons, examples, hosts, project, and toolchains directories
-export const contentChecksum = 'b722b3f8235cbf4618c508da1b499a8a6a583d8107eebeb9e2ffe19716ddc7e9'
+export const contentChecksum = '0b4c2f7b4e91fb80d16db47f572d9547629aac841a00f154cb18869936013618'

packages/cta-cli/src/cli.ts

@@ -528,8 +528,20 @@ Remove your node_modules directory and package lock file and re-install.`,
           throw new Error('No options were provided')
         }
 
-        finalOptions.targetDir =
-          options.targetDir || resolve(process.cwd(), finalOptions.projectName)
+        // Determine target directory:
+        // 1. Use --target-dir if provided
+        // 2. Use targetDir from normalizeOptions if set (handles "." case)
+        // 3. If original projectName was ".", use current directory
+        // 4. Otherwise, use project name as subdirectory
+        if (options.targetDir) {
+          finalOptions.targetDir = options.targetDir
+        } else if (finalOptions.targetDir) {
+          // Keep the targetDir from normalizeOptions (handles "." case)
+        } else if (projectName === '.') {
+          finalOptions.targetDir = resolve(process.cwd())
+        } else {
+          finalOptions.targetDir = resolve(process.cwd(), finalOptions.projectName)
+        }
 
         await createApp(environment, finalOptions)
       } catch (error) {

packages/cta-cli/src/command-line.ts

@@ -9,7 +9,11 @@ import {
   populateAddOnOptionsDefaults,
 } from '@tanstack/cta-engine'
 
-import { validateProjectName } from './utils.js'
+import {
+  getCurrentDirectoryName,
+  sanitizePackageName,
+  validateProjectName,
+} from './utils.js'
 import type { Options } from '@tanstack/cta-engine'
 
 import type { CliOptions } from './types.js'
@@ -23,7 +27,17 @@ export async function normalizeOptions(
     forcedDeployment?: string
   },
 ): Promise<Options | undefined> {
-  const projectName = (cliOptions.projectName ?? '').trim()
+  let projectName = (cliOptions.projectName ?? '').trim()
+  let targetDir: string
+
+  // Handle "." as project name - use current directory
+  if (projectName === '.') {
+    projectName = sanitizePackageName(getCurrentDirectoryName())
+    targetDir = resolve(process.cwd())
+  } else {
+    targetDir = resolve(process.cwd(), projectName)
+  }
+
   if (!projectName && !opts?.disableNameCheck) {
     return undefined
   }
@@ -134,7 +148,7 @@ export async function normalizeOptions(
 
   return {
     projectName: projectName,
-    targetDir: resolve(process.cwd(), projectName),
+    targetDir,
     framework,
     mode,
     typescript,

packages/cta-cli/src/options.ts

@@ -21,7 +21,11 @@ import {
   selectTypescript,
 } from './ui-prompts.js'
 
-import { validateProjectName } from './utils.js'
+import {
+  getCurrentDirectoryName,
+  sanitizePackageName,
+  validateProjectName,
+} from './utils.js'
 import type { Options } from '@tanstack/cta-engine'
 
 import type { CliOptions } from './types.js'
@@ -43,12 +47,17 @@ export async function promptForCreateOptions(
   options.framework = getFrameworkById(cliOptions.framework || 'react-cra')!
 
   if (cliOptions.projectName) {
-    const { valid, error } = validateProjectName(cliOptions.projectName)
+    // Handle "." as project name - use sanitized current directory name
+    if (cliOptions.projectName === '.') {
+      options.projectName = sanitizePackageName(getCurrentDirectoryName())
+    } else {
+      options.projectName = cliOptions.projectName
+    }
+    const { valid, error } = validateProjectName(options.projectName)
     if (!valid) {
       console.error(error)
       process.exit(1)
     }
-    options.projectName = cliOptions.projectName
   } else {
     options.projectName = await getProjectName()
   }

packages/cta-cli/src/utils.ts

@@ -1,3 +1,4 @@
+import { basename } from 'node:path'
 import validatePackageName from 'validate-npm-package-name'
 import type { TemplateOptions } from './types.js'
 
@@ -8,6 +9,21 @@ export function convertTemplateToMode(template: TemplateOptions): string {
   return 'file-router'
 }
 
+export function sanitizePackageName(name: string): string {
+  return name
+    .toLowerCase()
+    .replace(/\s+/g, '-') // Replace spaces with hyphens
+    .replace(/_/g, '-') // Replace underscores with hyphens
+    .replace(/[^a-z0-9-]/g, '') // Remove invalid characters
+    .replace(/^[^a-z]+/, '') // Ensure it starts with a letter
+    .replace(/-+/g, '-') // Collapse multiple hyphens
+    .replace(/-$/, '') // Remove trailing hyphen
+}
+
+export function getCurrentDirectoryName(): string {
+  return basename(process.cwd())
+}
+
 export function validateProjectName(name: string) {
   const { validForNewPackages, validForOldPackages, errors, warnings } =
     validatePackageName(name)

packages/cta-cli/tests/command-line.test.ts

@@ -1,6 +1,11 @@
+import { basename, resolve } from 'node:path'
 import { beforeEach, describe, expect, it } from 'vitest'
 
 import { normalizeOptions } from '../src/command-line.js'
+import {
+  sanitizePackageName,
+  getCurrentDirectoryName,
+} from '../src/utils.js'
 import {
   __testRegisterFramework,
   __testClearFrameworks,
@@ -10,12 +15,58 @@ beforeEach(() => {
   __testClearFrameworks()
 })
 
+describe('sanitizePackageName', () => {
+  it('should convert to lowercase', () => {
+    expect(sanitizePackageName('MyProject')).toBe('myproject')
+  })
+
+  it('should replace spaces with hyphens', () => {
+    expect(sanitizePackageName('my project')).toBe('my-project')
+  })
+
+  it('should replace underscores with hyphens', () => {
+    expect(sanitizePackageName('my_project')).toBe('my-project')
+  })
+
+  it('should remove invalid characters', () => {
+    expect(sanitizePackageName('my@project!')).toBe('myproject')
+  })
+
+  it('should ensure it starts with a letter', () => {
+    expect(sanitizePackageName('123project')).toBe('project')
+    expect(sanitizePackageName('_myproject')).toBe('myproject')
+  })
+
+  it('should collapse multiple hyphens', () => {
+    expect(sanitizePackageName('my--project')).toBe('my-project')
+  })
+
+  it('should remove trailing hyphen', () => {
+    expect(sanitizePackageName('myproject-')).toBe('myproject')
+  })
+})
+
+describe('getCurrentDirectoryName', () => {
+  it('should return the basename of the current working directory', () => {
+    expect(getCurrentDirectoryName()).toBe(basename(process.cwd()))
+  })
+})
+
 describe('normalizeOptions', () => {
   it('should return undefined if project name is not provided', async () => {
     const options = await normalizeOptions({})
     expect(options).toBeUndefined()
   })
 
+  it('should handle "." as project name by using sanitized current directory name', async () => {
+    const options = await normalizeOptions({
+      projectName: '.',
+    })
+    const expectedName = sanitizePackageName(getCurrentDirectoryName())
+    expect(options?.projectName).toBe(expectedName)
+    expect(options?.targetDir).toBe(resolve(process.cwd()))
+  })
+
   it('should return enable typescript based on the framework', async () => {
     const jsOptions = await normalizeOptions({
       projectName: 'test',

packages/cta-engine/src/create-app.ts

@@ -241,13 +241,23 @@ Errors were encountered during the creation of your app:
 ${environment.getErrors().join('\n')}`
   }
 
+  // Check if we created in current directory (user specified ".")
+  const isCurrentDirectory =
+    resolve(options.targetDir) === resolve(process.cwd())
+  const locationMessage = isCurrentDirectory
+    ? `Your ${environment.appName} app is ready.`
+    : `Your ${environment.appName} app is ready in '${basename(options.targetDir)}'.`
+  const cdInstruction = isCurrentDirectory
+    ? ''
+    : `% cd ${options.projectName}
+`
+
   // Use the force luke! :)
   environment.outro(
-    `Your ${environment.appName} app is ready in '${basename(options.targetDir)}'.
+    `${locationMessage}
 
 Use the following commands to start your app:
-% cd ${options.projectName}
-% ${formatCommand(
+${cdInstruction}% ${formatCommand(
       getPackageManagerScriptCommand(options.packageManager, ['dev']),
     )}