Skip to content

Commit 13fed76

Browse files
Merge pull request #5293 from Shopify/ensure-suggested-app-names-are-valid
ensure suggested app names are valid
2 parents f793e39 + 4a04aa9 commit 13fed76

File tree

4 files changed

+20
-4
lines changed

4 files changed

+20
-4
lines changed

packages/app/src/cli/commands/app/init.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {validateFlavorValue, validateTemplateValue} from '../../services/init/va
77
import {MinimalOrganizationApp, Organization, OrganizationApp} from '../../models/organization.js'
88
import {appNamePrompt, createAsNewAppPrompt, selectAppPrompt} from '../../prompts/dev.js'
99
import {searchForAppsByNameFactory} from '../../services/dev/prompt-helpers.js'
10+
import {isValidName} from '../../models/app/validation/common.js'
1011
import {Flags} from '@oclif/core'
1112
import {globalFlags} from '@shopify/cli-kit/node/cli'
1213
import {resolvePath, cwd} from '@shopify/cli-kit/node/path'
@@ -72,7 +73,7 @@ export default class Init extends AppCommand {
7273
validateFlavorValue(flags.template, flags.flavor)
7374

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

7778
// Force user authentication before prompting.
7879
let developerPlatformClient = selectDeveloperPlatformClient()
@@ -126,6 +127,15 @@ export default class Init extends AppCommand {
126127
}
127128
}
128129

130+
async function getAppName(directory: string): Promise<string> {
131+
for (let i = 0; i < 3; i++) {
132+
// eslint-disable-next-line no-await-in-loop
133+
const name = await generateRandomNameForSubdirectory({suffix: 'app', directory})
134+
if (isValidName(name)) return name
135+
}
136+
return ''
137+
}
138+
129139
export type SelectAppOrNewAppNameResult =
130140
| {
131141
result: 'new'

packages/app/src/cli/models/app/validation/common.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ function isValidUrl(input: string, httpsOnly: boolean) {
2020
export function ensurePathStartsWithSlash(arg: unknown) {
2121
return typeof arg === 'string' && !arg.startsWith('/') ? `/${arg}` : arg
2222
}
23+
24+
export const APP_NAME_MAX_LENGTH = 30
25+
26+
export function isValidName(name: string): boolean {
27+
return name.length <= APP_NAME_MAX_LENGTH
28+
}

packages/app/src/cli/prompts/dev.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {Organization, MinimalOrganizationApp, OrganizationStore, MinimalAppIdent
33
import {getTomls} from '../utilities/app/config/getTomls.js'
44
import {setCachedCommandTomlMap} from '../services/local-storage.js'
55
import {Paginateable} from '../utilities/developer-platform-client.js'
6+
import {APP_NAME_MAX_LENGTH} from '../models/app/validation/common.js'
67
import {
78
RenderAutocompleteOptions,
89
renderAutocompletePrompt,
@@ -129,8 +130,8 @@ export async function appNamePrompt(currentName: string): Promise<string> {
129130
if (value.length === 0) {
130131
return "App name can't be empty"
131132
}
132-
if (value.length > 30) {
133-
return 'Enter a shorter name (30 character max.)'
133+
if (value.length > APP_NAME_MAX_LENGTH) {
134+
return `Enter a shorter name (${APP_NAME_MAX_LENGTH} character max.)`
134135
}
135136
if (value.includes('shopify')) {
136137
return 'Name can\'t contain "shopify." Enter another name.'

packages/cli-kit/src/public/common/string.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ const SAFE_RANDOM_BUSINESS_NOUNS = [
110110
'franchise',
111111
'subsidiary',
112112
'logistics',
113-
'infrastructure',
114113
'sponsorship',
115114
'partnership',
116115
'tax',

0 commit comments

Comments
 (0)