@forge/cli-shared 3.11.3-next.4 → 3.12.0-experimental-5ec0ed7

package/out/ui/text.js

@@ -195,8 +195,8 @@ What do you like or don't like about Forge? Share your feedback below or press C
             desc: 'create an app',
             start: 'Creating app...',
             success: (appName) => `Created ${appName}`,
-            successDetails: (directory, validEnvironmentOptions, environmentToOption) => `\nYour app is ready to work on, deploy, and install. We created ${validEnvironmentOptions.length} environments you can deploy to: ${validEnvironmentOptions
-                .map(environmentToOption)
+            successDetails: (directory, validEnvironmentOptions) => `\nYour app is ready to work on, deploy, and install. We created ${validEnvironmentOptions.length} environments you can deploy to: ${validEnvironmentOptions
+                .map(environment_1.environmentToOption)
                 .join(', ')}.\n\nChange to directory ${chalk_1.default.bold(directory)} to see your app files.`
         },
         intro: (givenDirectory) => `Creating an app in directory ${chalk_1.default.bold(givenDirectory)}.\n`,
@@ -246,25 +246,42 @@ What do you like or don't like about Forge? Share your feedback below or press C
             desc: "register an app you didn't create so you can run commands for it",
             start: `Registering app...`,
             success: (appName) => `Registered ${appName}`,
-            successDetails: (validEnvironmentOptions, environmentToOption) => `\nYour app is ready to work on, deploy, and install. We created ${validEnvironmentOptions.length} environments you can deploy to: ${validEnvironmentOptions
-                .map(environmentToOption)
+            successDetails: (validEnvironmentOptions) => `\nYour app is ready to work on, deploy, and install. We created ${validEnvironmentOptions.length} environments you can deploy to: ${validEnvironmentOptions
+                .map(environment_1.environmentToOption)
                 .join(', ')}.\n\nUse ${chalk_1.default.bold('forge deploy')} to deploy your app to an environment.`
         },
         confirmQuestion: 'Are you sure you want to overwrite the existing app details?'
     },
     env: {
-        option: (defaultEnvOption) => `specify the environment (default: ${defaultEnvOption})`,
+        option: 'specify the environment (defaults to your development environment)',
         invalid: 'Invalid environment name',
+        developmentOnly: (envKey) => `${(0, environment_1.environmentToOption)(envKey)} cannot be set as default environment. Only development environments can be used.`,
         error: {
+            appOwnerNotExist: 'Missing app owner details',
             appNotExist: `Your app could not be found. Make sure the app details in the manifest.yml file are correct before trying again.`,
-            envNotExist: (envKey, environmentToOption) => `Environment ${chalk_1.default.bold(environmentToOption(envKey))} does not exist. Check the environment name and try again.`
+            envNotExist: (envKey) => `Environment ${chalk_1.default.bold((0, environment_1.environmentToOption)(envKey))} does not exist. Check the environment name and try again.`
         },
-        displayEnvironment: (envKey, envType, environmentToOption) => {
-            if (envType === graphql_types_1.AppEnvironmentType.Development && envKey !== environment_1.DEFAULT_ENVIRONMENT_KEY) {
-                return `${chalk_1.default.gray('DEV')} ${environmentToOption(envKey)}`;
+        displayEnvironment: (envKey, envType) => {
+            if (envType === graphql_types_1.AppEnvironmentType.Development &&
+                envKey !== environment_1.DEFAULT_ENVIRONMENT_KEY &&
+                envKey !== environment_1.DEFAULT_ENVIRONMENT_OPTION) {
+                return `${chalk_1.default.gray('DEV')} ${(0, environment_1.environmentToOption)(envKey)}`;
             }
-            return environmentToOption(envKey);
-        }
+            return (0, environment_1.environmentToOption)(envKey);
+        },
+        warn: {
+            envWillBeCreated: (envKey) => `${chalk_1.default.bold('Warning:')} Environment ${chalk_1.default.bold((0, environment_1.environmentToOption)(envKey))} does not exist. If you continue, this development environment will be created for you.`
+        },
+        confirm: 'Do you want to continue?'
+    },
+    defaultEnv: {
+        info: 'You do not currently have a default development environment set. A default development environment is required to run commands without specifying an environment.',
+        prompt: 'Enter a name for your default development environment:',
+        warn: `${chalk_1.default.bold('Warning:')} A development environment with this name already exists. If you continue, you may be using the same environment as another contributor.`,
+        confirm: 'Do you want to continue?',
+        setSuccess: (envKey, envType) => `${exports.Text.env.displayEnvironment(envKey, envType)} has been set as your default development environment`,
+        createAndSetSuccess: (envKey, envType) => `${exports.Text.env.displayEnvironment(envKey, envType)} has been created and set as your default development environment`,
+        settingsInfo: `You can change your default development environment later by running ${chalk_1.default.bold('forge settings set')}.`
     },
     varsSet: {
         cmd: {
@@ -272,7 +289,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
             start: 'Setting environment variable...',
             success: 'Environment variable set.'
         },
-        overview: (environment, environmentType, environmentToOption) => `Setting the value of a variable in the ${exports.Text.env.displayEnvironment(environment, environmentType, environmentToOption)} environment.`,
+        overview: (environment, environmentType) => `Setting the value of a variable in the ${exports.Text.env.displayEnvironment(environment, environmentType)} environment.`,
         encryptInfo: 'Encrypting a variable means that the value will not be shown in the terminal.',
         promptEncrypt: `Select if you want the value encrypted:`,
         keyInfo: 'Use a new key to create a variable, or use an existing key to override a variable.',
@@ -285,16 +302,16 @@ What do you like or don't like about Forge? Share your feedback below or press C
     varsUnset: {
         cmd: {
             desc: 'remove an environment variable',
-            start: (environment, envType, environmentToOption) => `Unsetting the variable in the ${exports.Text.env.displayEnvironment(environment, envType, environmentToOption)} environment.`,
+            start: (environment, envType) => `Unsetting the variable in the ${exports.Text.env.displayEnvironment(environment, envType)} environment.`,
             success: (key) => `\n${greenTick} ${key} variable removed.`
         }
     },
     varsList: {
         hint: `\nRun ${chalk_1.default.bold('forge variables list')} to see your environment variables.\n`,
         cmd: 'list the environment variables',
-        empty: (environment, envType, environmentToOption) => `There are no variables in the ${exports.Text.env.displayEnvironment(environment, envType, environmentToOption)} environment.\n\nUse ${chalk_1.default.bold('forge variables set')} to create a variable.\n`,
+        empty: (environment, envType) => `There are no variables in the ${exports.Text.env.displayEnvironment(environment, envType)} environment.\n\nUse ${chalk_1.default.bold('forge variables set')} to create a variable.\n`,
         encryptedValue,
-        overview: (environment, envType, environmentToOption) => `Showing variables from the ${exports.Text.env.displayEnvironment(environment, envType, environmentToOption)} environment:\n`,
+        overview: (environment, envType) => `Showing variables from the ${exports.Text.env.displayEnvironment(environment, envType)} environment:\n`,
         postfix: `\nNote, the values of encrypted variables are shown as ${encryptedValue}.\n`
     },
     providers: {
@@ -306,7 +323,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
             start: 'Configuring provider credentials...',
             success: 'oauth provider credentials configuration is finished.'
         },
-        overview: (environment, environmentToOption) => `Configuring provider in the ${environmentToOption(environment)} environment.`,
+        overview: (environment) => `Configuring provider in the ${(0, environment_1.environmentToOption)(environment)} environment.`,
         providerKeyInfo: 'Use a provider key from the list for configuration.',
         noProviders: "Count't find providers in the manifest file. Add one.",
         promptProviderKey: 'Select provider to configure:',
@@ -320,7 +337,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
         cmd: {
             desc: 'create a new development environment',
             start: 'Creating environment...',
-            success: (envKey, envType, environmentToOption) => `Created ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)}`
+            success: (envKey, envType) => `Created ${exports.Text.env.displayEnvironment(envKey, envType)}`
         },
         overview: 'Create a new development environment.',
         promptEnvironmentKey: 'Enter a name for your environment:',
@@ -343,12 +360,12 @@ What do you like or don't like about Forge? Share your feedback below or press C
         prompt: 'Select development environment:',
         confirmationInfo: 'You are deleting the following environment(s):',
         promptConfirmation: 'Do you want to continue?',
-        individualSuccessMessage: (envKey, envType, environmentToOption) => `${log_symbols_1.default.info} ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)} deleted successfully.`,
+        individualSuccessMessage: (envKey, envType) => `${log_symbols_1.default.info} ${exports.Text.env.displayEnvironment(envKey, envType)} deleted successfully.`,
         successMessage: 'Environment(s) deleted.',
         optionEnvironmentKey: 'specify the environment to delete',
         warningMessage: `${chalk_1.default.bold('Warning:')} When deleting a development environment, you may impact in progress deployments or tunnels.`,
         noEnvironmentMessage: 'There are no development environments to delete.',
-        hasInstallationError: (envKey, environmentToOption) => `${environmentToOption(envKey)} cannot be deleted because the environment is installed on a site. You can show all the current installations of your app by running ${chalk_1.default.bold('forge install list')}.`
+        hasInstallationError: (envKey) => `${(0, environment_1.environmentToOption)(envKey)} cannot be deleted because the environment is installed on a site. You can show all the current installations of your app by running ${chalk_1.default.bold('forge install list')}.`
     },
     storage: {
         cmd: {
@@ -430,10 +447,10 @@ What do you like or don't like about Forge? Share your feedback below or press C
     deploy: {
         cmd: {
             desc: 'deploy your app to an environment',
-            start1: (envKey, environmentToOption) => `Deploying your app to the ${environmentToOption(envKey)} environment.\n${ctrlC}\n`,
-            start2: (appName, envKey, envType, environmentToOption) => `Deploying ${appName} to ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)}...`,
+            start1: (envKey, envType) => `Deploying your app to the ${exports.Text.env.displayEnvironment(envKey, envType)} environment.\n${ctrlC}\n`,
+            start2: (appName, envKey, envType) => `Deploying ${appName} to ${exports.Text.env.displayEnvironment(envKey, envType)}...`,
             success: 'Deployed\n',
-            successDetails: (appName, envKey, envType, environmentToOption) => `Deployed ${appName} to the ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)} environment.`,
+            successDetails: (appName, envKey, envType) => `Deployed ${appName} to the ${exports.Text.env.displayEnvironment(envKey, envType)} environment.`,
             distributePageLink: (appId) => `To install on a site that you're an admin of, run ${chalk_1.default.bold('forge install')}.\n` +
                 'To install on any other site, generate an installation link in the developer console and share it with the site admin: ' +
                 `https://developer.atlassian.com/console/myapps/${appId}/distribution`
@@ -481,7 +498,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
         outdatedInstallations: `We've detected new scopes or egress URLs in your app.\n` +
             `Run ${chalk_1.default.bold('forge install --upgrade')} and restart your tunnel to put them into effect.`,
         listIndexes: (environment) => {
-            const indexCommand = chalk_1.default.bold(`forge storage entities indexes list -e ${environment}`);
+            const indexCommand = chalk_1.default.bold(`forge storage entities indexes list -e ${(0, environment_1.environmentToOption)(environment)}`);
             return (`Run ${indexCommand} to check the status of the indexes.`);
         },
         egressURL: {
@@ -528,7 +545,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
     install: {
         cmd: {
             description: 'manage app installations',
-            start: (envKey, envType, environmentToOption) => `Installing your app on to ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)}...`,
+            start: (envKey, envType) => `Installing your app on to ${exports.Text.env.displayEnvironment(envKey, envType)}...`,
             end: (displayTick) => `${displayTick ? greenTick + ' ' : ''}Install complete!`
         },
         booleanToScope: (isLatest) => (isLatest ? `Latest` : `Out-of-date`),
@@ -539,17 +556,17 @@ What do you like or don't like about Forge? Share your feedback below or press C
             .map(({ name, requiresInteractiveConsent }) => `- ${name}${requiresInteractiveConsent ? ' (requires interactive consent)' : ''}`)
             .join('\n')}\n`,
         listEgressAddresses: (egressAddresses) => `Your app will exchange data with the following urls:\n${egressAddresses.map((url) => `- ${url}`).join('\n')}\n`,
-        permissionsMismatch: (environment) => `The scopes or egress URLs in the manifest are different from the scopes in your most recent deployment to ${environment}. Try running ${chalk_1.default.bold(`forge deploy -e ${environment}`)} before installing.\n`,
-        multiProductScopesDetected: (productsToInstall, productsToUpgrade, site, environment, environmentToOption) => `\nWe detected your app requires scopes across multiple products.\nRun ${chalk_1.default.bold('forge install')} for each of the following:\n${productsToUpgrade
-            .map((product) => `- forge install --upgrade -p ${(0, case_1.capital)(product)} -s ${site} -e ${environmentToOption(environment)}`)
+        permissionsMismatch: (environment) => `The scopes or egress URLs in the manifest are different from the scopes in your most recent deployment to ${(0, environment_1.environmentToOption)(environment)}. Try running ${chalk_1.default.bold(`forge deploy -e ${(0, environment_1.environmentToOption)(environment)}`)} before installing.\n`,
+        multiProductScopesDetected: (productsToInstall, productsToUpgrade, site, environment) => `\nWe detected your app requires scopes across multiple products.\nRun ${chalk_1.default.bold('forge install')} for each of the following:\n${productsToUpgrade
+            .map((product) => `- forge install --upgrade -p ${(0, case_1.capital)(product)} -s ${site} -e ${(0, environment_1.environmentToOption)(environment)}`)
             .join('\n')}${productsToUpgrade.length !== 0 && productsToInstall.length !== 0 ? '\n' : ''}${productsToInstall
-            .map((product) => `- forge install -p ${(0, case_1.capital)(product)} -s ${site} -e ${environmentToOption(environment)}`)
+            .map((product) => `- forge install -p ${(0, case_1.capital)(product)} -s ${site} -e ${(0, environment_1.environmentToOption)(environment)}`)
             .join('\n')}`,
         promptForPermissionsConfirmation: (permissionsMismatchInDevelopment) => permissionsMismatchInDevelopment
             ? 'Are you sure you want to continue installing the app?'
             : 'Do you want to continue?',
         success: {
-            banner: (envKey, envType, environmentToOption, product, site) => `Your app in the ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)} environment is now installed in ${product} on ${buildTerminalLink(site)}`
+            banner: (envKey, envType, product, site) => `Your app in the ${exports.Text.env.displayEnvironment(envKey, envType)} environment is now installed in ${product} on ${buildTerminalLink(site)}`
         },
         error: {
             invalidAtlassianSite: (url) => `The URL you entered doesn't belong to an Atlassian site: ` +
@@ -562,7 +579,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
             site: (url) => `Site is invalid: ${url}`,
             alreadyInstalledError: `Installation error: App is already installed.\nIf you're trying to upgrade your app, use the ${chalk_1.default.bold('forge install --upgrade')} command.`,
             serverSideInstallationError: (message) => `Installation error: ${message}`,
-            noDeploymentFound: (environmentOption) => `Forge apps must be deployed before installation. Deploy your app by running ${chalk_1.default.bold(`forge deploy -e ${environmentOption}`)}.`,
+            noDeploymentFound: (environment) => `Forge apps must be deployed before installation. Deploy your app by running ${chalk_1.default.bold(`forge deploy -e ${(0, environment_1.environmentToOption)(environment)}`)}.`,
             permissionsDeniedInstructions: (requestId, appId) => `Insufficient permissions to install app (requestId: ${requestId})` +
                 '\n\nTo install the app on this site, generate an installation link ' +
                 'in the developer console and share it with the site admin: ' +
@@ -598,7 +615,7 @@ ${buildTerminalLink(link)}\n`,
     upgrade: {
         banner: `\nUpgrading your app on the Atlassian site.\n`,
         cmd: {
-            start: (envKey, envType, environmentToOption) => `Upgrading your app in ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)}...`,
+            start: (envKey, envType) => `Upgrading your app in ${exports.Text.env.displayEnvironment(envKey, envType)}...`,
             end: (displayTick) => `${displayTick ? greenTick + ' ' : ''}Upgrade complete!`,
             error: `Upgrade failed`
         },
@@ -611,11 +628,11 @@ ${buildTerminalLink(link)}\n`,
             ? 'Are you sure you want to continue upgrading the app?'
             : 'Do you want to continue?',
         success: {
-            banner: (envKey, envType, environmentToOption, product, site) => `Your app in the ${exports.Text.env.displayEnvironment(envKey, envType, environmentToOption)} environment is now the latest in ${product} on ${buildTerminalLink(site)}.`
+            banner: (envKey, envType, product, site) => `Your app in the ${exports.Text.env.displayEnvironment(envKey, envType)} environment is now the latest in ${product} on ${buildTerminalLink(site)}.`
         },
         alreadyUpdated: {
             spinner: 'Site is already at the latest version',
-            banner: (environment, environmentToOption, product, site) => `\nYour app in the ${environmentToOption(environment)} environment is at the latest in ${product} on ${buildTerminalLink(site)}.`
+            banner: (environment, product, site) => `\nYour app in the ${(0, environment_1.environmentToOption)(environment)} environment is at the latest in ${product} on ${buildTerminalLink(site)}.`
         },
         error: {
             serverSideInstallationError: (message) => `Upgrade error: ${message}`
@@ -631,7 +648,7 @@ ${buildTerminalLink(link)}\n`,
         cmd: 'start a tunnel to connect your local code with the app running in the development environment',
         optionDebugger: 'enable debugger mode',
         preamble: 'Tunnel redirects requests you make to your local machine. This occurs for any Atlassian site where your app is installed in the specific development environment. You will not see requests from other users.',
-        startingTunnel: (environmentKey, envType, environmentToOption) => `Tunnelling to: ${exports.Text.env.displayEnvironment(environmentKey, envType, environmentToOption)}`,
+        startingTunnel: (environmentKey, envType) => `Tunnelling to: ${exports.Text.env.displayEnvironment(environmentKey, envType)}`,
         startedServer: (port, isDebug) => `Listening for requests${isDebug ? ' on local port ' + port : ''}...`,
         startedTunnel: (tunnelUrl) => `Started tunnel at address: ${tunnelUrl}`,
         stoppingTunnel: 'Stopping tunnel...',
@@ -701,8 +718,8 @@ Debugging in Google Chrome:
             done: `\n${log_symbols_1.default.success} Apps uninstalled`
         },
         info: 'Uninstalling the app by installation ID.',
-        done: (product, domain, environment, environmentToOption, isMulti) => `${isMulti ? log_symbols_1.default.info : log_symbols_1.default.success} Uninstalled from the ${environmentToOption(environment)} environment in ${product} on ${buildTerminalLink(domain)}.`,
-        failed: (product, domain, environment, environmentToOption) => `Failed to uninstall the app from the ${environmentToOption(environment)} environment in ${product} on ${buildTerminalLink(domain)}. Try rerunning the command, or ask for help if you continue to see this error.`,
+        done: (product, domain, environment, isMulti) => `${isMulti ? log_symbols_1.default.info : log_symbols_1.default.success} Uninstalled from the ${(0, environment_1.environmentToOption)(environment)} environment in ${product} on ${buildTerminalLink(domain)}.`,
+        failed: (product, domain, environment) => `Failed to uninstall the app from the ${(0, environment_1.environmentToOption)(environment)} environment in ${product} on ${buildTerminalLink(domain)}. Try rerunning the command, or ask for help if you continue to see this error.`,
         missingUninstallTask: `Cannot uninstall the app: something went wrong with starting the uninstall task.`
     },
     webtrigger: {
@@ -776,7 +793,7 @@ Debugging in Google Chrome:
             promptMessage: 'Allow Forge to collect CLI usage and error reporting information?'
         },
         set: {
-            description: (choices) => `update Forge CLI setting (choices: ${choices.join(',')})`,
+            description: (choices) => `update Forge CLI setting (choices: ${choices.join(', ')})`,
             invalidSetting: (choices) => `Invalid setting specified. Valid settings: ${choices.join(', ')}`,
             invalidValue: `Invalid value specified. Valid values: true, false`,
             success: (setting, value) => `${greenTick} Successfully set ${setting} as ${value}.`
@@ -786,6 +803,9 @@ Debugging in Google Chrome:
         },
         usageAnalytics: {
             description: 'Allow Forge to collect CLI usage and error reporting information'
+        },
+        defaultEnvironment: {
+            description: 'Change your default development environment'
         }
     },
     nonInteractive: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "3.11.3-next.4",
+  "version": "3.12.0-experimental-5ec0ed7",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,7 +12,7 @@
     "generate-graphql-types": "graphql-codegen --config src/graphql/codegen.yml"
   },
   "dependencies": {
-    "@forge/manifest": "4.13.0-next.3",
+    "@forge/manifest": "4.13.0",
     "@forge/util": "1.2.3",
     "@sentry/node": "^7.29.0",
     "array.prototype.flatmap": "^1.2.3",
@@ -64,6 +64,7 @@
     "@types/tmp": "^0.1.0",
     "@types/unzipper": "^0.10.5",
     "graphql-tools": "^6.2.4",
-    "jest-fixtures": "^0.6.0"
+    "jest-fixtures": "^0.6.0",
+    "jest-matcher-specific-error": "^1.0.0"
   }
 }