Skip to content
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.

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

ensure suggested app names are valid #5293

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 11 additions & 1 deletion packages/app/src/cli/commands/app/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {validateFlavorValue, validateTemplateValue} from '../../services/init/va
import {MinimalOrganizationApp, Organization, OrganizationApp} from '../../models/organization.js'
import {appNamePrompt, createAsNewAppPrompt, selectAppPrompt} from '../../prompts/dev.js'
import {searchForAppsByNameFactory} from '../../services/dev/prompt-helpers.js'
import {isValidName} from '../../models/app/validation/common.js'
import {Flags} from '@oclif/core'
import {globalFlags} from '@shopify/cli-kit/node/cli'
import {resolvePath, cwd} from '@shopify/cli-kit/node/path'
Expand Down Expand Up @@ -72,7 +73,7 @@ export default class Init extends AppCommand {
validateFlavorValue(flags.template, flags.flavor)

const inferredPackageManager = inferPackageManager(flags['package-manager'])
const name = flags.name ?? (await generateRandomNameForSubdirectory({suffix: 'app', directory: flags.path}))
const name = flags.name ?? (await getAppName(flags.path))

// Force user authentication before prompting.
let developerPlatformClient = selectDeveloperPlatformClient()
Expand Down Expand Up @@ -126,6 +127,15 @@ export default class Init extends AppCommand {
}
}

async function getAppName(directory: string): Promise<string> {
for (let i = 0; i < 3; i++) {
// eslint-disable-next-line no-await-in-loop
const name = await generateRandomNameForSubdirectory({suffix: 'app', directory})
if (isValidName(name)) return name
}
return ''
}

export type SelectAppOrNewAppNameResult =
| {
result: 'new'
Expand Down
6 changes: 6 additions & 0 deletions packages/app/src/cli/models/app/validation/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ function isValidUrl(input: string, httpsOnly: boolean) {
export function ensurePathStartsWithSlash(arg: unknown) {
return typeof arg === 'string' && !arg.startsWith('/') ? `/${arg}` : arg
}

export const APP_NAME_MAX_LENGTH = 30
craigmichaelmartin marked this conversation as resolved.
Show resolved Hide resolved

export function isValidName(name: string): boolean {
return name.length <= APP_NAME_MAX_LENGTH
}
5 changes: 3 additions & 2 deletions packages/app/src/cli/prompts/dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {Organization, MinimalOrganizationApp, OrganizationStore, MinimalAppIdent
import {getTomls} from '../utilities/app/config/getTomls.js'
import {setCachedCommandTomlMap} from '../services/local-storage.js'
import {Paginateable} from '../utilities/developer-platform-client.js'
import {APP_NAME_MAX_LENGTH} from '../models/app/validation/common.js'
import {
RenderAutocompleteOptions,
renderAutocompletePrompt,
Expand Down Expand Up @@ -129,8 +130,8 @@ export async function appNamePrompt(currentName: string): Promise<string> {
if (value.length === 0) {
return "App name can't be empty"
}
if (value.length > 30) {
return 'Enter a shorter name (30 character max.)'
if (value.length > APP_NAME_MAX_LENGTH) {
return `Enter a shorter name (${APP_NAME_MAX_LENGTH} character max.)`
}
if (value.includes('shopify')) {
return 'Name can\'t contain "shopify." Enter another name.'
Expand Down
1 change: 0 additions & 1 deletion packages/cli-kit/src/public/common/string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ const SAFE_RANDOM_BUSINESS_NOUNS = [
'franchise',
'subsidiary',
'logistics',
'infrastructure',
'sponsorship',
'partnership',
'tax',
Expand Down
Loading