@salesforce/plugin-command-reference 3.0.72 → 3.0.74

package/README.md

@@ -81,9 +81,74 @@ Now diff the output. Changes should be intentional!
 
 <!-- commands -->
 
-# Command Topics
+- [`sf commandreference generate`](#sf-commandreference-generate)
+- [`sf jit install`](#sf-jit-install)
 
-- [`sf commandreference`](docs/commandreference.md) - generate the Salesforce CLI command reference guide.
-- [`sf jit`](docs/jit.md) - description for jit
+## `sf commandreference generate`
+
+generate the command reference guide located
+
+```
+USAGE
+  $ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--error-on-warnings] [-c
+    <value>]
+
+FLAGS
+  -a, --all                     include all relevant plugins in the generation
+  -c, --config-path=<value>     A path to the directory containing a plugin or cli
+  -d, --output-dir=<value>      [default: ./tmp/root] output directory to put generated files
+  -p, --plugins=<value>...      comma separated list of plugin names to be part of the generation. Defaults to the oclif
+                                plugin in the current working directory
+  -s, --ditamap-suffix=<value>  [default: unified] unique suffix to append to generated ditamap
+      --error-on-warnings       fail the command if there are any warnings
+      --hidden                  show hidden commands
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  generate the command reference guide located
+
+  generate the command reference guide located
+
+EXAMPLES
+  Generate the command reference guide
+
+    $ sf commandreference generate
+
+  Generate the command reference for a set of plugins
+
+    $ sf commandreference generate --plugins pluginA,pluginB
+
+  Generate the command reference for all plugins
+
+    $ sf commandreference generate --all --output-dir ./docs
+
+  Generate the command reference for all plugins in a directory
+
+    $ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
+```
+
+_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/commandreference/generate.ts)_
+
+## `sf jit install`
+
+Install all JIT plugins.
+
+```
+USAGE
+  $ sf jit install [--json] [-d]
+
+FLAGS
+  -d, --dry-run  List the plugins that would be installed.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+EXAMPLES
+  $ sf jit install
+```
+
+_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/jit/install.ts)_
 
 <!-- commandsstop -->

package/npm-shrinkwrap.json

