From f913498b49ab0657c84e6e78ad429b68a7de1904 Mon Sep 17 00:00:00 2001 From: Willie Ruemmele Date: Wed, 11 Aug 2021 12:43:54 -0600 Subject: [PATCH] fix: update command long descriptions --- messages/cancel.json | 7 +++---- messages/convert.json | 2 +- messages/deploy.json | 24 ++++++++++++------------ messages/open.json | 2 +- messages/report.json | 2 +- messages/retrieve.json | 22 +++++++++++----------- 6 files changed, 29 insertions(+), 30 deletions(-) diff --git a/messages/cancel.json b/messages/cancel.json index 0eb8b4254..59075dcf9 100644 --- a/messages/cancel.json +++ b/messages/cancel.json @@ -1,9 +1,8 @@ { - "description": "cancel a source deployment", + "description": "cancel a source deployment\n Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes) to check for updates to the canceled deploy status.\n\nTo run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI.\nTo check the status of the job, use force:source:deploy:report.", "examples": [ - "$ sfdx force:source:deploy:cancel", - "$ sfdx force:source:deploy:cancel -w 2", - "$ sfdx force:source:deploy:cancel -i " + "Deploy a directory of files to the org\n $ sfdx force:source:deploy -d \nNow cancel this deployment and wait two minutes\n $ sfdx force:source:deploy:cancel -w 2", + "If you have multiple deployments in progress and want to cancel a specific one, specify the job ID\n $ sfdx force:source:deploy:cancel -i \nCheck the status of the cancel job\n $ sfdx force:source:deploy:report" ], "flags": { "wait": "wait time for command to finish in minutes", diff --git a/messages/convert.json b/messages/convert.json index 72c8d2a3a..99756fc3d 100644 --- a/messages/convert.json +++ b/messages/convert.json @@ -1,5 +1,5 @@ { - "description": "convert source into Metadata API format", + "description": "convert source into Metadata API format \n Converts source-formatted files into metadata that you can deploy using Metadata API. \nTo convert source-formatted files into the metadata format, so that you can deploy them using Metadata API,\nrun \"sfdx force:source:convert\". Then deploy the metadata using \"sfdx force:mdapi:deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"sfdx force:mdapi:convert\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.", "examples": [ "$ sfdx force:source:convert -r path/to/source", "$ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package'" diff --git a/messages/deploy.json b/messages/deploy.json index 7f895c508..2b0dbfbb9 100644 --- a/messages/deploy.json +++ b/messages/deploy.json @@ -1,17 +1,17 @@ { - "description": "deploy source to an org", + "description": "deploy source to an org Use this command to deploy source (metadata that’s in source format) to an org.\nTo take advantage of change tracking with scratch orgs, use \"sfdx force:source:push\".\nTo deploy metadata that’s in metadata format, use \"sfdx force:mdapi:deploy\".\n\nThe source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your source with the versions in your org.\n\nTo run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI.\nTo check the status of the job, use force:source:deploy:report.\n\nIf the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes.\n", "examples": [ - "$ sfdx force:source:deploy -p path/to/source", - "$ sfdx force:source:deploy -p \"path/to/apex/classes/MyClass.cls,path/to/source/objects\"", - "$ sfdx force:source:deploy -p \"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes\"", - "$ sfdx force:source:deploy -m ApexClass", - "$ sfdx force:source:deploy -m ApexClass:MyApexClass", - "$ sfdx force:source:deploy -m \"CustomObject,ApexClass\"", - "$ sfdx force:source:deploy -m \"ApexClass, Profile:My Profile, Profile: AnotherProfile\"", - "$ sfdx force:source:deploy -x path/to/package.xml", - "$ sfdx force:source:deploy -m ApexClass -l RunLocalTests", - "$ sfdx force:source:deploy -m ApexClass -l RunAllTestsInOrg -c", - "$ sfdx force:source:deploy -q 0Af9A00000FTM6pSAH" + "To deploy the source files in a directory:\n\t $ sfdx force:source:deploy -p path/to/source", + "To deploy a specific Apex class and the objects whose source is in a directory: \n\t$ sfdx force:source:deploy -p \"path/to/apex/classes/MyClass.cls,path/to/source/objects\"", + "To deploy source files in a comma-separated list that contains spaces:\n $ sfdx force:source:deploy -p \"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes\"", + "To deploy all Apex classes:\n $ sfdx force:source:deploy -m ApexClass", + "To deploy a specific Apex class:\n $ sfdx force:source:deploy -m ApexClass:MyApexClass", + "To deploy all custom objects and Apex classes:\n $ sfdx force:source:deploy -m \"CustomObject,ApexClass\"", + "To deploy all Apex classes and two specific profiles (one of which has a space in its name):\n $ sfdx force:source:deploy -m \"ApexClass, Profile:My Profile, Profile: AnotherProfile\"", + "To deploy all components listed in a manifest:\n $ sfdx force:source:deploy -x path/to/package.xml", + "To run the tests that aren’t in any managed packages as part of a deployment:\n $ sfdx force:source:deploy -m ApexClass -l RunLocalTests", + "To check whether a deployment would succeed (to prepare for Quick Deploy):\n $ sfdx force:source:deploy -m ApexClass -l RunAllTestsInOrg -c", + "To deploy an already validated deployment (Quick Deploy):\n $ sfdx force:source:deploy -q 0Af9A00000FTM6pSAH`," ], "flags": { "sourcePath": "comma-separated list of source file paths to deploy", diff --git a/messages/open.json b/messages/open.json index 8f275cb03..0b58e04bf 100644 --- a/messages/open.json +++ b/messages/open.json @@ -1,5 +1,5 @@ { - "description": "edit a Lightning Page with Lightning App Builder\nOpens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s home page.", + "description": "edit a Lightning Page with Lightning App Builder\nOpens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, and are stored in the flexipages directory. If you specify a different type of file, this command opens your org’s home page.\n\nThe file opens in your default browser.\nIf no browser-based editor is available for the selected file, this command opens your org's home page.\nTo generate a URL for the browser-based editor but not open the editor, use --urlonly.", "examples": [ "$ sfdx force:source:open -f path/to/source", "$ sfdx force:source:open -r -f path/to/source", diff --git a/messages/report.json b/messages/report.json index 6c776f440..8ee08826e 100644 --- a/messages/report.json +++ b/messages/report.json @@ -1,5 +1,5 @@ { - "description": "check the status of a metadata deployment", + "description": "check the status of a metadata deployment \nSpecify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status.", "examples": [ "Deploy a directory of files to the org", " $ sfdx force:source:deploy -d ", diff --git a/messages/retrieve.json b/messages/retrieve.json index b6726e04f..1b83c56e6 100644 --- a/messages/retrieve.json +++ b/messages/retrieve.json @@ -1,16 +1,16 @@ { - "description": "retrieve source from an org", + "description": "retrieve source from an org \nUse this command to retrieve source (metadata that’s in source format) from an org.\nTo take advantage of change tracking with scratch orgs, use \"sfdx force:source:pull\".\nTo retrieve metadata that’s in metadata format, use \"sfdx force:mdapi:retrieve\".\n\nThe source you retrieve overwrites the corresponding source files in your local project. This command does not attempt to merge the source from your org with your local source files.\n\nIf the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes.", "examples": [ - "sfdx force:source:retrieve -p path/to/source", - "sfdx force:source:retrieve -p \"path/to/apex/classes/MyClass.cls,path/to/source/objects\"", - "sfdx force:source:retrieve -p \"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes\"", - "sfdx force:source:retrieve -m ApexClass", - "sfdx force:source:retrieve -m ApexClass:MyApexClass", - "sfdx force:source:retrieve -m \"CustomObject,ApexClass\"", - "sfdx force:source:retrieve -x path/to/package.xml", - "sfdx force:source:retrieve -n \"Package1, PackageName With Spaces, Package3\"", - "sfdx force:source:retrieve -n MyPackageName -p path/to/apex/classes", - "sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml" + "To retrieve the source files in a directory:\n $ sfdx force:source:retrieve -p path/to/source", + "To retrieve a specific Apex class and the objects whose source is in a directory:\n $ sfdx force:source:retrieve -p \"path/to/apex/classes/MyClass.cls,path/to/source/objects\"", + "To retrieve source files in a comma-separated list that contains spaces:\n $ sfdx force:source:retrieve -p \"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes", + "To retrieve all Apex classes:\n $ sfdx force:source:retrieve -m ApexClass", + "To retrieve a specific Apex class:\n $ sfdx force:source:retrieve -m ApexClass:MyApexClass", + "To retrieve all custom objects and Apex classes:\n $ sfdx force:source:retrieve -m \"CustomObject,ApexClass", + "To retrieve all Apex classes and two specific profiles (one of which has a space in its name):\n $ sfdx force:source:retrieve -m \"ApexClass, Profile:My Profile, Profile: AnotherProfile\"", + "To retrieve all metadata components listed in a manifest:\n $ sfdx force:source:retrieve -x path/to/package.xml", + "To retrieve metadata from a package or multiple packages:\n $ sfdx force:source:retrieve -n MyPackageName\n $ sfdx force:source:retrieve -n \"Package1, PackageName With Spaces, Package3\"", + "To retrieve all metadata from a package and specific components that aren’t in the package, specify both -n | --packagenames and one other scoping parameter:\n $ sfdx force:source:retrieve -n MyPackageName -p path/to/apex/classes\n $ sfdx force:source:retrieve -n MyPackageName -m ApexClass:MyApexClass\n $ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml" ], "flags": { "sourcePath": "comma-separated list of source file paths to retrieve",