@salesforce/plugin-custom-metadata 2.0.12 → 2.0.14

package/messages/field.md

@@ -6,21 +6,21 @@ Generate a field for a custom metadata type based on the provided field type.
 
 Similar to a custom object, a custom metadata type has a list of custom fields that represent aspects of the metadata.
 
-This command creates a metadata file that describes the new custom metadata type field. By default, the file is created in a "fields" directory in the current directory. Use the --output-directory to generate the file in the directory that contains the custom metadata type metdata files, such as "force-app/main/default/objects/MyCmdt\_\_mdt" for the custom metadata type called MyCmdt.
+This command creates a metadata file that describes the new custom metadata type field. By default, the file is created in a "fields" directory in the current directory. Use the --output-directory to generate the file in the directory that contains the custom metadata type metdata files, such as "force-app/main/default/objects/MyCmdt__mdt" for the custom metadata type called MyCmdt.
 
 # examples
 
-- Generate a metadata file for a custom checkbox field and add the file to the MyCmdt\_\_mdt/fields directory:
+- Generate a metadata file for a custom checkbox field and add the file to the MyCmdt__mdt/fields directory:
 
-  <%= config.bin %> <%= command.id %> --name MyCheckboxField --type Checkbox --output-directory force-app/main/default/objects/MyCmdt\_\_mdt
+  <%= config.bin %> <%= command.id %> --name MyCheckboxField --type Checkbox --output-directory force-app/main/default/objects/MyCmdt__mdt
 
 - Generate a metadata file for a custom picklist field and add a few values:
 
-  <%= config.bin %> <%= command.id %> --name MyPicklistField --type Picklist --picklist-values A --picklist-values B --picklist-values C --output-directory force-app/main/default/objects/MyCmdt\_\_mdt
+  <%= config.bin %> <%= command.id %> --name MyPicklistField --type Picklist --picklist-values A --picklist-values B --picklist-values C --output-directory force-app/main/default/objects/MyCmdt__mdt
 
 - Generate a metadata file for a custom number field and specify 2 decimal places:
 
-  <%= config.bin %> <%= command.id %> --name MyNumberField --type Number --decimal-places 2 --output-directory force-app/main/default/objects/MyCmdt\_\_mdt
+  <%= config.bin %> <%= command.id %> --name MyNumberField --type Number --decimal-places 2 --output-directory force-app/main/default/objects/MyCmdt__mdt
 
 # flags.name.summary
 

package/messages/fromorg.md

@@ -6,33 +6,33 @@ Generate a custom metadata type and all its records from a Salesforce object.
 
 Use this command to migrate existing custom objects or custom settings in an org to custom metadata types. If a field of the Salesforce object is of an unsupported type, the field type is automatically converted to text. Run "<%= config.bin %> cmdt field create --help" to see the list of supported cmdt field types, listed in the --type flag summary. Use the --ignore-unsupported to ignore these fields.
 
-This command creates the metadata files that describe the new custom metadata type and its fields in the "force-app/main/default/objects/TypeName\_\_mdt" directory by default, where "TypeName" is the value of the required --dev-name flag. Use --type-output-directory to create them in a different directory.
+This command creates the metadata files that describe the new custom metadata type and its fields in the "force-app/main/default/objects/TypeName__mdt" directory by default, where "TypeName" is the value of the required --dev-name flag. Use --type-output-directory to create them in a different directory.
 
 # examples
 
-- Generate a custom metadata type from a custom object called MySourceObject\_\_c in your default org:
+- Generate a custom metadata type from a custom object called MySourceObject__c in your default org:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\_\_c
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c
 
 - Generate a custom metadata type from a custom object in an org with alias my-scratch-org; ignore unsupported field types instead of converting them to text:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\_\_c --ignore-unsupported --target-org my-scratch-org
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --ignore-unsupported --target-org my-scratch-org
 
 - Generate a protected custom metadata type from a custom object:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\_\_c --visibility Protected
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected
 
 - Generate a protected custom metadata type from a custom setting with a specific singular and plural label:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --label "My CMDT" --plural-label "My CMDTs" --sobject MySourceSetting\_\_c --visibility Protected
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --label "My CMDT" --plural-label "My CMDTs" --sobject MySourceSetting__c --visibility Protected
 
 - Generate a custom metadata type and put the resulting metadata files in the specified directory:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\_\_c --type-output-directory path/to/my/cmdt/directory
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --type-output-directory path/to/my/cmdt/directory
 
 - Generate a custom metadata type and put the resulting record metadata file(s) in the specified directory:
 