@@ -1,17 +1,17 @@
 {
   "name": "@salesforce/plugin-command-reference",
-  "version": "3.0.72",
+  "version": "3.0.74",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/plugin-command-reference",
-      "version": "3.0.72",
+      "version": "3.0.74",
       "license": "BSD-3-Clause",
       "dependencies": {
-        "@oclif/core": "^3.20.0",
+        "@oclif/core": "^3.26.0",
         "@salesforce/core": "^6.7.3",
-        "@salesforce/kit": "^3.0.15",
+        "@salesforce/kit": "^3.1.0",
         "@salesforce/sf-plugins-core": "^5.0.13",
         "@salesforce/ts-types": "^2.0.9",
         "chalk": "^4",
@@ -24,7 +24,7 @@
         "@salesforce/plugin-auth": "^2.8.26",
         "@types/debug": "^4.1.12",
         "@types/ejs": "^3.1.5",
-        "eslint-plugin-sf-plugin": "^1.17.4",
+        "eslint-plugin-sf-plugin": "^1.17.5",
         "oclif": "^4",
         "ts-node": "^10.9.2",
         "typescript": "^5.4.3"
@@ -2827,9 +2827,9 @@
       }
     },
     "node_modules/@oclif/core": {
-      "version": "3.25.2",
-      "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.25.2.tgz",
-      "integrity": "sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==",
+      "version": "3.26.0",
+      "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.26.0.tgz",
+      "integrity": "sha512-TpMdfD4tfA2tVVbd4l0PrP02o5KoUXYmudBbTC7CeguDo/GLoprw4uL8cMsaVA26+cbcy7WYtOEydQiHVtJixA==",
       "license": "MIT",
       "dependencies": {
         "@types/cli-progress": "^3.11.5",
@@ -2976,13 +2976,13 @@
       }
     },
     "node_modules/@oclif/plugin-warn-if-update-available": {
-      "version": "3.0.12",
-      "resolved": "https://registry.npmjs.org/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.0.12.tgz",
-      "integrity": "sha512-BPj+1dSgp9Xtd5BZjLF9s0PeYBl07GSF69aol6/ZUMJMWD78SUWgAAm2SMJJBXic7Lw8hIGBY/YSGXDGaMh4gw==",
+      "version": "3.0.15",
+      "resolved": "https://registry.npmjs.org/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.0.15.tgz",
+      "integrity": "sha512-JtPTJFjL6izMCe5dDS2ix2PyWAD2DeJ5Atzd2HHRifbPcmOxaUE62FKTnarIwfPHLMF/nN33liwo9InAdirozg==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
-        "@oclif/core": "^3.19.2",
+        "@oclif/core": "^3.26.0",
         "chalk": "^5.3.0",
         "debug": "^4.1.0",
         "http-call": "^5.2.2",
@@ -3176,9 +3176,9 @@
       }
     },
     "node_modules/@salesforce/kit": {
-      "version": "3.0.15",
-      "resolved": "https://registry.npmjs.org/@salesforce/kit/-/kit-3.0.15.tgz",
-      "integrity": "sha512-XkA8jsuLvVnyP460dAbU3pBFP2IkmmmsVxMQVifcKKbNWaIBbZBzAfj+vdaQfnvZyflLhsrFT3q2xkb0vHouPg==",
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/@salesforce/kit/-/kit-3.1.0.tgz",
+      "integrity": "sha512-X2d9O/U2wdQBXIrtVqQdMwo872Cv+qkYFzF0W+AQKG/LEe9cngnOzUVDYNkGD9tq3jcl+oenHXYuVDpkMhxTwA==",
       "license": "BSD-3-Clause",
       "dependencies": {
         "@salesforce/ts-types": "^2.0.9",
@@ -6699,13 +6699,13 @@
       }
     },
     "node_modules/eslint-plugin-sf-plugin": {
-      "version": "1.17.4",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.17.4.tgz",
-      "integrity": "sha512-6SVkegmUdXl2YnghLNXsnmjCw4gtkdAyRcxrhqpyS8vxfP3PZocKHQBuMH5aIAsA/Yb9bXcOs1gE5y0r/bD7MA==",
+      "version": "1.17.5",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.17.5.tgz",
+      "integrity": "sha512-TQlUNOwop8aGeIOY+Vtj3OV0EGN7ps2YpV9LEvgGpw7Eeg5ocULQqR6WPwuRpeRn+XUNl7AC5NVDdhveA1fEEQ==",
       "dev": true,
       "license": "BSD-3-Clause",
       "dependencies": {
-        "@salesforce/core": "^6.7.0",
+        "@salesforce/core": "^6.7.3",
         "@typescript-eslint/utils": "^6.17.0"
       },
       "engines": {
@@ -10548,9 +10548,9 @@
       }
     },
     "node_modules/oclif": {
-      "version": "4.6.2",
-      "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.6.2.tgz",
-      "integrity": "sha512-k0QUbKBYhG+iam1wL5AJ8AimLemPTX8DhxnRnhrSJnuVn6BciFwrJ19MYKPmt3w47d2MZtyOfKfyZFBlvfr1gA==",
+      "version": "4.7.2",
+      "resolved": "https://registry.npmjs.org/oclif/-/oclif-4.7.2.tgz",
+      "integrity": "sha512-OVBVw3icaC5dJtDcojn61HAtilqqVu9Uae+Cd/EVNVeAOMe2G51MpMg5RDj8B3KKvuq8EudzJkK78OWdhoTZVQ==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
@@ -10562,7 +10562,7 @@
         "@oclif/core": "^3.21.0",
         "@oclif/plugin-help": "^6.0.18",
         "@oclif/plugin-not-found": "^3.0.14",
-        "@oclif/plugin-warn-if-update-available": "^3.0.12",
+        "@oclif/plugin-warn-if-update-available": "^3.0.14",
         "async-retry": "^1.3.3",
         "chalk": "^4",
         "change-case": "^4",
@@ -10575,7 +10575,7 @@
         "lodash.template": "^4.5.0",
         "normalize-package-data": "^3.0.3",
         "semver": "^7.6.0",
-        "sort-package-json": "^2.8.0",
+        "sort-package-json": "^2.10.0",
         "validate-npm-package-name": "^5.0.0"
       },
       "bin": {
@@ -12139,9 +12139,9 @@
       "license": "MIT"
     },
     "node_modules/sort-package-json": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/sort-package-json/-/sort-package-json-2.8.0.tgz",
