This repository has been archived by the owner on Jan 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 478
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[expo-cli] Combined ID prompts for build and eject (#2313)
* Combined ID prompts for build and eject * Move prompt to after validation * Update Eject.ts
- Loading branch information
Showing
5 changed files
with
216 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
194 changes: 194 additions & 0 deletions
194
packages/expo-cli/src/commands/eject/ConfigValidation.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| import { ExpoConfig, getConfig, modifyConfigAsync } from '@expo/config'; | ||
| import { UserManager } from '@expo/xdl'; | ||
| import terminalLink from 'terminal-link'; | ||
|
|
||
| import log from '../../log'; | ||
| import prompt from '../../prompt'; | ||
|
|
||
| const noBundleIdMessage = `Your project must have a \`bundleIdentifier\` set in the Expo config (app.json or app.config.js).\nSee https://expo.fyi/bundle-identifier`; | ||
| const noPackageMessage = `Your project must have a \`package\` set in the Expo config (app.json or app.config.js).\nSee https://expo.fyi/android-package`; | ||
|
|
||
| function validateBundleId(value: string): boolean { | ||
| return /^[a-zA-Z][a-zA-Z0-9\-.]+$/.test(value); | ||
| } | ||
|
|
||
| function validatePackage(value: string): boolean { | ||
| return /^[a-zA-Z][a-zA-Z0-9_]*(\.[a-zA-Z][a-zA-Z0-9_]*)+$/.test(value); | ||
| } | ||
|
|
||
| export async function getOrPromptForBundleIdentifier(projectRoot: string): Promise<string> { | ||
| let { exp } = getConfig(projectRoot); | ||
|
|
||
| const currentBundleId = exp.ios?.bundleIdentifier; | ||
| if (currentBundleId) { | ||
| if (validateBundleId(currentBundleId)) { | ||
| return currentBundleId; | ||
| } | ||
|
|
||
| log( | ||
| log.chalk.red( | ||
| `The ios.bundleIdentifier defined in your Expo config is not formatted properly. Only alphanumeric characters, '.', '-', and '_' are allowed, and each '.' must be followed by a letter.` | ||
| ) | ||
| ); | ||
|
|
||
| process.exit(1); | ||
| } | ||
|
|
||
| // Recommend a bundle ID based on the username and project slug. | ||
| let recommendedBundleId: string | undefined; | ||
| // Attempt to use the android package name first since it's convenient to have them aligned. | ||
| if (exp.android?.package && validateBundleId(exp.android?.package)) { | ||
| recommendedBundleId = exp.android?.package; | ||
| } else { | ||
| const username = exp.owner ?? (await UserManager.getCurrentUsernameAsync()); | ||
| const possibleId = `com.${username}.${exp.slug}`; | ||
| if (username && validateBundleId(possibleId)) { | ||
| recommendedBundleId = possibleId; | ||
| } | ||
| } | ||
|
|
||
| log.newLine(); | ||
| log( | ||
| log.chalk.cyan( | ||
| `Now we need to know your ${terminalLink( | ||
| 'iOS bundle identifier', | ||
| 'https://expo.fyi/bundle-identifier' | ||
| )}.\nYou can change this in the future if you need to.` | ||
| ) | ||
| ); | ||
| log.newLine(); | ||
|
|
||
| // Prompt the user for the bundle ID. | ||
| // Even if the project is using a dynamic config we can still | ||
| // prompt a better error message, recommend a default value, and help the user | ||
| // validate their custom bundle ID upfront. | ||
| const { bundleIdentifier } = await prompt( | ||
| [ | ||
| { | ||
| name: 'bundleIdentifier', | ||
| default: recommendedBundleId, | ||
| // The Apple helps people know this isn't an EAS feature. | ||
| message: `What would you like your iOS bundle identifier to be?`, | ||
| validate: validateBundleId, | ||
| }, | ||
| ], | ||
| { | ||
| nonInteractiveHelp: noBundleIdMessage, | ||
| } | ||
| ); | ||
|
|
||
| await attemptModification(projectRoot, `Your iOS bundle identifier is now: ${bundleIdentifier}`, { | ||
| ios: { bundleIdentifier }, | ||
| }); | ||
|
|
||
| return bundleIdentifier; | ||
| } | ||
|
|
||
| export async function getOrPromptForPackage(projectRoot: string): Promise<string> { | ||
| let { exp } = getConfig(projectRoot); | ||
|
|
||
| const currentPackage = exp.android?.package; | ||
| if (currentPackage) { | ||
| if (validatePackage(currentPackage)) { | ||
| return currentPackage; | ||
| } | ||
| log( | ||
| log.chalk.red( | ||
| `Invalid format of Android package name. Only alphanumeric characters, '.' and '_' are allowed, and each '.' must be followed by a letter.` | ||
| ) | ||
| ); | ||
|
|
||
| process.exit(1); | ||
| } | ||
|
|
||
| // Recommend a package name based on the username and project slug. | ||
| let recommendedPackage: string | undefined; | ||
| // Attempt to use the ios bundle id first since it's convenient to have them aligned. | ||
| if (exp.ios?.bundleIdentifier && validatePackage(exp.ios.bundleIdentifier)) { | ||
| recommendedPackage = exp.ios.bundleIdentifier; | ||
| } else { | ||
| const username = exp.owner ?? (await UserManager.getCurrentUsernameAsync()); | ||
| const possibleId = `com.${username}.${exp.slug}`; | ||
| if (username && validatePackage(possibleId)) { | ||
| recommendedPackage = possibleId; | ||
| } | ||
| } | ||
|
|
||
| log.newLine(); | ||
| log( | ||
| `Now we need to know your ${terminalLink( | ||
| 'Android package', | ||
| 'https://expo.fyi/android-package' | ||
| )}. You can change this in the future if you need to.` | ||
| ); | ||
| log.newLine(); | ||
|
|
||
| // Prompt the user for the android package. | ||
| // Even if the project is using a dynamic config we can still | ||
| // prompt a better error message, recommend a default value, and help the user | ||
| // validate their custom android package upfront. | ||
| const { packageName } = await prompt( | ||
| [ | ||
| { | ||
| name: 'packageName', | ||
| default: recommendedPackage, | ||
| message: `What would you like your Android package to be named?`, | ||
| validate: validatePackage, | ||
| }, | ||
| ], | ||
| { | ||
| nonInteractiveHelp: noPackageMessage, | ||
| } | ||
| ); | ||
|
|
||
| await attemptModification(projectRoot, `Your Android package is now: ${packageName}`, { | ||
| android: { package: packageName }, | ||
| }); | ||
|
|
||
| return packageName; | ||
| } | ||
|
|
||
| async function attemptModification( | ||
| projectRoot: string, | ||
| modificationSuccessMessage: string, | ||
| edits: Partial<ExpoConfig> | ||
| ): Promise<void> { | ||
| const modification = await modifyConfigAsync(projectRoot, edits, { | ||
| skipSDKVersionRequirement: true, | ||
| }); | ||
| if (modification.type === 'success') { | ||
| log.newLine(); | ||
| log(modificationSuccessMessage); | ||
| log.newLine(); | ||
| } else { | ||
| warnAboutConfigAndExit(modification.type, modification.message!, edits); | ||
| } | ||
| } | ||
|
|
||
| function logNoConfig() { | ||
| log( | ||
| log.chalk.yellow( | ||
| 'No Expo config was found. Please create an Expo config (`app.config.js` or `app.json`) in your project root.' | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| function warnAboutConfigAndExit(type: string, message: string, edits: Partial<ExpoConfig>) { | ||
| log.newLine(); | ||
| if (type === 'warn') { | ||
| // The project is using a dynamic config, give the user a helpful log and bail out. | ||
| log(log.chalk.yellow(message)); | ||
| } else { | ||
| logNoConfig(); | ||
| } | ||
|
|
||
| notifyAboutManualConfigEdits(edits); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| function notifyAboutManualConfigEdits(edits: Partial<ExpoConfig>) { | ||
| log(log.chalk.cyan(`Please add the following to your Expo config, and try again... `)); | ||
| log.newLine(); | ||
| log(JSON.stringify(edits, null, 2)); | ||
| log.newLine(); | ||
| } |
Oops, something went wrong.