Merge pull request #587 from salesforcecli/wr/sourceOpen

feat: add force:source:open force:mdapi:listmetadata force:mdapi:describemetadata

Author: mshanemc

.mocharc.json

@@ -4,5 +4,5 @@
   "watch-files": ["src", "test"],
   "recursive": true,
   "reporter": "spec",
-  "timeout": 5000
+  "timeout": 10000
 }

CHANGELOG.md

@@ -114,11 +114,23 @@
     "flags": ["all", "clean", "json", "loglevel", "no-prompt", "skip-connection-status", "verbose"],
     "alias": ["force:org:list"]
   },
+  {
+    "command": "org:list:metadata",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["api-version", "folder", "json", "loglevel", "metadata-type", "output-file", "target-org"],
+    "alias": ["force:mdapi:listmetadata"]
+  },
+  {
+    "command": "org:list:metadata-types",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["api-version", "filter-known", "json", "loglevel", "output-file", "target-org"],
+    "alias": ["force:mdapi:describemetadata"]
+  },
   {
     "command": "org:open",
     "plugin": "@salesforce/plugin-org",
-    "flags": ["api-version", "browser", "json", "loglevel", "path", "target-org", "url-only"],
-    "alias": ["force:org:open"]
+    "flags": ["api-version", "browser", "json", "loglevel", "path", "source-file", "target-org", "url-only"],
+    "alias": ["force:org:open", "force:source:open"]
   },
   {
     "command": "org:resume:sandbox",

command-snapshot.json

@@ -0,0 +1,47 @@
+# description
+
+Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.
+
+The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.
+
+# summary
+
+List the metadata components and properties of a specified type.
+
+# examples
+
+- List the CustomObject components, and their properties, in the org with alias "my-dev-org":
+
+  $ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org
+
+- List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:
+
+  $ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt
+
+- List the Dashboard components in your default org that are contained in the "folderSales" folder, write the output to the specified file, and use API version 57.0:
+
+  $ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt
+
+# flags.api-version.summary
+
+API version to use; default is the most recent API version.
+
+# flags.output-file.summary
+
+Pathname of the file in which to write the results.
+
+# flags.metadata-type.summary
+
+Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.
+
+# flags.folder.summary
+
+Folder associated with the component; required for components that use folders; folder names are case-sensitive.
+
+# flags.folder.description
+
+Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
+
+# noMatchingMetadata
+
+No metadata found for type: %s in org: %s.

messages/list.metadata.md

@@ -0,0 +1,37 @@
+# description
+
+The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).
+
+The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.
+
+# summary
+
+Display details about the metadata types that are enabled for your org.
+
+# examples
+
+- Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version 57.0:
+
+  $ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org
+
+- Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:
+
+  $ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known
+
+# flags.api-version.summary
+
+API version to use; default is the most recent API version.
+
+# flags.output-file.summary
+
+Pathname of the file in which to write the results.
+
+# flags.filter-known.summary
+
+Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.
+
+filter metadata known by the CLI
+
+# flags.output-file.description
+
+Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.

messages/metadata-types.md

@@ -6,6 +6,8 @@ Open your default scratch org, or another specified org, in a browser.
 
 To open a specific page, specify the portion of the URL after "https://MyDomainName.my.salesforce.com/" as the value for the --path flag. For example, specify "--path lightning" to open Lightning Experience, or specify "--path /apex/YourPage" to open a Visualforce page.
 
+Use the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files have the suffix .flexipage-meta.xml, and are stored in the "flexipages" directory.
+
 To generate a URL but not launch it in your browser, specify --url-only.
 
 To open in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.
@@ -24,10 +26,18 @@ To open in a specific browser, use the --browser flag. Supported browsers are "c
 
   $ <%= config.bin %> <%= command.id %> --url-only --path lightning
 
+- Open a local Lightning page in your default org's Lightning App Builder:
+
+  $ <%= config.bin %> <%= command.id %> --source-path force-app/main/default/flexipages/Hello.flexipage-meta.xml
+
 # flags.browser.summary
 
 Browser where the org opens.
 
+# flags.source-file.summary
+
+Path to an ApexPage or FlexiPage to open in Lightning App Builder.
+
 # flags.path.summary
 
 Navigation URL path to open a specific page.

messages/open.md

@@ -6,11 +6,12 @@
   "main": "lib/index.js",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^2.3.1",
