Merge pull request #325 from salesforcecli/cd/sf-style

feat: move commands to sf style

Author: WillieRuemmele

.eslintrc.js

@@ -5,5 +5,5 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 module.exports = {
-  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license'],
+  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license', 'plugin:sf-plugin/recommended'],
 };

CHANGELOG.md

@@ -1,261 +1,170 @@
 ## [2.1.19](https://github.com/salesforcecli/plugin-schema/compare/2.1.18...2.1.19) (2022-12-11)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.20.4 to 1.21.0 ([6ce1938](https://github.com/salesforcecli/plugin-schema/commit/6ce1938d14b6431859b40cb70f5c62596e0b3cb6))
-
-
+- **deps:** bump @oclif/core from 1.20.4 to 1.21.0 ([6ce1938](https://github.com/salesforcecli/plugin-schema/commit/6ce1938d14b6431859b40cb70f5c62596e0b3cb6))
 
 ## [2.1.18](https://github.com/salesforcecli/plugin-schema/compare/2.1.17...2.1.18) (2022-12-05)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.32.2 to 3.32.6 ([4e87f74](https://github.com/salesforcecli/plugin-schema/commit/4e87f74b8e257d56ffe61b5942db88fcb2b12ef1))
-
-
+- **deps:** bump @salesforce/core from 3.32.2 to 3.32.6 ([4e87f74](https://github.com/salesforcecli/plugin-schema/commit/4e87f74b8e257d56ffe61b5942db88fcb2b12ef1))
 
 ## [2.1.17](https://github.com/salesforcecli/plugin-schema/compare/2.1.16...2.1.17) (2022-11-27)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.32.1 to 3.32.2 ([7d980ae](https://github.com/salesforcecli/plugin-schema/commit/7d980aeb8b1ea385bd84fe1b30b3c2e5f6d99f15))
-
-
+- **deps:** bump @salesforce/core from 3.32.1 to 3.32.2 ([7d980ae](https://github.com/salesforcecli/plugin-schema/commit/7d980aeb8b1ea385bd84fe1b30b3c2e5f6d99f15))
 
 ## [2.1.16](https://github.com/salesforcecli/plugin-schema/compare/2.1.15...2.1.16) (2022-11-20)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/command from 5.2.20 to 5.2.25 ([5a71228](https://github.com/salesforcecli/plugin-schema/commit/5a71228c1ffe373dd4b78f8597fe969c5a4341a5))
-
-
+- **deps:** bump @salesforce/command from 5.2.20 to 5.2.25 ([5a71228](https://github.com/salesforcecli/plugin-schema/commit/5a71228c1ffe373dd4b78f8597fe969c5a4341a5))
 
 ## [2.1.15](https://github.com/salesforcecli/plugin-schema/compare/2.1.14...2.1.15) (2022-11-13)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.20.3 to 1.20.4 ([82a459c](https://github.com/salesforcecli/plugin-schema/commit/82a459c8fe1aca7f09fe721f4152f83ba86eb7e9))
-
-
+- **deps:** bump @oclif/core from 1.20.3 to 1.20.4 ([82a459c](https://github.com/salesforcecli/plugin-schema/commit/82a459c8fe1aca7f09fe721f4152f83ba86eb7e9))
 
 ## [2.1.14](https://github.com/salesforcecli/plugin-schema/compare/2.1.13...2.1.14) (2022-11-13)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.31.17 to 3.31.19 ([4bbdccc](https://github.com/salesforcecli/plugin-schema/commit/4bbdcccaf28d9ca0a1c78ac052fc5addc51bfdcb))
-
-
+- **deps:** bump @salesforce/core from 3.31.17 to 3.31.19 ([4bbdccc](https://github.com/salesforcecli/plugin-schema/commit/4bbdcccaf28d9ca0a1c78ac052fc5addc51bfdcb))
 
 ## [2.1.13](https://github.com/salesforcecli/plugin-schema/compare/2.1.12...2.1.13) (2022-11-06)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/command from 5.2.16 to 5.2.20 ([e4d88ae](https://github.com/salesforcecli/plugin-schema/commit/e4d88ae2b18f6b6d39d141089b4a3cf6a9528af5))
-
-
+- **deps:** bump @salesforce/command from 5.2.16 to 5.2.20 ([e4d88ae](https://github.com/salesforcecli/plugin-schema/commit/e4d88ae2b18f6b6d39d141089b4a3cf6a9528af5))
 
 ## [2.1.12](https://github.com/salesforcecli/plugin-schema/compare/2.1.11...2.1.12) (2022-10-30)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.19.1 to 1.20.0 ([c2f4474](https://github.com/salesforcecli/plugin-schema/commit/c2f4474ca4b1189d66e32b42cf470d7ea1dee412))
-
-
+- **deps:** bump @oclif/core from 1.19.1 to 1.20.0 ([c2f4474](https://github.com/salesforcecli/plugin-schema/commit/c2f4474ca4b1189d66e32b42cf470d7ea1dee412))
 
 ## [2.1.11](https://github.com/salesforcecli/plugin-schema/compare/2.1.10...2.1.11) (2022-10-24)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.16.4 to 1.19.1 ([14c66c9](https://github.com/salesforcecli/plugin-schema/commit/14c66c9a2afecef157c46d475b327c13167b07ab))
-
-
+- **deps:** bump @oclif/core from 1.16.4 to 1.19.1 ([14c66c9](https://github.com/salesforcecli/plugin-schema/commit/14c66c9a2afecef157c46d475b327c13167b07ab))
 
 ## [2.1.10](https://github.com/salesforcecli/plugin-schema/compare/2.1.9...2.1.10) (2022-10-02)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/command from 5.2.8 to 5.2.11 ([2f187ab](https://github.com/salesforcecli/plugin-schema/commit/2f187abd12e16fecccce222febc52d48a29e96b9))
-
-
+- **deps:** bump @salesforce/command from 5.2.8 to 5.2.11 ([2f187ab](https://github.com/salesforcecli/plugin-schema/commit/2f187abd12e16fecccce222febc52d48a29e96b9))
 
 ## [2.1.9](https://github.com/salesforcecli/plugin-schema/compare/2.1.8...2.1.9) (2022-09-30)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.30.8 to 3.30.9 ([bc6e8be](https://github.com/salesforcecli/plugin-schema/commit/bc6e8be6b609d25f32453c7dc47af20354fb0ab8))
-
-
+- **deps:** bump @salesforce/core from 3.30.8 to 3.30.9 ([bc6e8be](https://github.com/salesforcecli/plugin-schema/commit/bc6e8be6b609d25f32453c7dc47af20354fb0ab8))
 
 ## [2.1.8](https://github.com/salesforcecli/plugin-schema/compare/2.1.7...2.1.8) (2022-09-25)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.16.3 to 1.16.4 ([4cd6cdd](https://github.com/salesforcecli/plugin-schema/commit/4cd6cdd394ac39d2dde8d4e9f161cb2ab0a48cb7))
-
-
+- **deps:** bump @oclif/core from 1.16.3 to 1.16.4 ([4cd6cdd](https://github.com/salesforcecli/plugin-schema/commit/4cd6cdd394ac39d2dde8d4e9f161cb2ab0a48cb7))
 
 ## [2.1.7](https://github.com/salesforcecli/plugin-schema/compare/2.1.6...2.1.7) (2022-09-25)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.30.2 to 3.30.8 ([ffda6ef](https://github.com/salesforcecli/plugin-schema/commit/ffda6ef44d96048331a3c2ec17d9ad9e0590b650))
-
-
+- **deps:** bump @salesforce/core from 3.30.2 to 3.30.8 ([ffda6ef](https://github.com/salesforcecli/plugin-schema/commit/ffda6ef44d96048331a3c2ec17d9ad9e0590b650))
 
 ## [2.1.6](https://github.com/salesforcecli/plugin-schema/compare/2.1.5...2.1.6) (2022-09-18)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/command from 5.2.6 to 5.2.8 ([2ffb46c](https://github.com/salesforcecli/plugin-schema/commit/2ffb46cd628c0030f016bf5fe2a107672aa74b78))
-
-
+- **deps:** bump @salesforce/command from 5.2.6 to 5.2.8 ([2ffb46c](https://github.com/salesforcecli/plugin-schema/commit/2ffb46cd628c0030f016bf5fe2a107672aa74b78))
 
 ## [2.1.5](https://github.com/salesforcecli/plugin-schema/compare/2.1.4...2.1.5) (2022-09-18)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.30.0 to 3.30.2 ([94b6206](https://github.com/salesforcecli/plugin-schema/commit/94b6206ac78b74032ac15d4084fde6c2d22bb92c))
-
-
+- **deps:** bump @salesforce/core from 3.30.0 to 3.30.2 ([94b6206](https://github.com/salesforcecli/plugin-schema/commit/94b6206ac78b74032ac15d4084fde6c2d22bb92c))
 
 ## [2.1.4](https://github.com/salesforcecli/plugin-schema/compare/2.1.3...2.1.4) (2022-09-18)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.16.1 to 1.16.3 ([c2a0793](https://github.com/salesforcecli/plugin-schema/commit/c2a0793eaee556fd2a74167737bde4d46d598cab))
-
-
+- **deps:** bump @oclif/core from 1.16.1 to 1.16.3 ([c2a0793](https://github.com/salesforcecli/plugin-schema/commit/c2a0793eaee556fd2a74167737bde4d46d598cab))
 
 ## [2.1.3](https://github.com/salesforcecli/plugin-schema/compare/2.1.2...2.1.3) (2022-09-15)
 
-
 ### Bug Fixes
 
-* **deps:** bump @salesforce/core from 3.26.2 to 3.30.0 ([91dde03](https://github.com/salesforcecli/plugin-schema/commit/91dde033663118cf9b0c5a9e29227b40f23158f2))
-
-
+- **deps:** bump @salesforce/core from 3.26.2 to 3.30.0 ([91dde03](https://github.com/salesforcecli/plugin-schema/commit/91dde033663118cf9b0c5a9e29227b40f23158f2))
 
 ## [2.1.2](https://github.com/salesforcecli/plugin-schema/compare/v2.1.1...2.1.2) (2022-09-14)
 
-
 ### Bug Fixes
 
-* **deps:** bump @oclif/core from 1.16.0 to 1.16.1 ([e574a2f](https://github.com/salesforcecli/plugin-schema/commit/e574a2f3f90c6f9107bb44e42294325fee73048c))
-
-
+- **deps:** bump @oclif/core from 1.16.0 to 1.16.1 ([e574a2f](https://github.com/salesforcecli/plugin-schema/commit/e574a2f3f90c6f9107bb44e42294325fee73048c))
 
 ## [2.1.1](https://github.com/salesforcecli/plugin-schema/compare/v2.1.0...v2.1.1) (2022-05-20)
 
-
 ### Bug Fixes
 
-* add prompt to examples ([335b171](https://github.com/salesforcecli/plugin-schema/commit/335b1715514397c9f6082365f6b10845448f6016))
-* add prompt to examples ([e5956d1](https://github.com/salesforcecli/plugin-schema/commit/e5956d10b80bae20a5a39b9d840dddb875d2aa78))
-
-
+- add prompt to examples ([335b171](https://github.com/salesforcecli/plugin-schema/commit/335b1715514397c9f6082365f6b10845448f6016))
+- add prompt to examples ([e5956d1](https://github.com/salesforcecli/plugin-schema/commit/e5956d10b80bae20a5a39b9d840dddb875d2aa78))
 
 # [2.1.0](https://github.com/salesforcecli/plugin-schema/compare/v2.0.0...v2.1.0) (2022-05-04)
 
-
 ### Features
 
-* bump schema validation ([78dcffc](https://github.com/salesforcecli/plugin-schema/commit/78dcffc9945a9f15f8a9740f8d8c1257166b97ba))
-
-
+- bump schema validation ([78dcffc](https://github.com/salesforcecli/plugin-schema/commit/78dcffc9945a9f15f8a9740f8d8c1257166b97ba))
 
 # [2.0.0](https://github.com/salesforcecli/plugin-schema/compare/v1.1.0...v2.0.0) (2022-04-06)
 
-
 ### Bug Fixes
 
-* parking orbit plugin-schema ([ea87123](https://github.com/salesforcecli/plugin-schema/commit/ea87123101d6a34e0d017f124c3caba62a0ad63b))
-
-
+- parking orbit plugin-schema ([ea87123](https://github.com/salesforcecli/plugin-schema/commit/ea87123101d6a34e0d017f124c3caba62a0ad63b))
 
 # [1.1.0](https://github.com/salesforcecli/plugin-schema/compare/v1.0.10...v1.1.0) (2021-12-02)
 
-
 ### Features
 
-* bump deps ([75830fa](https://github.com/salesforcecli/plugin-schema/commit/75830fa414f40d1fc4f0731eaba9f6d977ceb779))
-
-
+- bump deps ([75830fa](https://github.com/salesforcecli/plugin-schema/commit/75830fa414f40d1fc4f0731eaba9f6d977ceb779))
 
 ## [1.0.10](https://github.com/salesforcecli/plugin-schema/compare/v1.0.9...v1.0.10) (2021-10-12)
 
-
 ### Bug Fixes
 
-* update dependencies ([299c7e9](https://github.com/salesforcecli/plugin-schema/commit/299c7e9582ccc16026c27b4a27afdc072013b697))
-
-
+- update dependencies ([299c7e9](https://github.com/salesforcecli/plugin-schema/commit/299c7e9582ccc16026c27b4a27afdc072013b697))
 
 ## [1.0.9](https://github.com/salesforcecli/plugin-schema/compare/v1.0.8...v1.0.9) (2021-10-12)
 
-
-
 ## [1.0.8](https://github.com/salesforcecli/plugin-schema/compare/v1.0.7...v1.0.8) (2021-07-01)
 
-
-
 ## [1.0.7](https://github.com/salesforcecli/plugin-schema/compare/v1.0.6...v1.0.7) (2021-05-10)
 
-
-
 ## [1.0.6](https://github.com/salesforcecli/plugin-schema/compare/v1.0.5...v1.0.6) (2021-04-13)
 
-
-
 ## [1.0.5](https://github.com/salesforcecli/plugin-schema/compare/v1.0.4...v1.0.5) (2021-04-01)
 
-
 ### Bug Fixes
 
-* leif .yml merge [skip-validate-pr] ([95bb8e0](https://github.com/salesforcecli/plugin-schema/commit/95bb8e0014ff5df3c6f59aa701762732b9a5c568))
-
-
+- leif .yml merge [skip-validate-pr] ([95bb8e0](https://github.com/salesforcecli/plugin-schema/commit/95bb8e0014ff5df3c6f59aa701762732b9a5c568))
 
 ## [1.0.4](https://github.com/salesforcecli/plugin-schema/compare/v1.0.3...v1.0.4) (2021-02-19)
 
-
-
 ## [1.0.3](https://github.com/salesforcecli/plugin-schema/compare/v1.0.2...v1.0.3) (2020-12-17)
 
-
 ### Bug Fixes
 
-* bumped npm release to v4 ([f31cf21](https://github.com/salesforcecli/plugin-schema/commit/f31cf213a24066f60f3884ffee2f64855cc19f4e))
-
-
+- bumped npm release to v4 ([f31cf21](https://github.com/salesforcecli/plugin-schema/commit/f31cf213a24066f60f3884ffee2f64855cc19f4e))
 
 ## [1.0.2](https://github.com/salesforcecli/plugin-schema/compare/v1.0.1...v1.0.2) (2020-12-10)
 
-
-
 ## [1.0.1](https://github.com/salesforcecli/plugin-schema/compare/v1.0.0...v1.0.1) (2020-11-04)
 
-
 ### Bug Fixes
 
-* added github-release: true to circleci config ([95eddac](https://github.com/salesforcecli/plugin-schema/commit/95eddac37fe43e0e36e741af2d00ffc7b499c663))
-* schema list and describe ([ccd3a9d](https://github.com/salesforcecli/plugin-schema/commit/ccd3a9d5c62e1bced20580ee17308f3936967d9d))
-* update readme ([63658f2](https://github.com/salesforcecli/plugin-schema/commit/63658f2bdd94e0c64b18bfe78398d9175da11ed1))
-
-
-
+- added github-release: true to circleci config ([95eddac](https://github.com/salesforcecli/plugin-schema/commit/95eddac37fe43e0e36e741af2d00ffc7b499c663))
+- schema list and describe ([ccd3a9d](https://github.com/salesforcecli/plugin-schema/commit/ccd3a9d5c62e1bced20580ee17308f3936967d9d))
+- update readme ([63658f2](https://github.com/salesforcecli/plugin-schema/commit/63658f2bdd94e0c64b18bfe78398d9175da11ed1))

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Salesforce.com, Inc.
+Copyright (c) 2023, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

command-snapshot.json

@@ -1,14 +1,14 @@
 [
   {
-    "command": "force:schema:sobject:describe",
+    "command": "sobject:describe",
     "plugin": "@salesforce/plugin-schema",
-    "flags": ["apiversion", "json", "loglevel", "sobjecttype", "targetusername", "usetoolingapi"],
-    "alias": []
+    "flags": ["api-version", "json", "loglevel", "sobject", "target-org", "use-tooling-api"],
+    "alias": ["force:schema:sobject:describe"]
   },
   {
-    "command": "force:schema:sobject:list",
+    "command": "sobject:list",
     "plugin": "@salesforce/plugin-schema",
-    "flags": ["apiversion", "json", "loglevel", "sobjecttypecategory", "targetusername"],
-    "alias": []
+    "flags": ["api-version", "json", "loglevel", "sobject", "target-org"],
+    "alias": ["force:schema:sobject:list"]
   }
 ]

messages/describe.json

@@ -0,0 +1,31 @@
+# summary
+
+Display the metadata for a standard or custom object or a Tooling API object.
+
+# description
+
+The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.
+
+This command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.
+
+# examples
+
+- Display the metadata of the "Account" standard object in your default org:
+
+  <%= config.bin %> <%= command.id %> --sobject Account
+
+- Display the metadata of the "MyObject__c" custom object in the org with alias "my-scratch-org":
+
+  <%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org
+
+- Display the metadata of the ApexCodeCoverage Tooling API object in your default org:
+
+  <%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api
+
+# flags.sobject.summary
+
+API name of the object to describe.
+
+# flags.tooling-api.summary
+
+Use Tooling API to display metadata for Tooling API objects.