Merge pull request #12 from salesforcecli/jshackell-message-review

review messages for new generate commands

Author: mshanemc

messages/generate.event.md

@@ -1,21 +1,21 @@
 # summary
 
-Generate local metadata for a platform event
+Generate metadata source files for a new platform event.
 
 # description
 
-Interactively generate local metadata for a platform object
+This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the event's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other event properties, such as its API name.
 
 # flags.label.summary
 
-The label of the event.
+The platform event's label.
 
 # examples
 
-- Create an platform event with the given
+- Create a platform event with the specified label:
 
-<%= config.bin %> <%= command.id %> --label "Platform Evt"
+  <%= config.bin %> <%= command.id %> --label "My Platform Event"
 
 # prompts.publishBehavior
 
-Should events publish after a transaction completes, or immediately
+Do you want platform events to publish after a transaction completes, or immediately?

messages/generate.field.md

@@ -1,78 +1,80 @@
 # summary
 
-Generate local metadata for a custom field on
+Generate metadata source files for a new custom field on a specified object.
 
 # description
 
-Interactively generate local metadata for a custom field. This requires that the custom object you're adding the field to be present locally
+This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the field's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other field properties, such as its API name.
+
+You can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the source files for the object must already exist in your local project before you run this command. If you create a relationship field, the source files for the parent object must also exist in your local directory.  Use the command "sf metadata retrieve -m CustomObject:<object>" to retrieve source files for both standard and custom objects from your org.  To create a custom object, run the "sf generate metadata sobject" command or use the Object Manager UI in your Salesforce org.
 
 # flags.label.summary
 
-The label of the field.
+The field's label.
 
 # flags.object.summary
 
-The directory of the object folder
+The directory that contains the object's source files.
 
 # flags.object.description
 
-The directory of object you're adding the field to. Include **c if the object is custom. For example, `force-app/main/default/objects/MyObj**c`
+The object source files in your local project are grouped in a directoy with the same name as the object. Custom object names always end in "__c". An example of the object directory for the Account standard object is "force-app/main/default/objects/Account" An example custom object directory is "force-app/main/default/objects/MyObject__c"
 
-If not provided, the command will prompt you to choose from your local objects.
+If you don't specify this flag, the command prompts you to choose from your local objects.
 
 # examples
 