+    "@oclif/core": "^2.6.3",
     "@salesforce/core": "^3.33.5",
     "@salesforce/kit": "^1.9.0",
     "@salesforce/sf-plugins-core": "^2.2.3",
-    "open": "8.4.2",
+    "@salesforce/source-deploy-retrieve": "^7.11.0",
+    "open": "^8.4.2",
     "tslib": "^2"
   },
   "devDependencies": {
@@ -19,6 +20,7 @@
     "@salesforce/dev-config": "^3.1.0",
     "@salesforce/dev-scripts": "^4.1.2",
     "@salesforce/plugin-command-reference": "^2.2.9",
+    "@salesforce/plugin-source": "^2.7.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "1.4.6",
     "@swc/core": "^1.3.37",
@@ -36,7 +38,7 @@
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsdoc": "^40.0.1",
-    "eslint-plugin-sf-plugin": "^1.8.1",
+    "eslint-plugin-sf-plugin": "^1.13.0",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",
     "moment": "^2.29.1",
@@ -74,7 +76,8 @@
     "devPlugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-command-snapshot",
-      "@salesforce/plugin-command-reference"
+      "@salesforce/plugin-command-reference",
+      "@salesforce/plugin-source"
     ],
     "topics": {
       "org": {
@@ -86,6 +89,9 @@
           "resume": {
             "description": "Resume an org creation that was started asynchronously, timed out, or was interrupted."
           },
+          "list": {
+            "description": "list metadata types that are relevant to the org"
+          },
           "delete": {
             "description": "Delete scratch orgs, sandboxes, org shapes, and org snapshots."
           }
@@ -115,7 +121,7 @@
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
-    "test:nuts": "nyc mocha \"./test/nut/*.nut.ts\" --slow 4500 --timeout 1200000",
+    "test:nuts": "nyc mocha \"./test/nut/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 20",
     "test:nuts:legacy": "nyc mocha \"./test/nut/legacy/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 10",
     "test:nuts:sandbox": "nyc mocha \"./test/**/*.sandboxNut.ts\" --slow 450000 --timeout 7200000 --parallel --jobs 10",
     "test:only": "wireit",
@@ -231,4 +237,4 @@
       "output": []
     }
   }
-}
+}

package.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/ListMetadataCommandResult",
+  "definitions": {
+    "ListMetadataCommandResult": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/FileProperties"
+      }
+    },
+    "FileProperties": {
+      "type": "object",
+      "properties": {
+        "createdById": {
+          "type": "string"
+        },
+        "createdByName": {
+          "type": "string"
+        },
+        "createdDate": {
+          "type": "string"
+        },
+        "fileName": {
+          "type": "string"
+        },
+        "fullName": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "lastModifiedById": {
+          "type": "string"
+        },
+        "lastModifiedByName": {
+          "type": "string"
+        },
+        "lastModifiedDate": {
+          "type": "string"
+        },
+        "manageableState": {
+          "type": ["string", "null"]
+        },
+        "namespacePrefix": {
+          "type": ["string", "null"]
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "createdById",
+        "createdByName",
+        "createdDate",
+        "fileName",
+        "fullName",
+        "id",
+        "lastModifiedById",
+        "lastModifiedByName",
+        "lastModifiedDate",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

schemas/org-list-metadata.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/DescribeMetadataResult",
+  "definitions": {
+    "DescribeMetadataResult": {
+      "type": "object",
+      "properties": {
+        "metadataObjects": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DescribeMetadataObject"
+          }
+        },
+        "organizationNamespace": {
+          "type": "string"
+        },
+        "partialSaveAllowed": {
+          "type": "boolean"
+        },
+        "testRequired": {
+          "type": "boolean"
+        }
+      },
+      "required": ["metadataObjects", "organizationNamespace", "partialSaveAllowed", "testRequired"],
+      "additionalProperties": false
+    },
+    "DescribeMetadataObject": {
+      "type": "object",
+      "properties": {
+        "childXmlNames": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "directoryName": {
+          "type": "string"
+        },
+        "inFolder": {
+          "type": "boolean"
+        },
+        "metaFile": {
+          "type": "boolean"
+        },
+        "suffix": {
+          "type": ["string", "null"]
+        },
+        "xmlName": {
+          "type": "string"
+        }
+      },
+      "required": ["childXmlNames", "directoryName", "inFolder", "metaFile", "xmlName"],
+      "additionalProperties": false
+    }
+  }
+}