Merge pull request #546 from salesforcecli/js/sf-ify-messages

Js/sf ify messages

Author: WillieRuemmele

messages/convert.mdapi.md

@@ -1,64 +1,52 @@
 # summary
 
-convert metadata from the Metadata API format into the source format
+Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
 
 # description
 
-Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
+To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.
 
-To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using "sfdx force:mdapi:convert".
-
-To convert files from the source format back to the metadata format, so that you can deploy them using "<%= config.bin %> project deploy", run "<%= config.bin %> project convert source".
+To convert files from the source format back to the metadata format, run "<%= config.bin %> project convert source".
 
 # examples
 
-- $ <%= config.bin %> <%= command.id %> -r path/to/metadata
-
-- $ <%= config.bin %> <%= command.id %> -r path/to/metadata -d path/to/outputdir
-
-# flags.root-dir
-
-the root directory containing the Metadata API–formatted metadata
-
-# flags.output-dir
-
-the output directory to store the source–formatted files
+- Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:
 
-# flags.manifest
+  $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata
 
-file path to manifest (package.xml) of metadata types to convert.
+- Similar to previous example, but writes converted files to the specified output directory:
 
-# flags.metadata-dir
+  $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
 
-comma-separated list of metadata file paths to convert
+# flags.root-dir.summary
 
-# flags.metadata
+Root directory that contains the Metadata API–formatted metadata.
 
-comma-separated list of metadata component names to convert
+# flags.output-dir.summary
 
-# flagsLong.root-dir
+Directory to store your files in after they’re converted to source format; can be an absolute or relative path.
 
-The root directory that contains the metadata you retrieved using Metadata API.
+# flags.manifest.summary
 
-# flagsLong.output-dir
+File path to manifest (package.xml) of metadata types to convert.
 
-The directory to store your files in after they’re converted to the source format. Can be an absolute or relative path.
+# flags.metadata-dir.summary
 
-# flagsLong.manifest
+Comma-separated list of paths to the local metadata files to convert.
 
-- The complete path to the manifest (package.xml) file that specifies the metadata types to convert.
+# flags.metadata.summary
 
-- If you specify this parameter, don’t specify --metadata or --source-dir.
+Comma-separated list of metadata component names to convert.
 
-# flagsLong.metadata-dir
+# flags.manifest.description
 
-- A comma-separated list of paths to the local metadata files to convert. The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
+If you specify this parameter, don’t specify --metadata or --source-dir.
 
-- If you specify this parameter, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.
+# flags.metadata-dir.description
 
-# flagsLong.metadata
+The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
 
-A comma-separated list of metadata component names to convert.
+If you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.
 
 # expectedDirectory
 

messages/convert.source.md

@@ -1,59 +1,58 @@
 # summary
 
-convert source into Metadata API format
+Convert source-formatted files into metadata that you can deploy using Metadata API.
 
 # description
 
-convert source into Metadata API format
-Converts source-formatted files into metadata that you can deploy using Metadata API.
-To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API,
-run "<%= config.bin %> project convert mdapi". Then deploy the metadata using "<%= config.bin %> project deploy".
+To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "<%= config.bin %> project deploy".
 
 To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi".
 
 To specify a package name that includes spaces, enclose the name in single quotes.
 
 # examples
 
-- $ <%= config.bin %> <%= command.id %> -r path/to/source
+- Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
 
-- $ <%= config.bin %> <%= command.id %> -r path/to/source -d path/to/outputdir -n 'My Package'
+  $ <%= config.bin %> <%= command.id %> --root-dir path/to/source
 
-# flags.root-dir
+- Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:
 
-a source directory other than the default package to convert
+  $ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
 
-# flags.output-dir
+# flags.root-dir.summary
 
-output directory to store the Metadata API–formatted files in
+Source directory other than the default package to convert.
 
-# flags.package-name
+# flags.output-dir.summary
 
-name of the package to associate with the metadata-formatted files
+Output directory to store the Metadata API–formatted files in.
 
-# flags.manifest
+# flags.package-name.summary
 
-file path to manifest (package.xml) of metadata types to convert.
+Name of the package to associate with the metadata-formatted files.
 
-# flags.source-dir
+# flags.manifest.summary
 
-comma-separated list of paths to the local source files to convert
+Path to the manifest (package.xml) file that specifies the metadata types to convert.
 
-# flags.metadata
+# flags.source-dir.summary
 
-comma-separated list of metadata component names to convert
+Comma-separated list of paths to the local source files to convert.
 
-# flagsLong.manifest
+# flags.metadata.summary
 
-- The complete path to the manifest (package.xml) file that specifies the metadata types to convert.
+Comma-separated list of metadata component names to convert.
 
-- If you specify this parameter, don’t specify --metadata or --source-dir.
+# flags.manifest.description
 
-# flagsLong.source-dir
+If you specify this parameter, don’t specify --metadata or --source-dir.
 
