@tanstack/cli 0.61.1 → 0.62.1

package/tests/command-line.test.ts

@@ -1,703 +0,0 @@
-import { basename, resolve } from 'node:path'
-import { beforeEach, describe, expect, it } from 'vitest'
-
-import {
-  normalizeOptions,
-  validateLegacyCreateFlags,
-} from '../src/command-line.js'
-import {
-  sanitizePackageName,
-  getCurrentDirectoryName,
-} from '../src/utils.js'
-import {
-  __testRegisterFramework,
-  __testClearFrameworks,
-} from '@tanstack/create'
-
-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 always enable typescript (file-router/TanStack Start requires it)', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-    })
-    expect(options?.typescript).toBe(true)
-    expect(options?.mode).toBe('file-router')
-  })
-
-  it('tailwind is always enabled', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-    })
-    expect(options?.tailwind).toBe(true)
-
-    const solidOptions = await normalizeOptions({
-      projectName: 'test',
-      framework: 'solid',
-    })
-    expect(solidOptions?.tailwind).toBe(true)
-  })
-
-  it('defaults git initialization to enabled', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-    })
-
-    expect(options?.git).toBe(true)
-  })
-
-  it('respects explicit --no-git option', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-      git: false,
-    })
-
-    expect(options?.git).toBe(false)
-  })
-
-  it('should handle a starter url', async () => {
-    __testRegisterFramework({
-      id: 'solid',
-      name: 'Solid',
-      getAddOns: () => [
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router'],
-          default: true,
-        },
-      ],
-      supportedModes: {
-        'code-router': {
-          displayName: 'Code Router',
-          description: 'TanStack Router using code to define the routes',
-          forceTypescript: false,
-        },
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-    fetch.mockResponseOnce(
-      JSON.stringify({
-        id: 'https://github.com/cta-dev/cta-starter-solid',
-        typescript: false,
-        framework: 'solid',
-        mode: 'file-router',
-        type: 'starter',
-        description: 'A starter for Solid',
-        name: 'My Solid Starter',
-        dependsOn: [],
-        files: {},
-        deletedFiles: [],
-      }),
-    )
-
-    const options = await normalizeOptions({
-      projectName: 'test',
-      starter: 'https://github.com/cta-dev/cta-starter-solid',
-      deployment: 'nitro',
-    })
-    expect(options?.mode).toBe('file-router')
-    expect(options?.tailwind).toBe(true)
-    expect(options?.typescript).toBe(true)
-    expect(options?.framework?.id).toBe('solid')
-  })
-
-  it('should resolve built-in starter id from registry', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'React',
-      getAddOns: () => [],
-      supportedModes: {
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-
-    const originalRegistry = process.env.CTA_REGISTRY
-    process.env.CTA_REGISTRY = 'https://registry.example/registry.json'
-
-    fetch
-      .mockResponseOnce(
-        JSON.stringify({
-          starters: [
-            {
-              name: 'Ecommerce',
-              description: 'Ecommerce base',
-              url: './ecommerce/template.json',
-              mode: 'file-router',
-              framework: 'react',
-            },
-          ],
-        }),
-      )
-      .mockResponseOnce(
-        JSON.stringify({
-          id: 'ecommerce',
-          typescript: true,
-          framework: 'react',
-          mode: 'file-router',
-          type: 'starter',
-          description: 'Ecommerce base',
-          name: 'Ecommerce',
-          dependsOn: [],
-          files: {},
-          deletedFiles: [],
-        }),
-      )
-
-    try {
-      const options = await normalizeOptions({
-        projectName: 'test',
-        starter: 'ecommerce',
-      })
-
-      expect(options?.framework?.id).toBe('react')
-      expect(options?.starter?.id).toBe(
-        'https://registry.example/ecommerce/template.json',
-      )
-    } finally {
-      process.env.CTA_REGISTRY = originalRegistry
-    }
-  })
-
-  it('should map --template-id to starter resolution', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'React',
-      getAddOns: () => [],
-      supportedModes: {
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-
-    const originalRegistry = process.env.CTA_REGISTRY
-    process.env.CTA_REGISTRY = 'https://registry.example/registry.json'
-
-    fetch
-      .mockResponseOnce(
-        JSON.stringify({
-          templates: [
-            {
-              name: 'Resume',
-              description: 'Resume template',
-              url: './resume/template.json',
-              mode: 'file-router',
-              framework: 'react',
-            },
-          ],
-        }),
-      )
-      .mockResponseOnce(
-        JSON.stringify({
-          id: 'resume',
-          typescript: true,
-          framework: 'react',
-          mode: 'file-router',
-          type: 'starter',
-          description: 'Resume template',
-          name: 'Resume',
-          dependsOn: [],
-          files: {},
-          deletedFiles: [],
-        }),
-      )
-
-    try {
-      const options = await normalizeOptions({
-        projectName: 'test',
-        templateId: 'resume',
-      })
-
-      expect(options?.starter?.id).toBe(
-        'https://registry.example/resume/template.json',
-      )
-    } finally {
-      process.env.CTA_REGISTRY = originalRegistry
-    }
-  })
-
-  it('should resolve --template as a template id from registry', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'React',
-      getAddOns: () => [],
-      supportedModes: {
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-
-    const originalRegistry = process.env.CTA_REGISTRY
-    process.env.CTA_REGISTRY = 'https://registry.example/registry.json'
-
-    fetch
-      .mockResponseOnce(
-        JSON.stringify({
-          templates: [
-            {
-              name: 'Ecommerce',
-              description: 'Ecommerce template',
-              url: './ecommerce/template.json',
-              mode: 'file-router',
-              framework: 'react',
-            },
-          ],
-        }),
-      )
-      .mockResponseOnce(
-        JSON.stringify({
-          id: 'ecommerce',
-          typescript: true,
-          framework: 'react',
-          mode: 'file-router',
-          type: 'starter',
-          description: 'Ecommerce template',
-          name: 'Ecommerce',
-          dependsOn: [],
-          files: {},
-          deletedFiles: [],
-        }),
-      )
-
-    try {
-      const options = await normalizeOptions({
-        projectName: 'test',
-        template: 'ecommerce',
-      })
-
-      expect(options?.starter?.id).toBe(
-        'https://registry.example/ecommerce/template.json',
-      )
-    } finally {
-      process.env.CTA_REGISTRY = originalRegistry
-    }
-  })
-
-  it('prefers framework-matching template ids from registry', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'React',
-      getAddOns: () => [],
-      supportedModes: {
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-    __testRegisterFramework({
-      id: 'solid',
-      name: 'Solid',
-      getAddOns: () => [],
-      supportedModes: {
-        'file-router': {
-          displayName: 'File Router',
-          description: 'TanStack Router using files to define the routes',
-          forceTypescript: true,
-        },
-      },
-    })
-
-    const originalRegistry = process.env.CTA_REGISTRY
-    process.env.CTA_REGISTRY = 'https://registry.example/registry.json'
-
-    fetch
-      .mockResponseOnce(
-        JSON.stringify({
-          templates: [
-            {
-              name: 'Blog',
-              description: 'React blog template',
-              url: './react/blog/template.json',
-              mode: 'file-router',
-              framework: 'react',
-            },
-            {
-              name: 'Blog',
-              description: 'Solid blog template',
-              url: './solid/blog/template.json',
-              mode: 'file-router',
-              framework: 'solid',
-            },
-          ],
-        }),
-      )
-      .mockResponseOnce(
-        JSON.stringify({
-          id: 'blog',
-          typescript: true,
-          framework: 'solid',
-          mode: 'file-router',
-          type: 'starter',
-          description: 'Solid blog template',
-          name: 'Blog',
-          dependsOn: [],
-          files: {},
-          deletedFiles: [],
-        }),
-      )
-
-    try {
-      const options = await normalizeOptions({
-        projectName: 'test',
-        framework: 'solid',
-        template: 'blog',
-      })
-
-      expect(options?.framework?.id).toBe('solid')
-      expect(options?.starter?.id).toBe(
-        'https://registry.example/solid/blog/template.json',
-      )
-    } finally {
-      process.env.CTA_REGISTRY = originalRegistry
-    }
-  })
-
-  it('should default to react if no framework is provided', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-    })
-    const options = await normalizeOptions({
-      projectName: 'test',
-    })
-    expect(options?.framework?.id).toBe('react')
-  })
-
-  it('should handle forced addons', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'foo',
-          name: 'foobar',
-          modes: ['file-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router'],
-          default: true,
-        },
-      ],
-    })
-    const options = await normalizeOptions(
-      {
-        projectName: 'test',
-        framework: 'react',
-      },
-      ['foo'],
-    )
-    expect(options?.chosenAddOns.map((a) => a.id).includes('foo')).toBe(true)
-  })
-
-  it('should handle additional addons from the CLI', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'foo',
-          name: 'foobar',
-          modes: ['file-router'],
-        },
-        {
-          id: 'baz',
-          name: 'baz',
-          modes: ['file-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router'],
-          default: true,
-        },
-      ],
-    })
-    const options = await normalizeOptions(
-      {
-        projectName: 'test',
-        addOns: ['baz'],
-        framework: 'react',
-      },
-      ['foo'],
-    )
-    expect(options?.chosenAddOns.map((a) => a.id).includes('foo')).toBe(true)
-    expect(options?.chosenAddOns.map((a) => a.id).includes('baz')).toBe(true)
-    expect(options?.tailwind).toBe(true)
-    expect(options?.typescript).toBe(true)
-  })
-
-  it('should ignore legacy start add-on id from exported commands', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'tanstack-query',
-          name: 'TanStack Query',
-          modes: ['file-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router'],
-          default: true,
-        },
-      ],
-    })
-
-    const options = await normalizeOptions({
-      projectName: 'test',
-      addOns: ['start', 'tanstack-query'],
-      framework: 'react',
-    })
-
-    expect(options?.chosenAddOns.map((a) => a.id)).toContain('tanstack-query')
-    expect(options?.chosenAddOns.map((a) => a.id)).not.toContain('start')
-  })
-
-  it('should handle toolchain as an addon', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'biome',
-          name: 'Biome',
-          modes: ['file-router', 'code-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router', 'code-router'],
-          default: true,
-        },
-      ],
-    })
-    const options = await normalizeOptions({
-      projectName: 'test',
-      toolchain: 'biome',
-    })
-    expect(options?.chosenAddOns.map((a) => a.id).includes('biome')).toBe(true)
-    expect(options?.tailwind).toBe(true)
-    expect(options?.typescript).toBe(true)
-  })
-
-  it('should keep file-router mode in router-only compatibility mode', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-      routerOnly: true,
-    })
-
-    expect(options?.mode).toBe('file-router')
-  })
-
-  it('includes examples by default in non-router-only mode', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-    })
-
-    expect((options as any)?.includeExamples).toBe(true)
-  })
-
-  it('supports disabling examples from the CLI', async () => {
-    const options = await normalizeOptions({
-      projectName: 'test',
-      examples: false,
-    })
-
-    expect((options as any)?.includeExamples).toBe(false)
-  })
-
-  it('should ignore add-ons and deployment in router-only mode but keep toolchain', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'form',
-          name: 'Form',
-          modes: ['file-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router'],
-          type: 'deployment',
-        },
-        {
-          id: 'biome',
-          name: 'Biome',
-          modes: ['file-router'],
-          type: 'toolchain',
-        },
-      ],
-    })
-
-    const options = await normalizeOptions(
-      {
-        projectName: 'test',
-        framework: 'react',
-        routerOnly: true,
-        addOns: ['form'],
-        deployment: 'nitro',
-        toolchain: 'biome',
-      },
-      ['form'],
-      { forcedDeployment: 'nitro' },
-    )
-
-    expect(options?.chosenAddOns.map((a) => a.id)).toEqual(['biome'])
-  })
-
-  it('should handle the funky Windows edge case with CLI parsing', async () => {
-    __testRegisterFramework({
-      id: 'react',
-      name: 'react',
-      getAddOns: () => [
-        {
-          id: 'foo',
-          name: 'foobar',
-          modes: ['file-router', 'code-router'],
-        },
-        {
-          id: 'baz',
-          name: 'baz',
-          modes: ['file-router', 'code-router'],
-        },
-        {
-          id: 'nitro',
-          name: 'nitro',
-          modes: ['file-router', 'code-router'],
-          default: true,
-        },
-      ],
-    })
-    const options = await normalizeOptions({
-      projectName: 'test',
-      addOns: ['baz foo'],
-    })
-    expect(options?.chosenAddOns.map((a) => a.id).includes('foo')).toBe(true)
-    expect(options?.chosenAddOns.map((a) => a.id).includes('baz')).toBe(true)
-  })
-})
-
-describe('validateLegacyCreateFlags', () => {
-  it('returns no warnings or errors without legacy flags', () => {
-    const result = validateLegacyCreateFlags({})
-    expect(result.warnings).toEqual([])
-    expect(result.error).toBeUndefined()
-  })
-
-  it('warns when --router-only is used', () => {
-    const result = validateLegacyCreateFlags({ routerOnly: true })
-    expect(result.error).toBeUndefined()
-    expect(result.warnings[0]).toContain('--router-only')
-  })
-
-  it('warns when --tailwind is used', () => {
-    const result = validateLegacyCreateFlags({ tailwind: true })
-    expect(result.error).toBeUndefined()
-    expect(result.warnings[0]).toContain('--tailwind')
-  })
-
-  it('warns heavily when --no-tailwind is used', () => {
-    const result = validateLegacyCreateFlags({ tailwind: false })
-    expect(result.error).toBeUndefined()
-    expect(result.warnings[0]).toContain('--no-tailwind')
-    expect(result.warnings[0]).toContain('intentionally unsupported')
-  })
-
-  it('errors for JavaScript templates', () => {
-    const result = validateLegacyCreateFlags({ template: 'javascript' })
-    expect(result.error).toContain('JavaScript/JSX templates are not supported')
-  })
-
-  it('does not error for non-legacy template values', () => {
-    const result = validateLegacyCreateFlags({ template: 'foo' })
-    expect(result.error).toBeUndefined()
-  })
-
-  it('warns for supported deprecated template values', () => {
-    const result = validateLegacyCreateFlags({ template: 'tsx' })
-    expect(result.error).toBeUndefined()
-    expect(result.warnings[0]).toContain('--template')
-  })
-
-  it('warns when --starter is used', () => {
-    const result = validateLegacyCreateFlags({ starter: 'ecommerce' })
-    expect(result.error).toBeUndefined()
-    expect(result.warnings[0]).toContain('--starter')
-    expect(result.warnings[0]).toContain('deprecated')
-  })
-})

package/tests/index.test.ts

@@ -1,9 +0,0 @@
-import { describe, it, expect } from 'vitest'
-
-import { cli } from '../src/index.js'
-
-describe('cli', () => {
-  it('should call the cli with the correct arguments', async () => {
-    expect(cli).toBeDefined()
-  })
-})