-  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\_\_c --records-output-dir path/to/my/cmdt/record/directory
+  <%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --records-output-dir path/to/my/cmdt/record/directory
 
 # flags.visibility.summary
 

package/messages/object.md

@@ -4,7 +4,7 @@ Generate a new custom metadata type in the current project.
 
 # description
 
-This command creates a metadata file that describes the new custom metadata type. By default, the file is created in the MyCustomType\_\_mdt directory in the current directory, where MyCustomType is the value of the required --type-name flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as "force-app/main/default/objects".
+This command creates a metadata file that describes the new custom metadata type. By default, the file is created in the MyCustomType__mdt directory in the current directory, where MyCustomType is the value of the required --type-name flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as "force-app/main/default/objects".
 
 # examples
 

package/messages/record.md

@@ -10,15 +10,15 @@ The custom metadata type must already exist in your project. You must specify a
 
 - Create a record metadata file for custom metadata type 'MyCMT' with specified values for two custom fields:
 
-  <%= config.bin %> <%= command.id %> --type-name MyCMT\_\_mdt --record-name MyRecord My_Custom_Field_1=Foo My_Custom_Field_2=Bar
+  <%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord My_Custom_Field_1=Foo My_Custom_Field_2=Bar
 
 - Create a protected record metadata file for custom metadata type 'MyCMT' with a specific label and values specified for two custom fields:
 
-  <%= config.bin %> <%= command.id %> --type-name MyCMT\_\_mdt --record-name MyRecord --label "My Record" --protected true My_Custom_Field_1=Foo My_Custom_Field_2=Bar
+  <%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord --label "My Record" --protected true My_Custom_Field_1=Foo My_Custom_Field_2=Bar
 
 # flags.type-name.summary
 
-API name of the custom metadata type to create a record for; must end in "\_\_mdt".
+API name of the custom metadata type to create a record for; must end in "__mdt".
 
 # flags.record-name.summary
 

package/messages/records.md

@@ -34,7 +34,7 @@ API name of the custom metadata type to create a record for.
 
 # flags.type-name.description
 
