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

Text updates to command descriptions and product names #4660

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions packages/@ionic/cli/src/commands/cordova/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ export class BuildCommand extends CordovaCommand implements CommandPreRun {
return {
name: 'build',
type: 'project',
summary: 'Build (prepare + compile) an Ionic project for a given platform',
summary: 'Use Cordova to build for Android and iOS platform targets',
description: `
Like running ${input('cordova build')} directly, but also builds web assets with configuration from ${input('ionic build')} and provides friendly checks.
Like running ${input('cordova build')} directly, ${input('ionic cordova build')} also builds web assets from ${input('ionic build')} and provides friendly checks for Android and iOS platforms.

To pass additional options to the Cordova CLI, use the ${input('--')} separator after the Ionic CLI arguments.

Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/deploy/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export class BuildCommand extends Command {
groups: [MetadataGroup.PAID],
summary: 'Create a deploy build on Appflow',
description: `
This command creates a deploy build on Ionic Appflow. While the build is running, it prints the remote build log to the terminal. If the build is successful, it downloads the created web build zip file in the current directory.
This command creates a deploy build on Appflow. While the build is running, it prints the remote build log to the terminal. If the build is successful, it downloads the created web build zip file in the current directory.

Customizing the build:
- The ${input('--environment')} and ${input('--channel')} options can be used to customize the groups of values exposed to the build.
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/deploy/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export class DeployNamespace extends Namespace {
name: 'deploy',
summary: 'Appflow Deploy functionality',
description: `
These commands integrate with Ionic Appflow to configure the deploy plugin in your project and run remote builds.
These commands integrate with Appflow to configure the deploy plugin in your project and run remote builds.

Appflow deploy documentation:
- Overview: ${strong('https://ion.link/appflow-deploy-docs')}
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class GenerateCommand extends Command implements CommandPreRun {
return {
name: 'generate',
type: 'project',
summary: 'Automatically create framework features',
summary: 'Create Pages, Components, & Angular Features',
description,
footnotes,
inputs,
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/git/clone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export class GitCloneCommand extends Command {
inputs: [
{
name: 'id',
summary: 'The ID of the Ionic Appflow app to clone',
summary: 'The ID of the Appflow app to clone',
validators: [validators.required],
},
{
Expand Down
4 changes: 2 additions & 2 deletions packages/@ionic/cli/src/commands/git/remote.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ export class GitRemoteCommand extends Command {
name: 'remote',
type: 'project',
groups: [MetadataGroup.PAID],
summary: 'Adds/updates the Ionic Appflow git remote to your local Ionic app',
summary: 'Adds/updates the Appflow git remote to your local Ionic app',
description: `
This command is used by ${input('ionic link')} when Ionic Appflow is used as the git host.
This command is used by ${input('ionic link')} when Appflow is used as the git host.

${input('ionic git remote')} will check the local repository for whether or not the git remote is properly set up. This command operates on the ${strong('ionic')} remote. For advanced configuration, see ${strong('Settings')} => ${strong('Git')} in the app settings of the Dashboard[^dashboard].
`,
Expand Down
28 changes: 14 additions & 14 deletions packages/@ionic/cli/src/commands/link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ export class LinkCommand extends Command implements CommandPreRun {
groups: [MetadataGroup.PAID],
summary: 'Connect local apps to Ionic',
description: `
Link apps on Ionic Appflow to local Ionic projects with this command.
Link apps on Appflow to local Ionic projects with this command.

If the ${input('id')} argument is excluded, this command will prompt you to select an app from Ionic Appflow.
If the ${input('id')} argument is excluded, this command will prompt you to select an app from Appflow.

Ionic Appflow uses a git-based workflow to manage app updates. During the linking process, select ${strong('GitHub')} (recommended) or ${strong('Ionic Appflow')} as a git host. See our documentation[^appflow-git-basics] for more information.
Appflow uses a git-based workflow to manage app updates. During the linking process, select ${strong('GitHub')} (recommended) or ${strong('Appflow')} as a git host. See our documentation[^appflow-git-basics] for more information.

Ultimately, this command sets the ${strong('id')} property in ${strong(prettyPath(projectFile))}, which marks this app as linked.

Expand All @@ -61,7 +61,7 @@ If you are having issues linking, please get in touch with our Support[^support-
inputs: [
{
name: 'id',
summary: `The Ionic Appflow ID of the app to link (e.g. ${input('a1b2c3d4')})`,
summary: `The Appflow ID of the app to link (e.g. ${input('a1b2c3d4')})`,
},
],
options: [
Expand All @@ -72,13 +72,13 @@ If you are having issues linking, please get in touch with our Support[^support-
},
{
name: 'create',
summary: 'Create a new app on Ionic Appflow and link it with this local Ionic project',
summary: 'Create a new app on Appflow and link it with this local Ionic project',
type: Boolean,
groups: [MetadataGroup.HIDDEN],
},
{
name: 'pro-id',
summary: 'Specify an app ID from the Ionic Appflow to link',
summary: 'Specify an app ID from the Appflow to link',
groups: [MetadataGroup.DEPRECATED, MetadataGroup.HIDDEN],
spec: { value: 'id' },
},
Expand Down Expand Up @@ -141,11 +141,11 @@ If you are having issues linking, please get in touch with our Support[^support-
if (!id && !create) {
const choices = [
{
name: `Link ${idFromConfig ? 'a different' : 'an existing'} app on Ionic Appflow`,
name: `Link ${idFromConfig ? 'a different' : 'an existing'} app on Appflow`,
value: CHOICE_LINK_EXISTING_APP,
},
{
name: 'Create a new app on Ionic Appflow',
name: 'Create a new app on Appflow',
value: CHOICE_CREATE_NEW_APP,
},
];
Expand Down Expand Up @@ -186,7 +186,7 @@ If you are having issues linking, please get in touch with our Support[^support-
const confirm = await this.env.prompt({
type: 'confirm',
name: 'confirm',
message: `No apps found. Would you like to create a new app on Ionic Appflow?`,
message: `No apps found. Would you like to create a new app on Appflow?`,
});

if (!confirm) {
Expand Down Expand Up @@ -271,7 +271,7 @@ If you are having issues linking, please get in touch with our Support[^support-
this.env.log.nl();

this.env.log.info(
`Ionic Appflow uses a git-based workflow to manage app updates.\n` +
`Appflow uses a git-based workflow to manage app updates.\n` +
`You will be prompted to set up the git host and repository for this new app. See the docs${ancillary('[1]')} for more information.\n\n` +
`${ancillary('[1]')}: ${strong('https://ion.link/appflow-git-basics')}`
);
Expand All @@ -288,7 +288,7 @@ If you are having issues linking, please get in touch with our Support[^support-
value: CHOICE_GITHUB,
},
{
name: 'Ionic Appflow',
name: 'Appflow',
value: CHOICE_IONIC,
},
// TODO: option to skip git setup for now
Expand Down Expand Up @@ -323,7 +323,7 @@ If you are having issues linking, please get in touch with our Support[^support-

if (githubUrl) {
this.env.log.info(
`You can now push to one of your branches on GitHub to trigger a build in Ionic Appflow!\n` +
`You can now push to one of your branches on GitHub to trigger a build in Appflow!\n` +
`If you haven't added GitHub as your origin you can do so by running:\n\n` +
`${input('git remote add origin ' + githubUrl)}\n\n` +
`You can find additional links above to help if you're having issues.`
Expand Down Expand Up @@ -382,7 +382,7 @@ If you are having issues linking, please get in touch with our Support[^support-
this.env.log.nl();
this.env.log.info(
`GitHub OAuth setup required.\n` +
`To continue, we need you to authorize Ionic Appflow with your GitHub account. ` +
`To continue, we need you to authorize Appflow with your GitHub account. ` +
`A browser will open and prompt you to complete the authorization request. ` +
`When finished, please return to the CLI to continue linking your app.`
);
Expand Down Expand Up @@ -542,7 +542,7 @@ If you are having issues linking, please get in touch with our Support[^support-

async selectGithubBranches(repoId: number): Promise<string[]> {
this.env.log.nl();
this.env.log.info(strong(`By default Ionic Appflow links only to the ${input('master')} branch.`));
this.env.log.info(strong(`By default Appflow links only to the ${input('master')} branch.`));
this.env.log.info(
`${strong('If you\'d like to link to another branch or multiple branches you\'ll need to select each branch to connect to.')}\n` +
`If you're not familiar with on working with branches in GitHub you can read about them here:\n\n` +
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/monitoring/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export class MonitoringNamespace extends Namespace {

return {
name: 'monitoring',
summary: 'Commands relating to Ionic Appflow Error Monitoring',
summary: 'Commands relating to Appflow Error Monitoring',
groups,
};
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/monitoring/syncmaps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export class MonitoringSyncSourcemapsCommand extends Command {
return {
name: 'syncmaps',
type: 'project',
summary: 'Build & upload sourcemaps to Ionic Appflow Monitoring service',
summary: 'Build & upload sourcemaps to Appflow Monitoring service',
description: `
By default, ${input('ionic monitoring syncmaps')} will upload the sourcemap files within ${strong(SOURCEMAP_DIRECTORY)}. To optionally perform a production build before uploading sourcemaps, specify the ${input('--build')} flag.
`,
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/package/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export class BuildCommand extends Command {
groups: [MetadataGroup.PAID],
summary: 'Create a package build on Appflow',
description: `
This command creates a package build on Ionic Appflow. While the build is running, it prints the remote build log to the terminal. If the build is successful, it downloads the created app package file in the current directory.
This command creates a package build on Appflow. While the build is running, it prints the remote build log to the terminal. If the build is successful, it downloads the created app package file in the current directory.

Apart from ${input('--commit')}, every option can be specified using the full name setup within the Dashboard[^dashboard].

Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/package/deploy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export class DeployCommand extends Command {
groups: [MetadataGroup.PAID],
summary: 'Deploys a binary to a destination, such as an app store using Appflow',
description: `
This command deploys a binary to a destination using Ionic Appflow. While running, the remote log is printed to the terminal.
This command deploys a binary to a destination using Appflow. While running, the remote log is printed to the terminal.

The command takes two parameters: the numeric ID of the package build that previously created the binary and the name of the destination where the binary is going to be deployed.
Both can be retrieved from the Dashboard[^dashboard].
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/package/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export class PackageNamespace extends Namespace {
name: 'package',
summary: 'Appflow package functionality',
description: `
Interface to execute commands about package builds and deployments on Ionic Appflow.
Interface to execute commands about package builds and deployments on Appflow.

Appflow package documentation:
- Overview: ${strong('https://ion.link/appflow-package-docs')}
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/commands/start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ Use the ${input('--type')} option to start projects using older versions of Ioni
];

if (linkConfirmed) {
steps.push(`Push your code to Ionic Appflow to perform real-time updates, and more: ${input('git push ionic master')}`);
steps.push(`Push your code to Appflow to perform real-time updates, and more: ${input('git push ionic master')}`);
}

this.env.log.msg(`${strong('Your Ionic app is ready! Follow these next steps')}:\n${steps.map(s => ` - ${s}`).join('\n')}`);
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export async function generateIonicEnvironment(ctx: IonicContext, pargv: string[
if (project.config.get('pro_id' as any) && argv._[1] !== 'unset') {
log.warn(
`The ${input('pro_id')} field in ${strong(prettyPath(project.filePath))} has been deprecated.\n` +
`Ionic Pro has been renamed to Ionic Appflow! We've copied the value in ${input('pro_id')} to ${input('id')}, but you may want to unset the deprecated property: ${input('ionic config unset pro_id')}\n`
`Ionic Pro has been renamed to Appflow! We've copied the value in ${input('pro_id')} to ${input('id')}, but you may want to unset the deprecated property: ${input('ionic config unset pro_id')}\n`
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/lib/project/angular/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export class AngularGenerateRunner extends GenerateRunner<AngularGenerateOptions
async getCommandMetadata(): Promise<Partial<CommandMetadata>> {
return {
description: `
This command uses the Angular CLI to generate features such as ${['pages', 'components', 'directives', 'services'].map(c => input(c)).join(', ')}, etc.
Automatically create framework features with Ionic Generate. This command uses the Angular CLI to generate ${['pages', 'components', 'directives', 'services'].map(c => input(c)).join(', ')}, and more.

- For a full list of available types, use ${input('npx ng g --help')}
- For a list of options for a types, use ${input('npx ng g <type> --help')}
Expand Down
2 changes: 1 addition & 1 deletion packages/@ionic/cli/src/lib/start.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ function getAppflowAdvertisement(): string {
return `
──────────────────────────────────────────────────────────────

${title('Ionic Appflow')}, the mobile DevOps solution by Ionic
${title('Appflow')}, the mobile DevOps solution by Ionic

Continuously build, deploy, and ship apps ${emoji('🚀', '')}
Focus on building apps while we automate the rest ${emoji('🎁', '')}
Expand Down