@forge/cli-shared 8.5.0-next.6 → 8.5.0-next.7

package/out/ui/text.js

@@ -12,10 +12,11 @@ const cli_details_1 = require("../shared/cli-details");
 const environment_1 = require("../shared/environment");
 const manifest_1 = require("@forge/manifest");
 const ctrlC = 'Press Ctrl+C to cancel.';
-const gettingStartedDACLink = 'https://go.atlassian.com/dac/platform/forge/getting-started/#log-in-with-an-atlassian-api-token';
 const encryptedValue = '****';
 const greenTick = `${chalk_1.default.bold(chalk_1.default.green('✔'))}`;
 const buildTerminalLink = (text) => (0, terminal_link_1.default)(chalk_1.default.bold(text), text, { fallback: () => chalk_1.default.underline.bold(text) });
+const go = (link) => buildTerminalLink(`https://go.atlassian.com/${link}`);
+const gettingStartedDACLink = go('dac/platform/forge/getting-started/#log-in-with-an-atlassian-api-token');
 const command = (...args) => chalk_1.default.bold(args.join(' '));
 const forge = (...args) => command('forge', ...args);
 const autoSpaceSentences = (...sentences) => sentences
@@ -48,9 +49,11 @@ const platformKeytarRecommendations = () => {
     }
 };
 exports.Text = {
+    buildTerminalLink,
+    go,
     error: {
-        noKeytar: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables before trying again. See ${buildTerminalLink(gettingStartedDACLink)} for more.`),
-        noTokenStored: `Not logged in. If a local keychain is available, run ${forge('login')}, otherwise set environment variables before trying again. See ${buildTerminalLink(gettingStartedDACLink)} for more.`,
+        noKeytar: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables before trying again. See ${gettingStartedDACLink} for more.`),
+        noTokenStored: `Not logged in. If a local keychain is available, run ${forge('login')}, otherwise set environment variables before trying again. See ${gettingStartedDACLink} for more.`,
         keytarAccessError: {
             other: (message) => keytarAccessErrorBase(message),
             mac: (message) => keytarAccessErrorBase(message) +
@@ -102,7 +105,7 @@ exports.Text = {
     warning: {
         plaintextCredentialsFound: (url) => `Your credentials were stored in plaintext by a previous version of the Forge CLI. For additional security, revoke your existing API token by visting this URL ${buildTerminalLink(url)}.`,
         plaintextCredentialsMigrated: 'The credentials found in plaintext have been migrated to your local keychain.',
-        plaintextCredentialsNotMigrated: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables instead. See ${buildTerminalLink(gettingStartedDACLink)} for more information.`),
+        plaintextCredentialsNotMigrated: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables instead. See ${gettingStartedDACLink} for more information.`),
         unsupportedNodeVersion: (_userNodeVersion, supportedNodeVersions) => log_color_1.LogColor.warn(`Warning: Forge CLI supports Node.js ${supportedNodeVersions}.` +
             `\nUnsupported Node.js versions are not guaranteed to work correctly.\n`),
         deprecation: {
@@ -217,9 +220,9 @@ exports.Text = {
         action: {
             start: `Help us make Forge even better.
 
-For any questions, post them on: https://go.atlassian.com/developer-community
+For any questions, post them on: ${go('developer-community')}
 
-To report bugs or issues, go to: https://go.atlassian.com/forge-project
+To report bugs or issues, go to: ${go('forge-project')}
 
 What do you like or don't like about Forge? Share your feedback below or press Ctrl+C to cancel.
 `,
@@ -242,7 +245,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
         introWithCurrentDirectory: (currentDirectory) => `Creating an app in your current directory:\n\n    ${chalk_1.default.bold(currentDirectory)}\n`,
         optionTemplate: 'specify the template to use',
         optionDirectory: 'specify the directory to create (uses the template name by default)',
-        optionSpace: 'specify the developer space id to use',
+        optionSpace: 'specify the Developer Space id to use',
         overviewAppName: `\nName your app. The app name can include dashes, spaces, and underscores.\n`,
         overviewTemplates: '\nStart with a template. Each template contains the required files to be a valid app.\n',
         waitTemplates: 'Getting template list...',
@@ -282,29 +285,29 @@ What do you like or don't like about Forge? Share your feedback below or press C
         }
     },
     devSpace: {
-        fetching: 'Fetching your developer spaces...',
+        fetching: 'Fetching your Developer Spaces...',
         documentationLink: 'https://developer.atlassian.com/platform/forge/developer-space/developer-spaces-introduction',
-        noSpacesFound: (command, documentationLink) => `You are not currently a member of a Developer Space. You must be a member of a Developer space to ${command} an app. Please contact an admin to be added to an existing space or create a new one. To learn more about your Developer Space, go to: ${documentationLink}\n`,
+        noSpacesFound: (command, documentationLink) => `You are not currently a member of a Developer Space. You must be a member of a Developer Space to ${command} an app. Please contact an admin to be added to an existing space or create a new one. To learn more about your Developer Space, go to: ${documentationLink}\n`,
         selectPrompt: 'Select or create a Developer Space:',
         assignmentInfo: 'You are about to assign your app to a Developer Space. Once you assign your app to the selected Developer Space, all usage and billing for the app will be managed through this space.',
         selectionPrompt: (documentationLink) => `Please select the Developer Space you want to assign your app to. To learn more about your Developer Space, go to: ${documentationLink}`,
         createNewOption: 'Create a new Developer Space',
         createContinuePrompt: 'Do you want to continue?',
         createNewSpaceInfo: (documentationLink) => `\nA new Developer Space will now be created for you. To learn more about your Developer Space, go to: \n${documentationLink}`,
-        createMessage: '\nName your Developer Space. The name must be unique and can include dashes, spaces, and underscores.\n',
+        createMessage: 'Name your Developer Space. The name must be unique and can include dashes, spaces, and underscores.\n',
         createPrompt: 'Enter a name for your Developer Space:',
         nameRequired: 'Developer Space name is required.',
         createInProgress: 'Creating your Developer Space...',
         contributingToSpace: (name) => `${greenTick} You are contributing to this Developer Space: ${name}.\n`,
         assigningToSpace: (name) => `${greenTick} You are assigning your app to this Developer Space: ${name}.\n`,
         createdAndContributing: (name) => `A Developer Space has been created for you. You are contributing to this Developer Space: ${name}.`,
-        invalidSpaceName: (spaceName) => `Developer space does not exist or you do not have access to it.`,
-        invalidSpaceId: (spaceId) => `Developer space id is not a valid UUID.`,
+        invalidSpaceName: (spaceName) => `The Developer Space does not exist, or you don't have the correct permissions to access it.`,
+        invalidSpaceId: (spaceId) => `Developer Space id is not a valid UUID.`,
         error: {
-            fetchOrSelect: (errorMessage) => `Failed to fetch or select developer space: ${errorMessage}`,
-            create: (errorMessage) => `Failed to create developer space: ${errorMessage}`,
-            selectedNotFound: 'Selected developer space not found',
-            nameAlreadyExists: chalk_1.default.red('\nError: The name you have entered for your developer space is already in use. Please choose a different name to ensure it is unique.')
+            fetchOrSelect: (errorMessage) => `Failed to fetch or select Developer Space: ${errorMessage}`,
+            create: (errorMessage) => `Failed to create Developer Space: ${errorMessage}`,
+            selectedNotFound: 'Selected Developer Space not found',
+            nameAlreadyExists: chalk_1.default.red('\nError: The name you have entered for your Developer Space is already in use. Please choose a different name to ensure it is unique.')
         },
         terms: {
             agreement: 'Please review the following agreement before continuing:\n',
@@ -824,10 +827,10 @@ What do you like or don't like about Forge? Share your feedback below or press C
             mpacAppConnectKeyChangeAnalyticsError: 'Cannot change app.connect.key for an app with an Atlassian Marketplace listing.',
             mpacAppConnectKeyChangeError: (mpacAppKey, connectKey) => log_color_1.LogColor.error(`Cannot change the app.connect.key from \'${mpacAppKey}\' to \'${connectKey}\'. The app's Connect key must match the Atlassian Marketplace key.\n`),
             connectKeyChangeWarning: (environment, migrationKey, connectKey) => `WARNING: Changing the app.connect.key in ${(0, environment_1.environmentToOption)(environment)} from \'${migrationKey}\' to \'${connectKey}\' affects features using the Connect key as an identifier. ` +
-                `\nLearn more about the impact of this change at https://go.atlassian.com/forge-connect-key-changes.\n`,
+                `\nLearn more about the impact of this change at ${go('forge-connect-key-changes')}.\n`,
             connectKeyDeleteWarning: (environment) => `WARNING: You're about to delete the app.connect.key of the app in ${(0, environment_1.environmentToOption)(environment)}. ` +
                 `\nIf you proceed, non-Forge Connect installations using the Connect key will no longer be replaced by future Forge installations of the app, and will co-exist. ` +
-                `\nLearn more at https://go.atlassian.com/forge-connect-key-deletion.\n`,
+                `\nLearn more at ${go('forge-connect-key-deletion')}.\n`,
             connectKeyMutationInProductionError: (migrationKey, connectKey) => log_color_1.LogColor.error(`Cannot change the app.connect.key from \'${migrationKey}\' to \'${connectKey}\'. The app's Connect key cannot be mutated in production after deployment.\n`),
             connectKeyMutationInProductionAnalyticsError: 'Cannot mutate app.connect.key for an app in production.'
         },
@@ -851,8 +854,8 @@ 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 ${forge('install', '--upgrade')} and restart your tunnel to put them into effect.`,
-        postDeploymentRoaEligibilityFailure: (appVersion, envKey, envType) => `${log_symbols_1.default.info} The version of your app [${appVersion}] that was just deployed to [${exports.Text.env.displayEnvironment(envKey, envType)}] is not eligible for the Runs on Atlassian program. Run ${forge('eligibility')} to know more.\n\nTo know more about Runs on Atlassian, go to https://go.atlassian.com/runs-on-atlassian`,
-        postDeploymentRoaEligibilitySuccess: (appVersion, envKey, envType) => `${log_symbols_1.default.info} The version of your app [${appVersion}] that was just deployed to [${exports.Text.env.displayEnvironment(envKey, envType)}] is eligible for the Runs on Atlassian program.\n\nTo know more about Runs on Atlassian, go to https://go.atlassian.com/runs-on-atlassian`,
+        postDeploymentRoaEligibilityFailure: (appVersion, envKey, envType) => `${log_symbols_1.default.info} The version of your app [${appVersion}] that was just deployed to [${exports.Text.env.displayEnvironment(envKey, envType)}] is not eligible for the Runs on Atlassian program. Run ${forge('eligibility')} to know more.\n\nTo know more about Runs on Atlassian, go to ${go('runs-on-atlassian')}.`,
+        postDeploymentRoaEligibilitySuccess: (appVersion, envKey, envType) => `${log_symbols_1.default.info} The version of your app [${appVersion}] that was just deployed to [${exports.Text.env.displayEnvironment(envKey, envType)}] is eligible for the Runs on Atlassian program.\n\nTo know more about Runs on Atlassian, go to ${go('runs-on-atlassian')}.`,
         listIndexes: (environment) => `Run ${forge('storage', 'entities', 'indexes', 'list', '-e', (0, environment_1.environmentToOption)(environment))} to check the status of the indexes.`,
         reindexingInProgress: {
             continueDeployment: 'Reindexing is currently in progress. Are you sure you want to deploy?',
@@ -926,7 +929,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
                 '\n\nTo install the app on this site, generate an installation link ' +
                 'in the developer console and share it with the site admin: ' +
                 `https://developer.atlassian.com/console/myapps/${appId}/distribution`,
-            appendRequestIdToErrorMessage: (message, requestId) => `${message} For more help on this issue, please reach out to support ${buildTerminalLink('(https://developer.atlassian.com/support)')} and provide them the following request ID: ${requestId}`,
+            appendRequestIdToErrorMessage: (message, requestId) => `${message} For more help on this issue, please reach out to support (${buildTerminalLink('https://developer.atlassian.com/support')}) and provide them the following request ID: ${requestId}`,
             majorVersionNotFound: 'The major version you specified does not exist. Check the version number and try again.',
             majorVersionAndUpgrade: 'Cannot use the major version flag with the upgrade flag'
         },
@@ -961,7 +964,7 @@ ${buildTerminalLink(link)}\n`,
     harmonization: {
         installation: {
             errors: {
-                concurrentSync: `Install has failed due to a background syncing clash. Try installing your app again in 10 minutes. If you see this error again, raise a thread at ${buildTerminalLink('https://go.atlassian.com/cdac-connect-forge')}.`,
+                concurrentSync: `Install has failed due to a background syncing clash. Try installing your app again in 10 minutes. If you see this error again, raise a thread at ${go('cdac-connect-forge')}.`,
                 placeholderMacroCollision: 'Confluence macro key is already used by another app. Macro keys must be globally unique. Prefixing with your app.key name ensures compatibility with other apps.',
                 placeholderFailedDescriptorValidation: 'One or more connectModules are defined incorrectly in your manifest.yml. Check the module definitions and deploy before trying again.'
             }
@@ -1029,7 +1032,7 @@ ${buildTerminalLink(link)}\n`,
             fileServed: (filename, resourceKey) => `Serving file ${filename} for resource ${resourceKey}`,
             fileProxied: (filename, resourceKey, tunnelPort) => `Received proxy request. ${exports.Text.tunnel.customUI.fileServed(filename, resourceKey)} from specified address http://localhost:${tunnelPort}`,
             warning: {
-                cspViolation: (localUrl, violation) => `CSP violation detected for '${violation}' while serving content at ${localUrl}\nFor an app to share data with external resources or use custom CSP, follow the steps in: https://go.atlassian.com/forge-content-security-and-egress-controls\n`
+                cspViolation: (localUrl, violation) => `CSP violation detected for '${violation}' while serving content at ${localUrl}\nFor an app to share data with external resources or use custom CSP, follow the steps in: ${go('forge-content-security-and-egress-controls')}\n`
             }
         },
         container: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "8.5.0-next.6",
+  "version": "8.5.0-next.7",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",