-The '\_\_mdt' suffix is appended to the end of the name if it's omitted.
+The '__mdt' suffix is appended to the end of the name if it's omitted.
 
 # flags.name-column.summary
 

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.0.12","commands":{"generate:cmdt:field":{"id":"generate:cmdt:field","summary":"Generate a field for a custom metadata type based on the provided field type.","description":"Similar to a custom object, a custom metadata type has a list of custom fields that represent aspects of the metadata.\n\nThis command creates a metadata file that describes the new custom metadata type field. By default, the file is created in a \"fields\" directory in the current directory. Use the --output-directory to generate the file in the directory that contains the custom metadata type metdata files, such as \"force-app/main/default/objects/MyCmdt\\_\\_mdt\" for the custom metadata type called MyCmdt.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:field:create","cmdt:field:create"],"examples":["Generate a metadata file for a custom checkbox field and add the file to the MyCmdt\\_\\_mdt/fields directory:\n<%= config.bin %> <%= command.id %> --name MyCheckboxField --type Checkbox --output-directory force-app/main/default/objects/MyCmdt\\_\\_mdt","Generate a metadata file for a custom picklist field and add a few values:\n<%= config.bin %> <%= command.id %> --name MyPicklistField --type Picklist --picklist-values A --picklist-values B --picklist-values C --output-directory force-app/main/default/objects/MyCmdt\\_\\_mdt","Generate a metadata file for a custom number field and specify 2 decimal places:\n<%= config.bin %> <%= command.id %> --name MyNumberField --type Number --decimal-places 2 --output-directory force-app/main/default/objects/MyCmdt\\_\\_mdt"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"name":{"name":"name","type":"option","char":"n","summary":"Unique name for the field.","required":true,"multiple":false,"aliases":["fieldname"]},"type":{"name":"type","type":"option","char":"f","summary":"Type of the field.","description":"You can't use this command to create a custom metadata type field of type \"Metadata Relationship\". Use the Salesforce Setup UI instead.","required":true,"multiple":false,"options":["Checkbox","Date","DateTime","Email","Number","Percent","Phone","Picklist","Text","TextArea","LongTextArea","Url"],"aliases":["fieldtype"]},"picklist-values":{"name":"picklist-values","type":"option","char":"p","summary":"Picklist values; required for picklist fields.","multiple":true,"aliases":["picklistvalues"]},"decimal-places":{"name":"decimal-places","type":"option","char":"s","summary":"Number of decimal places to use for number or percent fields.","description":"The value must be greater than or equal to zero. Default value is 0.","multiple":false,"default":0,"aliases":["decimalplaces"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the field.","multiple":false},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created field definition files.","description":"New files are automatically created in the \"fields\" directory. The location can be an absolute path or relative to the current working directory. The default is the current directory.","multiple":false,"default":"","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:fromorg":{"id":"generate:cmdt:fromorg","summary":"Generate a custom metadata type and all its records from a Salesforce object.","description":"Use this command to migrate existing custom objects or custom settings in an org to custom metadata types. If a field of the Salesforce object is of an unsupported type, the field type is automatically converted to text. Run \"<%= config.bin %> cmdt field create --help\" to see the list of supported cmdt field types, listed in the --type flag summary. Use the --ignore-unsupported to ignore these fields.\n\nThis command creates the metadata files that describe the new custom metadata type and its fields in the \"force-app/main/default/objects/TypeName\\_\\_mdt\" directory by default, where \"TypeName\" is the value of the required --dev-name flag. Use --type-output-directory to create them in a different directory.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:generate"],"examples":["Generate a custom metadata type from a custom object called MySourceObject\\_\\_c in your default org:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\\_\\_c","Generate a custom metadata type from a custom object in an org with alias my-scratch-org; ignore unsupported field types instead of converting them to text:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\\_\\_c --ignore-unsupported --target-org my-scratch-org","Generate a protected custom metadata type from a custom object:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\\_\\_c --visibility Protected","Generate a protected custom metadata type from a custom setting with a specific singular and plural label:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --label \"My CMDT\" --plural-label \"My CMDTs\" --sobject MySourceSetting\\_\\_c --visibility Protected","Generate a custom metadata type and put the resulting metadata files in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\\_\\_c --type-output-directory path/to/my/cmdt/directory","Generate a custom metadata type and put the resulting record metadata file(s) in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject\\_\\_c --records-output-dir path/to/my/cmdt/record/directory"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"dev-name":{"name":"dev-name","type":"option","char":"n","summary":"Name of the custom metadata type.","required":true,"multiple":false,"aliases":["devname"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the custom metadata type.","multiple":false},"plural-label":{"name":"plural-label","type":"option","char":"p","summary":"Plural version of the label value; if blank, uses label.","multiple":false,"aliases":["plurallabel"]},"visibility":{"name":"visibility","type":"option","char":"v","summary":"Who can see the custom metadata type.","description":"For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.","multiple":false,"options":["PackageProtected","Protected","Public"],"default":"Public"},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the source Salesforce object used to generate the custom metadata type.","required":true,"multiple":false,"aliases":["sobjectname"]},"ignore-unsupported":{"name":"ignore-unsupported","type":"boolean","char":"i","summary":"Ignore unsupported field types.","description":"In this context, \"ignore\" means that the fields aren't created. The default behavior is to create fields of type text and convert the field values to text.","allowNo":false,"aliases":["ignoreunsupported"]},"type-output-directory":{"name":"type-output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata type files.","multiple":false,"default":"force-app/main/default/objects","aliases":["typeoutputdir"]},"records-output-dir":{"name":"records-output-dir","type":"option","char":"r","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["recordsoutputdir"]}},"args":[],"requiresProject":true,"hasDynamicHelp":true},"generate:cmdt:object":{"id":"generate:cmdt:object","summary":"Generate a new custom metadata type in the current project.","description":"This command creates a metadata file that describes the new custom metadata type. By default, the file is created in the MyCustomType\\_\\_mdt directory in the current directory, where MyCustomType is the value of the required --type-name flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as \"force-app/main/default/objects\".","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:create","cmdt:create"],"examples":["Generate a custom metadata type with developer name 'MyCustomType'; this name is also used as the label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType","Generate a protected custom metadata type with a specific label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType --label \"Custom Type\" --plural-label \"Custom Types\" --visibility Protected"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"type-name":{"name":"type-name","type":"option","char":"n","summary":"Unique object name for the custom metadata type.","description":"The name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.","required":true,"multiple":false,"aliases":["typename"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the custom metadata type.","multiple":false},"plural-label":{"name":"plural-label","type":"option","char":"p","summary":"Plural version of the label value; if blank, uses label.","multiple":false,"aliases":["plurallabel"]},"visibility":{"name":"visibility","type":"option","char":"v","summary":"Who can see the custom metadata type.","description":"For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.","multiple":false,"options":["PackageProtected","Protected","Public"],"default":"Public"},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store the newly-created custom metadata type files","description":"The location can be an absolute path or relative to the current working directory. The default is the current directory.","multiple":false,"default":"","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:record":{"id":"generate:cmdt:record","summary":"Generate a new record for a given custom metadata type in the current project.","description":"The custom metadata type must already exist in your project. You must specify a name for the new record. Use name=value pairs to specify the values for the fields, such as MyTextField=\"some text here\" or MyNumberField=32.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:record:create","cmdt:record:create"],"examples":["Create a record metadata file for custom metadata type 'MyCMT' with specified values for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT\\_\\_mdt --record-name MyRecord My_Custom_Field_1=Foo My_Custom_Field_2=Bar","Create a protected record metadata file for custom metadata type 'MyCMT' with a specific label and values specified for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT\\_\\_mdt --record-name MyRecord --label \"My Record\" --protected true My_Custom_Field_1=Foo My_Custom_Field_2=Bar"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"type-name":{"name":"type-name","type":"option","char":"t","summary":"API name of the custom metadata type to create a record for; must end in \"\\_\\_mdt\".","required":true,"multiple":false,"aliases":["typename"]},"record-name":{"name":"record-name","type":"option","char":"n","summary":"Name of the new record.","required":true,"multiple":false,"aliases":["recordname"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the new record.","multiple":false},"protected":{"name":"protected","type":"option","char":"p","summary":"Protect the record when it's in a managed package.","description":"Protected records can only be accessed by code in the same managed package namespace.","multiple":false,"options":["true","false"],"default":"false"},"input-directory":{"name":"input-directory","type":"option","char":"i","summary":"Directory from which to get the custom metadata type definition from.","multiple":false,"default":"force-app/main/default/objects","aliases":["inputdir","inputdirectory"]},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:records":{"id":"generate:cmdt:records","summary":"Generate new custom metadata type records from a CSV file.","description":"The custom metadata type must already exist in your project. By default, the Name column is used to determine the record name; use the --name-column flag to specify a different column.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:record:insert","cmdt:record:insert"],"examples":["Generate record metadata files from values in a CSV file for the custom metadata type MyCmdt. Use 'Name' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt","Generate record metadata files from a CSV file in the directory different from the default, and use 'PrimaryKey' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt --input-directory path/to/my/cmdt/directory --name-column \"PrimaryKey\""],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"csv":{"name":"csv","type":"option","char":"f","summary":"Pathname of the CSV file.","required":true,"multiple":false,"aliases":["filepath"]},"type-name":{"name":"type-name","type":"option","char":"t","summary":"API name of the custom metadata type to create a record for.","description":"The '\\_\\_mdt' suffix is appended to the end of the name if it's omitted.","required":true,"multiple":false,"aliases":["typename"]},"input-directory":{"name":"input-directory","type":"option","char":"i","summary":"Directory from which to get the custom metadata type definition from.","multiple":false,"default":"force-app/main/default/objects","aliases":["inputdir","inputdirectory"]},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["outputdir","outputdirectory"]},"name-column":{"name":"name-column","type":"option","char":"n","summary":"Column used to determine the name of the record.","multiple":false,"default":"Name","aliases":["namecolumn"]}},"args":[],"requiresProject":true}}}
+{"version":"2.0.14","commands":{"generate:cmdt:field":{"id":"generate:cmdt:field","summary":"Generate a field for a custom metadata type based on the provided field type.","description":"Similar to a custom object, a custom metadata type has a list of custom fields that represent aspects of the metadata.\n\nThis command creates a metadata file that describes the new custom metadata type field. By default, the file is created in a \"fields\" directory in the current directory. Use the --output-directory to generate the file in the directory that contains the custom metadata type metdata files, such as \"force-app/main/default/objects/MyCmdt__mdt\" for the custom metadata type called MyCmdt.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:field:create","cmdt:field:create"],"examples":["Generate a metadata file for a custom checkbox field and add the file to the MyCmdt__mdt/fields directory:\n<%= config.bin %> <%= command.id %> --name MyCheckboxField --type Checkbox --output-directory force-app/main/default/objects/MyCmdt__mdt","Generate a metadata file for a custom picklist field and add a few values:\n<%= config.bin %> <%= command.id %> --name MyPicklistField --type Picklist --picklist-values A --picklist-values B --picklist-values C --output-directory force-app/main/default/objects/MyCmdt__mdt","Generate a metadata file for a custom number field and specify 2 decimal places:\n<%= config.bin %> <%= command.id %> --name MyNumberField --type Number --decimal-places 2 --output-directory force-app/main/default/objects/MyCmdt__mdt"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"name":{"name":"name","type":"option","char":"n","summary":"Unique name for the field.","required":true,"multiple":false,"aliases":["fieldname"]},"type":{"name":"type","type":"option","char":"f","summary":"Type of the field.","description":"You can't use this command to create a custom metadata type field of type \"Metadata Relationship\". Use the Salesforce Setup UI instead.","required":true,"multiple":false,"options":["Checkbox","Date","DateTime","Email","Number","Percent","Phone","Picklist","Text","TextArea","LongTextArea","Url"],"aliases":["fieldtype"]},"picklist-values":{"name":"picklist-values","type":"option","char":"p","summary":"Picklist values; required for picklist fields.","multiple":true,"aliases":["picklistvalues"]},"decimal-places":{"name":"decimal-places","type":"option","char":"s","summary":"Number of decimal places to use for number or percent fields.","description":"The value must be greater than or equal to zero. Default value is 0.","multiple":false,"default":0,"aliases":["decimalplaces"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the field.","multiple":false},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created field definition files.","description":"New files are automatically created in the \"fields\" directory. The location can be an absolute path or relative to the current working directory. The default is the current directory.","multiple":false,"default":"","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:fromorg":{"id":"generate:cmdt:fromorg","summary":"Generate a custom metadata type and all its records from a Salesforce object.","description":"Use this command to migrate existing custom objects or custom settings in an org to custom metadata types. If a field of the Salesforce object is of an unsupported type, the field type is automatically converted to text. Run \"<%= config.bin %> cmdt field create --help\" to see the list of supported cmdt field types, listed in the --type flag summary. Use the --ignore-unsupported to ignore these fields.\n\nThis command creates the metadata files that describe the new custom metadata type and its fields in the \"force-app/main/default/objects/TypeName__mdt\" directory by default, where \"TypeName\" is the value of the required --dev-name flag. Use --type-output-directory to create them in a different directory.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:generate"],"examples":["Generate a custom metadata type from a custom object called MySourceObject__c in your default org:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c","Generate a custom metadata type from a custom object in an org with alias my-scratch-org; ignore unsupported field types instead of converting them to text:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --ignore-unsupported --target-org my-scratch-org","Generate a protected custom metadata type from a custom object:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected","Generate a protected custom metadata type from a custom setting with a specific singular and plural label:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --label \"My CMDT\" --plural-label \"My CMDTs\" --sobject MySourceSetting__c --visibility Protected","Generate a custom metadata type and put the resulting metadata files in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --type-output-directory path/to/my/cmdt/directory","Generate a custom metadata type and put the resulting record metadata file(s) in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --records-output-dir path/to/my/cmdt/record/directory"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","required":true,"multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"dev-name":{"name":"dev-name","type":"option","char":"n","summary":"Name of the custom metadata type.","required":true,"multiple":false,"aliases":["devname"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the custom metadata type.","multiple":false},"plural-label":{"name":"plural-label","type":"option","char":"p","summary":"Plural version of the label value; if blank, uses label.","multiple":false,"aliases":["plurallabel"]},"visibility":{"name":"visibility","type":"option","char":"v","summary":"Who can see the custom metadata type.","description":"For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.","multiple":false,"options":["PackageProtected","Protected","Public"],"default":"Public"},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the source Salesforce object used to generate the custom metadata type.","required":true,"multiple":false,"aliases":["sobjectname"]},"ignore-unsupported":{"name":"ignore-unsupported","type":"boolean","char":"i","summary":"Ignore unsupported field types.","description":"In this context, \"ignore\" means that the fields aren't created. The default behavior is to create fields of type text and convert the field values to text.","allowNo":false,"aliases":["ignoreunsupported"]},"type-output-directory":{"name":"type-output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata type files.","multiple":false,"default":"force-app/main/default/objects","aliases":["typeoutputdir"]},"records-output-dir":{"name":"records-output-dir","type":"option","char":"r","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["recordsoutputdir"]}},"args":[],"requiresProject":true,"hasDynamicHelp":true},"generate:cmdt:object":{"id":"generate:cmdt:object","summary":"Generate a new custom metadata type in the current project.","description":"This command creates a metadata file that describes the new custom metadata type. By default, the file is created in the MyCustomType__mdt directory in the current directory, where MyCustomType is the value of the required --type-name flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as \"force-app/main/default/objects\".","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:create","cmdt:create"],"examples":["Generate a custom metadata type with developer name 'MyCustomType'; this name is also used as the label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType","Generate a protected custom metadata type with a specific label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType --label \"Custom Type\" --plural-label \"Custom Types\" --visibility Protected"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"type-name":{"name":"type-name","type":"option","char":"n","summary":"Unique object name for the custom metadata type.","description":"The name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.","required":true,"multiple":false,"aliases":["typename"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the custom metadata type.","multiple":false},"plural-label":{"name":"plural-label","type":"option","char":"p","summary":"Plural version of the label value; if blank, uses label.","multiple":false,"aliases":["plurallabel"]},"visibility":{"name":"visibility","type":"option","char":"v","summary":"Who can see the custom metadata type.","description":"For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.","multiple":false,"options":["PackageProtected","Protected","Public"],"default":"Public"},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store the newly-created custom metadata type files","description":"The location can be an absolute path or relative to the current working directory. The default is the current directory.","multiple":false,"default":"","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:record":{"id":"generate:cmdt:record","summary":"Generate a new record for a given custom metadata type in the current project.","description":"The custom metadata type must already exist in your project. You must specify a name for the new record. Use name=value pairs to specify the values for the fields, such as MyTextField=\"some text here\" or MyNumberField=32.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:record:create","cmdt:record:create"],"examples":["Create a record metadata file for custom metadata type 'MyCMT' with specified values for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord My_Custom_Field_1=Foo My_Custom_Field_2=Bar","Create a protected record metadata file for custom metadata type 'MyCMT' with a specific label and values specified for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord --label \"My Record\" --protected true My_Custom_Field_1=Foo My_Custom_Field_2=Bar"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"type-name":{"name":"type-name","type":"option","char":"t","summary":"API name of the custom metadata type to create a record for; must end in \"__mdt\".","required":true,"multiple":false,"aliases":["typename"]},"record-name":{"name":"record-name","type":"option","char":"n","summary":"Name of the new record.","required":true,"multiple":false,"aliases":["recordname"]},"label":{"name":"label","type":"option","char":"l","summary":"Label for the new record.","multiple":false},"protected":{"name":"protected","type":"option","char":"p","summary":"Protect the record when it's in a managed package.","description":"Protected records can only be accessed by code in the same managed package namespace.","multiple":false,"options":["true","false"],"default":"false"},"input-directory":{"name":"input-directory","type":"option","char":"i","summary":"Directory from which to get the custom metadata type definition from.","multiple":false,"default":"force-app/main/default/objects","aliases":["inputdir","inputdirectory"]},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["outputdir","outputdirectory"]}},"args":[],"requiresProject":true},"generate:cmdt:records":{"id":"generate:cmdt:records","summary":"Generate new custom metadata type records from a CSV file.","description":"The custom metadata type must already exist in your project. By default, the Name column is used to determine the record name; use the --name-column flag to specify a different column.","strict":true,"pluginName":"@salesforce/plugin-custom-metadata","pluginAlias":"@salesforce/plugin-custom-metadata","pluginType":"core","aliases":["force:cmdt:record:insert","cmdt:record:insert"],"examples":["Generate record metadata files from values in a CSV file for the custom metadata type MyCmdt. Use 'Name' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt","Generate record metadata files from a CSV file in the directory different from the default, and use 'PrimaryKey' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt --input-directory path/to/my/cmdt/directory --name-column \"PrimaryKey\""],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."}},"csv":{"name":"csv","type":"option","char":"f","summary":"Pathname of the CSV file.","required":true,"multiple":false,"aliases":["filepath"]},"type-name":{"name":"type-name","type":"option","char":"t","summary":"API name of the custom metadata type to create a record for.","description":"The '__mdt' suffix is appended to the end of the name if it's omitted.","required":true,"multiple":false,"aliases":["typename"]},"input-directory":{"name":"input-directory","type":"option","char":"i","summary":"Directory from which to get the custom metadata type definition from.","multiple":false,"default":"force-app/main/default/objects","aliases":["inputdir","inputdirectory"]},"output-directory":{"name":"output-directory","type":"option","char":"d","summary":"Directory to store newly-created custom metadata record files.","multiple":false,"default":"force-app/main/default/customMetadata","aliases":["outputdir","outputdirectory"]},"name-column":{"name":"name-column","type":"option","char":"n","summary":"Column used to determine the name of the record.","multiple":false,"default":"Name","aliases":["namecolumn"]}},"args":[],"requiresProject":true}}}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-custom-metadata",
     "description": "Tools for working with custom metadata types and their records.",
-    "version": "2.0.12",
+    "version": "2.0.14",
     "contributors": [
         {
             "name": "Carolyn Grabill",
@@ -43,7 +43,7 @@
     "bugs": "https://github.com/salesforcecli/plugin-custom-metadata/issues",
     "dependencies": {
         "@oclif/core": "^1.22.0",
-        "@salesforce/core": "^3.32.11",
+        "@salesforce/core": "^3.33.0",
         "@salesforce/sf-plugins-core": "^1.21.3",
         "@salesforce/ts-types": "^1.7.1",
         "fast-xml-parser": "^4.0.12",
@@ -54,12 +54,12 @@
         "@salesforce/cli-plugins-testkit": "^3.2.14",
         "@salesforce/dev-config": "^3.0.1",
         "@salesforce/dev-scripts": "^3.1.0",
-        "@salesforce/plugin-command-reference": "^2.2.8",
+        "@salesforce/plugin-command-reference": "^2.2.9",
         "@salesforce/prettier-config": "^0.0.2",
         "@salesforce/ts-sinon": "^1.4.2",
-        "@swc/core": "^1.3.25",
+        "@swc/core": "^1.3.26",
         "@typescript-eslint/eslint-plugin": "^5.48.1",
-        "@typescript-eslint/parser": "^5.47.0",
+        "@typescript-eslint/parser": "^5.48.1",
         "bluebird": "3.7.2",
         "chai": "^4.3.7",
         "eslint": "^8.30.0",
@@ -70,7 +70,7 @@
         "eslint-plugin-header": "^3.1.1",
         "eslint-plugin-import": "^2.26.0",
         "eslint-plugin-jsdoc": "^39.6.4",
-        "eslint-plugin-sf-plugin": "^1.2.3",
+        "eslint-plugin-sf-plugin": "^1.6.2",
         "husky": "^7.0.4",
         "jsforce": "^2.0.0-beta.19",
         "mocha": "^9.1.3",
@@ -145,7 +145,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/2.0.12.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/2.0.12.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/2.0.14.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/2.0.14.sig"
     }
 }