-      "integrity": "sha512-PxeNg93bTJWmDGnu0HADDucoxfFiKkIr73Kv85EBThlI1YQPdc0XovBgg2llD0iABZbu2SlKo8ntGmOP9wOj/g==",
+      "version": "2.10.0",
+      "resolved": "https://registry.npmjs.org/sort-package-json/-/sort-package-json-2.10.0.tgz",
+      "integrity": "sha512-MYecfvObMwJjjJskhxYfuOADkXp1ZMMnCFC8yhp+9HDsk7HhR336hd7eiBs96lTXfiqmUNI+WQCeCMRBhl251g==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
@@ -12151,6 +12151,7 @@
         "git-hooks-list": "^3.0.0",
         "globby": "^13.1.2",
         "is-plain-obj": "^4.1.0",
+        "semver": "^7.6.0",
         "sort-object-keys": "^1.1.3"
       },
       "bin": {

package/oclif.lock

@@ -1294,10 +1294,10 @@
     wordwrap "^1.0.0"
     wrap-ansi "^7.0.0"
 
-"@oclif/core@^3.15.1", "@oclif/core@^3.19.2", "@oclif/core@^3.20.0", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0":
-  version "3.25.2"
-  resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.25.2.tgz#a26d56abe5686c57c1e973957777bd2ae324e973"
-  integrity sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==
+"@oclif/core@^3.15.1", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0", "@oclif/core@^3.26.0":
+  version "3.26.0"
+  resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.26.0.tgz#959d5e9f13f4ad6a4e98235ad125189df9ee4279"
+  integrity sha512-TpMdfD4tfA2tVVbd4l0PrP02o5KoUXYmudBbTC7CeguDo/GLoprw4uL8cMsaVA26+cbcy7WYtOEydQiHVtJixA==
   dependencies:
     "@types/cli-progress" "^3.11.5"
     ansi-escapes "^4.3.2"
@@ -1344,12 +1344,12 @@
     chalk "^5.3.0"
     fast-levenshtein "^3.0.0"
 
-"@oclif/plugin-warn-if-update-available@^3.0.12":
-  version "3.0.12"
-  resolved "https://registry.yarnpkg.com/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.0.12.tgz#0802e402a74e72da1acd52e1bc9a34bd7999ed17"
-  integrity sha512-BPj+1dSgp9Xtd5BZjLF9s0PeYBl07GSF69aol6/ZUMJMWD78SUWgAAm2SMJJBXic7Lw8hIGBY/YSGXDGaMh4gw==
+"@oclif/plugin-warn-if-update-available@^3.0.14":
+  version "3.0.15"
+  resolved "https://registry.yarnpkg.com/@oclif/plugin-warn-if-update-available/-/plugin-warn-if-update-available-3.0.15.tgz#533e5914c9efc46a1539b5a5e931dbf3c32ffb52"
+  integrity sha512-JtPTJFjL6izMCe5dDS2ix2PyWAD2DeJ5Atzd2HHRifbPcmOxaUE62FKTnarIwfPHLMF/nN33liwo9InAdirozg==
   dependencies:
-    "@oclif/core" "^3.19.2"
+    "@oclif/core" "^3.26.0"
     chalk "^5.3.0"
     debug "^4.1.0"
     http-call "^5.2.2"
@@ -1384,7 +1384,7 @@
     semver "^7.5.4"
     ts-retry-promise "^0.7.1"
 
-"@salesforce/core@^6.4.1", "@salesforce/core@^6.7.0", "@salesforce/core@^6.7.3":
+"@salesforce/core@^6.4.1", "@salesforce/core@^6.7.3":
   version "6.7.3"
   resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.7.3.tgz#5d8f30c40ac3cebb898c8e845fe9a067bc729268"
   integrity sha512-uU+PuZZGXxByhvnXLH1V3eY5P1caw401dIZ/QvhzYxoP/alPLk7dpChnZNJYH5Rw3dc/AhSPw+eg0cvUyjhP1Q==
@@ -1445,10 +1445,10 @@
     typescript "^4.9.5"
     wireit "^0.14.1"
 
-"@salesforce/kit@^3.0.13", "@salesforce/kit@^3.0.15":
-  version "3.0.15"
-  resolved "https://registry.yarnpkg.com/@salesforce/kit/-/kit-3.0.15.tgz#713df3f5767f874c70a2e731c7cb5ba677989559"
-  integrity sha512-XkA8jsuLvVnyP460dAbU3pBFP2IkmmmsVxMQVifcKKbNWaIBbZBzAfj+vdaQfnvZyflLhsrFT3q2xkb0vHouPg==
+"@salesforce/kit@^3.0.13", "@salesforce/kit@^3.0.15", "@salesforce/kit@^3.1.0":
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/kit/-/kit-3.1.0.tgz#aa42533084c676e865f0f9c1907a16fb6f74dee7"
+  integrity sha512-X2d9O/U2wdQBXIrtVqQdMwo872Cv+qkYFzF0W+AQKG/LEe9cngnOzUVDYNkGD9tq3jcl+oenHXYuVDpkMhxTwA==
   dependencies:
     "@salesforce/ts-types" "^2.0.9"
     tslib "^2.6.2"
@@ -3606,12 +3606,12 @@ eslint-plugin-jsdoc@^46.9.0:
     semver "^7.5.4"
     spdx-expression-parse "^3.0.1"
 
-eslint-plugin-sf-plugin@^1.17.4:
-  version "1.17.4"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.17.4.tgz#31006e188cf534eedea0ecd6159443e61346a66c"
-  integrity sha512-6SVkegmUdXl2YnghLNXsnmjCw4gtkdAyRcxrhqpyS8vxfP3PZocKHQBuMH5aIAsA/Yb9bXcOs1gE5y0r/bD7MA==
+eslint-plugin-sf-plugin@^1.17.5:
+  version "1.17.5"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.17.5.tgz#3ce0e7033eaf50675c962e7d2def3bb2cad15018"
+  integrity sha512-TQlUNOwop8aGeIOY+Vtj3OV0EGN7ps2YpV9LEvgGpw7Eeg5ocULQqR6WPwuRpeRn+XUNl7AC5NVDdhveA1fEEQ==
   dependencies:
-    "@salesforce/core" "^6.7.0"
+    "@salesforce/core" "^6.7.3"
     "@typescript-eslint/utils" "^6.17.0"
 
 eslint-plugin-unicorn@^49.0.0:
@@ -5691,9 +5691,9 @@ object.values@^1.1.7:
     es-abstract "^1.22.1"
 
 oclif@^4:
-  version "4.6.2"
-  resolved "https://registry.yarnpkg.com/oclif/-/oclif-4.6.2.tgz#f4aec6818fad958f0b3f45996c0df31ca74060a4"
-  integrity sha512-k0QUbKBYhG+iam1wL5AJ8AimLemPTX8DhxnRnhrSJnuVn6BciFwrJ19MYKPmt3w47d2MZtyOfKfyZFBlvfr1gA==
+  version "4.7.2"
+  resolved "https://registry.yarnpkg.com/oclif/-/oclif-4.7.2.tgz#3d74b23f319870508bf8dbefc5147bfd2d46fb2d"
+  integrity sha512-OVBVw3icaC5dJtDcojn61HAtilqqVu9Uae+Cd/EVNVeAOMe2G51MpMg5RDj8B3KKvuq8EudzJkK78OWdhoTZVQ==
   dependencies:
     "@aws-sdk/client-cloudfront" "^3.535.0"
     "@aws-sdk/client-s3" "^3.535.0"
@@ -5703,7 +5703,7 @@ oclif@^4:
     "@oclif/core" "^3.21.0"
     "@oclif/plugin-help" "^6.0.18"
     "@oclif/plugin-not-found" "^3.0.14"
-    "@oclif/plugin-warn-if-update-available" "^3.0.12"
+    "@oclif/plugin-warn-if-update-available" "^3.0.14"
     async-retry "^1.3.3"
     chalk "^4"
     change-case "^4"
@@ -5716,7 +5716,7 @@ oclif@^4:
     lodash.template "^4.5.0"
     normalize-package-data "^3.0.3"
     semver "^7.6.0"
-    sort-package-json "^2.8.0"
+    sort-package-json "^2.10.0"
     validate-npm-package-name "^5.0.0"
 
 on-exit-leak-free@^2.1.0:
@@ -6603,10 +6603,10 @@ sort-object-keys@^1.1.3:
   resolved "https://registry.yarnpkg.com/sort-object-keys/-/sort-object-keys-1.1.3.tgz#bff833fe85cab147b34742e45863453c1e190b45"
   integrity sha512-855pvK+VkU7PaKYPc+Jjnmt4EzejQHyhhF33q31qG8x7maDzkeFhAAThdCYay11CISO+qAMwjOBP+fPZe0IPyg==
 
-sort-package-json@^2.8.0:
-  version "2.8.0"
-  resolved "https://registry.yarnpkg.com/sort-package-json/-/sort-package-json-2.8.0.tgz#6a46439ad0fef77f091e678e103f03ecbea575c8"
-  integrity sha512-PxeNg93bTJWmDGnu0HADDucoxfFiKkIr73Kv85EBThlI1YQPdc0XovBgg2llD0iABZbu2SlKo8ntGmOP9wOj/g==
+sort-package-json@^2.10.0:
+  version "2.10.0"
+  resolved "https://registry.yarnpkg.com/sort-package-json/-/sort-package-json-2.10.0.tgz#6be07424bf3b7db9fbb1bdd69e7945f301026d8a"
+  integrity sha512-MYecfvObMwJjjJskhxYfuOADkXp1ZMMnCFC8yhp+9HDsk7HhR336hd7eiBs96lTXfiqmUNI+WQCeCMRBhl251g==
   dependencies:
     detect-indent "^7.0.1"
     detect-newline "^4.0.0"
@@ -6614,6 +6614,7 @@ sort-package-json@^2.8.0:
     git-hooks-list "^3.0.0"
     globby "^13.1.2"
     is-plain-obj "^4.1.0"
+    semver "^7.6.0"
     sort-object-keys "^1.1.3"
 
 source-map-support@^0.5.21:

package/oclif.manifest.json

@@ -145,5 +145,5 @@
       ]
     }
   },
-  "version": "3.0.72"
+  "version": "3.0.74"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@salesforce/plugin-command-reference",
   "description": "Generate the Salesforce CLI command reference guide",
-  "version": "3.0.72",
+  "version": "3.0.74",
   "author": "Salesforce",
   "bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
   "dependencies": {
-    "@oclif/core": "^3.20.0",
+    "@oclif/core": "^3.26.0",
     "@salesforce/core": "^6.7.3",
-    "@salesforce/kit": "^3.0.15",
+    "@salesforce/kit": "^3.1.0",
     "@salesforce/sf-plugins-core": "^5.0.13",
     "@salesforce/ts-types": "^2.0.9",
     "chalk": "^4",
@@ -20,7 +20,7 @@
     "@salesforce/plugin-auth": "^2.8.26",
     "@types/debug": "^4.1.12",
     "@types/ejs": "^3.1.5",
-    "eslint-plugin-sf-plugin": "^1.17.4",
+    "eslint-plugin-sf-plugin": "^1.17.5",
     "oclif": "^4",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.3"