Merge pull request #549 from salesforcecli/sm/out-of-beta

feat: take project commands out of beta

Author: WillieRuemmele

command-snapshot.json

@@ -9,7 +9,7 @@
     "command": "project:convert:mdapi",
     "plugin": "@salesforce/plugin-deploy-retrieve",
     "flags": ["api-version", "json", "loglevel", "manifest", "metadata", "metadata-dir", "output-dir", "root-dir"],
-    "alias": ["force:mdapi:beta:convert", "force:mdapi:convert"]
+    "alias": ["force:mdapi:convert"]
   },
   {
     "command": "project:convert:source",
@@ -51,7 +51,7 @@
     "command": "project:delete:tracking",
     "plugin": "@salesforce/plugin-deploy-retrieve",
     "flags": ["api-version", "json", "loglevel", "no-prompt", "target-org"],
-    "alias": ["force:source:beta:tracking:clear", "force:source:tracking:clear"]
+    "alias": ["force:source:tracking:clear"]
   },
   {
     "command": "project:deploy:cancel",
@@ -155,33 +155,33 @@
     "alias": ["deploy:metadata:validate"]
   },
   {
-    "command": "project:list:ignored",
-    "plugin": "@salesforce/plugin-deploy-retrieve",
-    "flags": ["json", "source-dir"],
-    "alias": ["force:source:ignored:list"]
-  },
-  {
-    "command": "project:manifest:create",
+    "command": "project:generate:manifest",
     "plugin": "@salesforce/plugin-deploy-retrieve",
     "flags": [
       "api-version",
       "from-org",
       "include-packages",
       "json",
       "loglevel",
-      "manifest-name",
-      "manifest-type",
       "metadata",
+      "name",
       "output-dir",
-      "source-dir"
+      "source-dir",
+      "type"
     ],
     "alias": ["force:source:manifest:create"]
   },
+  {
+    "command": "project:list:ignored",
+    "plugin": "@salesforce/plugin-deploy-retrieve",
+    "flags": ["json", "source-dir"],
+    "alias": ["force:source:ignored:list"]
+  },
   {
     "command": "project:reset:tracking",
     "plugin": "@salesforce/plugin-deploy-retrieve",
     "flags": ["api-version", "json", "loglevel", "no-prompt", "revision", "target-org"],
-    "alias": ["force:source:beta:tracking:reset", "force:source:tracking:reset"]
+    "alias": ["force:source:tracking:reset"]
   },
   {
     "command": "project:retrieve:preview",

messages/convert.source.md

@@ -20,6 +20,10 @@ To specify a package name that includes spaces, enclose the name in single quote
 
   $ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
 
+# flags.api-version.summary
+
+API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json
+
 # flags.root-dir.summary
 
 Source directory other than the default package to convert.

messages/manifest.create.md renamed to messages/manifest.generate.md

@@ -6,7 +6,7 @@ Create a project manifest that lists the metadata components you want to deploy
 
 Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.
 
-Use --manifest-type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:
+Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:
 
     * package : package.xml (default)
     * pre : destructiveChangesPre.xml
@@ -15,7 +15,7 @@ Use --manifest-type to specify the type of manifest you want to create. The resu
 
 See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.
 
-Use --manifest-name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifest-type or --manifest-name, but not both.
+Use --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.
 
 # examples
 
@@ -25,11 +25,11 @@ Use --manifest-name to specify a custom name for the generated manifest if the p
 
 - Create a manifest for deleting the specified Apex class:
 
-  $ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --manifest-type destroy
+  $ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
 
 - Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
 
-  $ <%= config.bin %> <%= command.id %> --source-dir force-app --manifest-name myNewManifest
+  $ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest
 
 - Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
 
@@ -43,11 +43,11 @@ Comma-separated list of package types (managed, unlocked) whose metadata is incl
 
 Username or alias of the org that contains the metadata components from which to build a manifest.
 
-# flags.manifest-type.summary
+# flags.type.summary
 
 Type of manifest to create; the type determines the name of the created file.
 
-# flags.manifest-name.summary
+# flags.name.summary
 
 Name of a custom manifest file to create.
 

package.json

@@ -118,7 +118,7 @@
           "delete": {
             "description": "Commands to delete metadata from a Salesforce org."
           },
-          "manifest": {
+          "generate": {
             "description": "Commands to create a manifest file."
           },
           "reset": {

schemas/project-manifest-create.json renamed to schemas/project-generate-manifest.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$ref": "#/definitions/CreateCommandResult",
+  "$ref": "#/definitions/ManifestGenerateCommandResult",
   "definitions": {
-    "CreateCommandResult": {
+    "ManifestGenerateCommandResult": {
       "type": "object",
       "properties": {
         "name": {

src/commands/project/convert/mdapi.ts

@@ -35,7 +35,7 @@ export interface EnsureFsFlagOptions {
   throwOnENOENT?: boolean;
 }
 export class Mdapi extends SfCommand<ConvertMdapiJson> {
-  public static readonly aliases = ['force:mdapi:beta:convert', 'force:mdapi:convert'];
+  public static readonly aliases = ['force:mdapi:convert'];
   public static readonly deprecateAliases = true;
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');

src/commands/project/convert/source.ts

@@ -39,7 +39,7 @@ export class Source extends SfCommand<ConvertResultJson> {
   public static readonly aliases = ['force:source:convert'];
   public static readonly deprecateAliases = true;
   public static readonly flags = {
-    'api-version': orgApiVersionFlagWithDeprecations,
+    'api-version': { ...orgApiVersionFlagWithDeprecations, summary: messages.getMessage('flags.api-version.summary') },
     loglevel,
     'root-dir': Flags.directory({
       aliases: ['rootdir'],
@@ -117,7 +117,7 @@ export class Source extends SfCommand<ConvertResultJson> {
     }
 
     this.componentSet = await ComponentSetBuilder.build({
-      sourceapiversion: await getSourceApiVersion(),
+      sourceapiversion: this.flags['api-version'] ?? (await getSourceApiVersion()),
       sourcepath: paths,
       manifest: manifest
         ? {

src/commands/project/delete/tracking.ts

@@ -25,7 +25,7 @@ export type DeleteTrackingResult = {
 
 export class DeleteTracking extends SfCommand<DeleteTrackingResult> {
   public static readonly deprecateAliases = true;
-  public static readonly aliases = ['force:source:beta:tracking:clear', 'force:source:tracking:clear'];
+  public static readonly aliases = ['force:source:tracking:clear'];
   public static readonly summary = messages.getMessage('deleteSummary');
   public static readonly description = messages.getMessage('deleteDescription');
   public static readonly requiresProject = true;

src/commands/project/deploy/cancel.ts

@@ -23,7 +23,6 @@ export default class DeployMetadataCancel extends SfCommand<DeployResultJson> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly requiresProject = true;
-  public static readonly state = 'beta';
   public static readonly aliases = ['deploy:metadata:cancel'];
   public static readonly deprecateAliases = true;
 

src/commands/project/deploy/preview.ts

@@ -21,7 +21,6 @@ export default class DeployMetadataPreview extends SfCommand<PreviewResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly requiresProject = true;
-  public static readonly state = 'beta';
   public static readonly aliases = ['deploy:metadata:preview'];
   public static readonly deprecateAliases = true;