-- Create a field with a given Label (you'll be prompted to choose an object)
+- Create a field with the specified label; the command prompts you for the object:
 
-<%= config.bin %> <%= command.id %> --label "My Field"
+  <%= config.bin %> <%= command.id %> --label "My Field"
 
-- Specify a local path to the object's folder
+- Specify the local path to the object's folder:
 
-<%= config.bin %> <%= command.id %> --label "My Field" -o force-app/main/default/objects/MyObj\_\_c
+  <%= config.bin %> <%= command.id %> --label "My Field" --object force-app/main/default/objects/MyObject__c
 
 # prompts.type
 
-Field type
+Field type:
 
 # prompts.startingNumber
 
-Starting number
+Starting number:
 
 # prompts.defaultValue
 
-Default checkbox value
+Default checkbox value:
 
 # prompts.scale
 
-How many decimal places
+Number of decimal places:
 
 # prompts.precision
 
-How many total digits, including those decimal places
+Total number of digits, including the decimal places:
 
 # prompts.inlineHelpText
 
-User-facing help text (for those bubbles on the record page)
+Help text (the text displayed when users hover over the Info icon next to this field):
 
 # prompts.required
 
-Require at the database level on every records (consider requiring on layouts instead!)
+Does this field always require a value in order to save a record? (Tip: consider using layouts instead to require a value)
 
 # prompts.externalId
 
-Use this field as an external ID
+Should this field be set as the unique record identifier from an external system?
 
 # prompts.securityClassification
 
-Security Classification (how sensitive is this field's content
+Security classification (how sensitive is this field's content):
 
 # error.bigObjects
 
-This command does not support big objects.
+This command doesn't support big objects.
 
 # error.cmdt
 
-This command does not support Custom Metadata Types
+This command doesn't support custom metadata types.
 
 # success
 

messages/generate.object.md

@@ -1,45 +1,58 @@
 # summary
 
-Generate local metadata for a custom object
+Generate metadata source files for a new custom object.
 
 # description
 
-Interactively generate local metadata for a custom object
+This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the object's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other object properties, such as its API name and plural label.
+
+All Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of the Name field. Run the "sf metadata generate field" command to create additional fields for the object.
+
+To reduce the number of prompts, use the "--use-default-features" flag to automatically enable some features, such as reporting and search on the object.
 
 # flags.label.summary
 
-The label of the object.
+The custom object's label.
 
 # flags.use-default-features.summary
 
 Enable all optional features without prompting.
 
 # flags.use-default-features.description
 
-Enables search, feeds, reports, history, activities, bulk API, sharing, and streaming API.
+Enables these features:
+
+* Search: Allows users to find the custom object's records when they search, including SOSL.
+* Feeds: Enables feed tracking.
+* Reports: Allows reporting of the data in the custom object records.
+* History: Enables object history tracking.
+* Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.
+* Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.
+* Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.
+* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
 
 # examples
 
-- Create an object with a given Label and be prompted for additional information
+- Create a custom object with the specified label and be prompted for additional information:
 
-<%= config.bin %> <%= command.id %> --label "My Object"
+  <%= config.bin %> <%= command.id %> --label "My Object"
 
-- Create an object and opt in to most defaults (see flag help for details)
+- Create a custom object and enable optional features without prompting:
 
-<%= config.bin %> <%= command.id %> --label "My Object" --use-default-features
+  <%= config.bin %> <%= command.id %> --label "My Object" --use-default-features
 
 # success
 
-Created %s
+Created %s.
 
 # success.advice
 
-If you deploy the file to a source-tracking org, you will want to retrieve the result since additional properties and defaults will be created in the org
+The first time you deploy your new custom object to a source-tracking org, the org creates additional properties and sets new defaults on it. For this reason, we recommend that you immediately retrieve the custom object so your local source files are updated with this new information.
 
 # success.field
 
-Add a field with <%= config.bin %> generate metadata field -o %s -l "Your Field"
+Run this command to add a field to your object: sf generate metadata field --object %s --label "Your Field"
 
 # prompts.sharingModel
 
-Org wide sharing model
+Org-wide sharing model (default access level for the object's records):

messages/generate.tab.md

@@ -1,30 +1,38 @@
 # summary
 
-Generate a tab for a custom object.
+Generate the metadata source files for a new custom tab on a custom object.
 
 # description
 
-Description of a command.
+Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as an item in the app’s navigation bar and in the App Launcher.
+
+This command must be run in a Salesforce DX project directory. You must pass all required information to it with the required flags. The source files for the custom object for which you're generating a tab don't need to exist in your local project.
 
 # flags.object.summary
 
-API name of the object to generate a tab for.
+API name of the custom object you're generating a tab for.
 
 # flags.object.description
 
-API name of the object to generate a tab for. Custom objects should end in \_\_c. The object need not be present in your local source.
+The API name for a custom object always ends in "__c", such as "MyObject__c".
 
 # flags.directory.summary
 
-Path to a `tabs` folder that your new tab will be created in.
+Path to a "tabs" directory that will contain the source files for your new tab.
 
 # flags.icon.summary
 
-An icon number from <https://lightningdesignsystem.com/icons/#custom> from 1 to 100'
+Number from 1 to 100 that specifies the color scheme and icon for the custom tab.
+
+# flags.icon.description
+
+See https://lightningdesignsystem.com/icons/\#custom for the available icons.
 
 # examples
 
-- <%= config.bin %> <%= command.id %> -o MyObj\_\_c -i 54 -d force-app/main/default/tabs
+- Create a tab on the MyObject__c custom object:
+
+  <%= config.bin %> <%= command.id %> --object MyObject__c --icon 54 --directory force-app/main/default/tabs
 
 # success
 

messages/prompts.relationship.md

@@ -1,27 +1,27 @@
 # objectPrompt
 
-Which object will be the parent object for this field?
+What is the parent object for this relationship field?
 
 # lookupDeleteConstraint
 
-What happens to this field when the parent is deleted
+What happens to this field when the parent is deleted?
 
 # lookupDeleteConstraint.setNull
 
-If the parent record is deleted, the lookup field is cleared.
+Clear the value of this field.
 
 # lookupDeleteConstraint.restrict
 
-Prevent the parent record from being deleted if there are lookups that refer to it
+Don't allow the parent record from being deleted if there are lookup fields that refer to it.
 
 # lookupDeleteConstraint.cascade
 
-Deletes the lookup record as well as associated lookup fields
+Delete the lookup record and the associated lookup fields.
 
 # writeRequiresMasterRead
 
-Allow write access if parent is readable
+Allow write access if the parent is readable?
 
 # reparentableMasterDetail
 
-Allow reparenting
+Allow reparenting to a different parent record?

messages/prompts.shared.md

@@ -1,51 +1,51 @@
 # directory
 
-Where should this new object be created
+Which local directory do you want to store the source files for this new object?
 
 # pluralLabel
 
-Plural label
+Plural label:
 
 # apiName
 
-API name
+API name (custom objects and fields must end in "__c" and platform events in "__e"):
 
 # description
 
-Description (be kind to your future self or successors!)
+Description (great developers write great descriptions):  
 
 # error.noDescription
 
-Please enter a description
+Please enter a description. Your future self and others will thank you.
 
 # nameFieldPrompts.label
 
-What should the Name field be called
+What do you want to call the required Name field?
 
 # nameFieldPrompts.type
 
-Is the name field autonumber or text
+What's the type of the required Name field?
 
 # nameFieldPrompts.autoNumberFormat
 
-AutoNumber format
+Auto number format:
 
 # object
 
-What object is this field for
+Which object is this new field for?
 
 # picklist.first
 
-Add your default picklist value first
+Enter the first picklist value, which will also be the default: 
 
 # picklist.additional
 
-Enter the next picklist value, or press RETURN to stop adding picklist values
+Enter the next picklist value, or press RETURN to stop adding picklist values.
 
 # numberValidationMin
 
-%s is too low. Minimum is %s
+%s is too low. Minimum value is %s.
 
 # numberValidationMax
 
-%s is too high. Maximum is %s
+%s is too high. Maximum value is %s.

src/commands/generate/metadata/field.ts

@@ -131,7 +131,7 @@ export default class FieldGenerate extends SfCommand<FieldGenerateResult> {
         },
         // AutoNumber
         {
-          type: 'list',
+          type: 'number',
           message: messages.getMessage('prompts.startingNumber'),
 
           validate: (n: number) => integerValidation(n, 0, Number.MAX_SAFE_INTEGER),
@@ -223,7 +223,7 @@ export default class FieldGenerate extends SfCommand<FieldGenerateResult> {
           default: false,
         },
         {
-          type: 'choice',
+          type: 'list',
           message: messages.getMessage('prompts.securityClassification'),
           name: 'securityClassification',
           choices: ['Public', 'Internal', 'Confidential', 'Restricted', 'Mission Critical'],

src/commands/generate/metadata/sobject.ts

@@ -116,7 +116,7 @@ export default class ObjectGenerate extends SfCommand<CustomObjectGenerateResult
     const writePath = await writeObjectFile(directory, resultsObject);
     this.logSuccess(messages.getMessage('success', [writePath]));
     this.info(messages.getMessage('success.field', [dirname(writePath)]));
-    this.info(messages.getMessage('success.advice'));
+    this.log();
     this.info(messages.getMessage('success.advice'));
     return { object: resultsObject, path: writePath };
   }