Skip to content

fix(add): correct template name validation #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 9, 2025
Merged

fix(add): correct template name validation #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
577d590
fix(add): correct template name validation
DamianGlowala Jan 8, 2025
2e137c1
Merge remote-tracking branch 'origin/main' into fix/add-template-name…
danielroe Jan 9, 2025
9b2d4f2
perf: remove runtime case normalisation
danielroe Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/commands/add.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ import process from 'node:process'
import { defineCommand } from 'citty'
import { dirname, extname, resolve } from 'pathe'

import { camelCase, kebabCase } from 'scule'
import { loadKit } from '../utils/kit'
import { logger } from '../utils/logger'
import { templates } from '../utils/templates'
import { cwdArgs, logLevelArgs } from './_shared'

const KEBAB_CASE_TEMPLATE_NAMES = Object.keys(templates).map(template => kebabCase(template))
const templateNames = Object.keys(templates)

export default defineCommand({
meta: {
Expand All @@ -27,7 +26,7 @@ export default defineCommand({
template: {
type: 'positional',
required: true,
valueHint: KEBAB_CASE_TEMPLATE_NAMES.join('|'),
valueHint: templateNames.join('|'),
description: `Template type to scaffold`,
},
name: {
Expand All @@ -42,7 +41,7 @@ export default defineCommand({
const templateName = ctx.args.template

// Validate template name
if (!Object.keys(KEBAB_CASE_TEMPLATE_NAMES).includes(templateName)) {
if (!templateNames.includes(templateName)) {
logger.error(
`Template ${templateName} is not supported. Possible values: ${Object.keys(
templates,
Expand All @@ -68,7 +67,7 @@ export default defineCommand({
const config = await kit.loadNuxtConfig({ cwd })

// Resolve template
const template = templates[camelCase(templateName) as keyof typeof templates]
const template = templates[templateName as keyof typeof templates]

const res = template({ name, args: ctx.args, nuxtOptions: config })

Expand Down
32 changes: 16 additions & 16 deletions src/utils/templates/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,22 @@ interface Template {
}

const templates = {
api,
app,
appConfig,
component,
composable,
error,
layer,
layout,
middleware,
module,
page,
plugin,
serverMiddleware,
serverPlugin,
serverRoute,
serverUtil,
'api': api,
'app': app,
'app-config': appConfig,
'component': component,
'composable': composable,
'error': error,
'layer': layer,
'layout': layout,
'middleware': middleware,
'module': module,
'page': page,
'plugin': plugin,
'server-middleware': serverMiddleware,
'server-plugin': serverPlugin,
'server-route': serverRoute,
'server-util': serverUtil,
} satisfies Record<string, Template>

// -- internal utils --
Expand Down
Loading