-- A comma-separated list of paths to the local source files to convert. The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
+# flags.source-dir.description
 
-- If you specify this parameter, don’t specify --manifest or --metadata.
+The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
+
+If you specify this parameter, don’t specify --manifest or --metadata.
 
 # success
 

messages/delete.source.md

@@ -1,98 +1,110 @@
 # summary
 
-delete source from your project and from a non-source-tracked org.
+Delete source from your project and from a non-source-tracked org.
 
 # description
 
-delete source from your project and from a non-source-tracked org
-IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
+Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "sf project deploy start".
 
-Use this command to delete components from orgs that don’t have source tracking.
-To remove deleted items from scratch orgs, which have change tracking, use "sf project deploy start".
+When you run this command, both the local source file and the metadata component in the org are deleted.
 
 # examples
 
-- $ <%= config.bin %> <%= command.id %> -m <metadata>
+- Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
 
-- $ <%= config.bin %> <%= command.id %> -p path/to/source
+  <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
 
-# flags.source-dir
+- Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:
 
-comma-separated list of source file paths to delete
+  <%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
 
-# flags.metadata
+- Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:
 
-comma-separated list of names of metadata components to delete
+  <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
 
-# flags.no-prompt
+- Delete the Apex source files in a directory and the corresponding components from your default org:
 
-do not prompt for delete confirmation
+  <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes
 
-# flags.wait
+- Delete all components listed in a manifest:
 
-wait time for command to finish in minutes
+  <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
 
-# flags.check-only
+# flags.source-dir.summary
 
-validate delete command but do not delete from the org or delete files locally
+Comma-separated list of source file paths to delete.
 
-# flags.test-Level
+# flags.metadata.summary
 
-deployment testing level
+Comma-separated list of names of metadata components to delete.
 
-# flags.track-source
+# flags.no-prompt.summary
 
-If the delete succeeds, update the source tracking information, similar to push
+Don't prompt for delete confirmation.
 
-# flags.force-overwrite
+# flags.wait.summary
 
-ignore conflict warnings and overwrite changes to the org
+Number of minutes to wait for the command to finish.
 
-# flags.verbose
+# flags.check-only.summary
 
-verbose output of delete result
+Validate delete command but don't delete anything from the org or the local project.
 
-# flagsLong.check-only
+# flags.test-Level.summary
 
-- Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
+Deployment Apex testing level.
 
-- If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --chec-konly parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
+# flags.track-source.summary
 
-- If your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.
+If the delete succeeds, update the source tracking information.
 
-- Note: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.
+# flags.force-overwrite.summary
 
-- 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.
+Ignore conflict warnings and overwrite changes to the org.
 
-- 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.
+# flags.verbose.summary
 
-# flagsLong.metadata
+Verbose output of the delete result.
 
-- A comma-separated list of names of metadata components to delete from your project and your org.
+# flags.check-only.description
 
-- If you specify this parameter, don’t specify --source-dir.
+IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
 
-# flagsLong.source-dir
+Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
 
-- A comma-separated list of paths to the local metadata to delete. The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
+If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --chec-konly parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
 
-- If you specify this parameter, don’t specify --metadata.
+If your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.
 
-# flagsLong.wait
+Note: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.
 
-Number of minutes to wait for the command to complete and display results to the terminal window. If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+    1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.
 
-# flagsLong.test-Level
+    2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.
 
-- Specifies which level of deployment tests to run. Valid values are:
+# flags.metadata.description
 
-- NoTestRu — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
+If you specify this parameter, don’t specify --source-dir.
 
-- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
+# flags.source-dir.description
+
+The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
+
+If you specify this parameter, don’t specify --metadata.
 
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+
+# flags.test-Level.description
+
+Valid values are:
+
+- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
+- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
 - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
 
-- If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
+If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
 
 # localPrompt
 

messages/delete.tracking.md

@@ -1,29 +1,34 @@
-# resetDescription
+# resetSummary
+
+Reset local and remote source tracking.
 
-reset local and remote source tracking
+# resetDescription
 
 WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
 
-Resets local and remote source tracking so that the CLI no longer registers differences between your local files and those in the org. When you next run force:source:status, the CLI returns no results, even though conflicts might actually exist. The CLI then resumes tracking new source changes as usual.
+Resets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.
 
-Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the force:data:soql:query command. For example:
-$ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t
+Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
 
-# deleteDescription
+<%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api
 
-delete all local source tracking information
+# deleteSummary
+
+Delete all local source tracking information.
+
+# deleteDescription
 
 WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
 
-Deletes all local source tracking information. When you next run 'project deploy preview', the CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.
+Deletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.
 
-# no-promptDescription
+# flags.no-prompt.summary
 
-do not prompt for source tracking override confirmation
+Don't prompt for source tracking override confirmation.
 
-# revisionDescription
+# flags.revision.summary
 
-reset to a specific SourceMember revision counter number
+SourceMember revision counter number to reset to.
 
 # promptMessage