From c7a5c7cf5de1a6b636ef8222c38af0707ddb9cfd Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 12 Dec 2023 16:31:16 -0600 Subject: [PATCH 1/3] chore: bump things --- package.json | 14 +++++----- yarn.lock | 76 ++++++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 69 insertions(+), 21 deletions(-) diff --git a/package.json b/package.json index 6e4f7e44..7a13b53d 100644 --- a/package.json +++ b/package.json @@ -5,17 +5,17 @@ "author": "Salesforce", "bugs": "https://github.com/salesforcecli/plugin-templates/issues", "dependencies": { - "@oclif/core": "^3.11.0", - "@salesforce/core": "^6.2.2", - "@salesforce/sf-plugins-core": "^5.0.3", - "@salesforce/templates": "^59.0.2", + "@oclif/core": "^3.14.1", + "@salesforce/core": "^6.4.1", + "@salesforce/sf-plugins-core": "^5.0.8", + "@salesforce/templates": "^59.0.4", "yeoman-environment": "^3", "yeoman-generator": "^5" }, "devDependencies": { "@oclif/plugin-command-snapshot": "^5.0.3", "@salesforce/cli-plugins-testkit": "^5.1.1", - "@salesforce/dev-scripts": "^8.1.0", + "@salesforce/dev-scripts": "^8.1.1", "@salesforce/plugin-command-reference": "^3.0.51", "@types/yeoman-assert": "^3.1.4", "@types/yeoman-environment": "^2.10.9", @@ -23,8 +23,8 @@ "eslint-plugin-sf-plugin": "^1.16.15", "oclif": "^4.0.4", "shx": "^0.3.4", - "ts-node": "^10.9.1", - "typescript": "^5.2.2", + "ts-node": "^10.9.2", + "typescript": "^5.3.3", "yeoman-assert": "^3.1.1", "yeoman-test": "^6.3.0" }, diff --git a/yarn.lock b/yarn.lock index 20b19e37..4f19bf21 100644 --- a/yarn.lock +++ b/yarn.lock @@ -768,7 +768,7 @@ wordwrap "^1.0.0" wrap-ansi "^7.0.0" -"@oclif/core@^3.0.4", "@oclif/core@^3.10.8", "@oclif/core@^3.11.0", "@oclif/core@^3.13.1", "@oclif/core@^3.14.1", "@oclif/core@^3.3.1": +"@oclif/core@^3.0.4", "@oclif/core@^3.10.8", "@oclif/core@^3.13.1", "@oclif/core@^3.14.1", "@oclif/core@^3.3.1": version "3.14.1" resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.14.1.tgz#634fc96124068e47b720d62f3b278d818a07495e" integrity sha512-HLFL2s45DFdqYI2CFjVS/CIQ4cQ4yZqH0XqO9nnwcRWYboz2rEW/vLmidjIYGDjh6xA/k5psiAL3O1KEjqSHuQ== @@ -964,7 +964,7 @@ strip-ansi "6.0.1" ts-retry-promise "^0.7.1" -"@salesforce/core@^5.3.19", "@salesforce/core@^5.3.20": +"@salesforce/core@^5.3.20": version "5.3.20" resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-5.3.20.tgz#4e934d4551bb70423cb1c4115615bc41cffca41e" integrity sha512-y+O6O2c8OYFDrAy2qsG+pAcNxoyL14nmBXcBRRcYA7Huj8ikK+aLJK84PuVAYdQz+hNwImQF+69IWtDkpK4Irg== @@ -1012,15 +1012,39 @@ semver "^7.5.4" ts-retry-promise "^0.7.1" +"@salesforce/core@^6.4.1": + version "6.4.1" + resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.4.1.tgz#27edd083b62ee96d6270b60da6dfb959bff1a0a5" + integrity sha512-Bn/Pox5JLeVBg35zgSmtNU+f9wdOaa7a/hmCIvQibci1dpKtLGUmSpdHibWR6zHag8ZoRkueea7zuqEjYzECyA== + dependencies: + "@salesforce/kit" "^3.0.15" + "@salesforce/schemas" "^1.6.1" + "@salesforce/ts-types" "^2.0.9" + "@types/semver" "^7.5.6" + ajv "^8.12.0" + change-case "^4.1.2" + faye "^1.4.0" + form-data "^4.0.0" + js2xmlparser "^4.0.1" + jsforce "^2.0.0-beta.29" + jsonwebtoken "9.0.2" + jszip "3.10.1" + pino "^8.16.2" + pino-abstract-transport "^1.1.0" + pino-pretty "^10.2.3" + proper-lockfile "^4.1.2" + semver "^7.5.4" + ts-retry-promise "^0.7.1" + "@salesforce/dev-config@^4.1.0": version "4.1.0" resolved "https://registry.yarnpkg.com/@salesforce/dev-config/-/dev-config-4.1.0.tgz#e529576466d074e7a5f1441236510fef123da01e" integrity sha512-2iDDepiIwjXHS5IVY7pwv8jMo4xWosJ7p/UTj+lllpB/gnJiYLhjJPE4Z3FCGFKyvfg5jGaimCd8Ca6bLGsCQA== -"@salesforce/dev-scripts@^8.1.0": - version "8.1.0" - resolved "https://registry.yarnpkg.com/@salesforce/dev-scripts/-/dev-scripts-8.1.0.tgz#0310dc9fb4104637a237876161a40331dd382e9f" - integrity sha512-lA5uJMwfKKrbv+JMCxX8aOrwE1ihlmUfAy8SVCgBSaHNckRBDQP2zIM7S03zoXFSpUtebCndo1ODQxw+zVrK3g== +"@salesforce/dev-scripts@^8.1.1": + version "8.1.1" + resolved "https://registry.yarnpkg.com/@salesforce/dev-scripts/-/dev-scripts-8.1.1.tgz#a54733057712706b08fc5abcdccad336be01fea3" + integrity sha512-pYf8eMhv/OLTUtQcNZkUXMioInQTwNnHuiePGbhcMb2KR41Ynk63sdLWZoGDSc82c1FX0cJfY4yrNMIMpEGQjw== dependencies: "@commitlint/cli" "^17.1.2" "@commitlint/config-conventional" "^17.1.0" @@ -1043,7 +1067,7 @@ shelljs "^0.8.5" sinon "10.0.0" source-map-support "^0.5.21" - ts-node "^10.9.1" + ts-node "^10.9.2" typedoc "^0.25.3" typedoc-plugin-missing-exports "0.23.0" typescript "^4.9.5" @@ -1081,7 +1105,7 @@ resolved "https://registry.yarnpkg.com/@salesforce/schemas/-/schemas-1.6.1.tgz#7d1c071e1e509ca9d2d8a6e48ac7447dd67a534d" integrity sha512-eVy947ZMxCJReKJdgfddUIsBIbPTa/i8RwQGwxq4/ss38H5sLOAeSTaun9V7HpJ1hkpDznWKfgzYvjsst9K6ig== -"@salesforce/sf-plugins-core@^5.0.3", "@salesforce/sf-plugins-core@^5.0.5": +"@salesforce/sf-plugins-core@^5.0.5", "@salesforce/sf-plugins-core@^5.0.8": version "5.0.8" resolved "https://registry.yarnpkg.com/@salesforce/sf-plugins-core/-/sf-plugins-core-5.0.8.tgz#af023ba5c9182ab277d738e6836267aa874a4dcb" integrity sha512-NvG3E61dVzORn86bPUh9cOPCmNZPfqzjS/ShMpyu2Cpjwr3zLYAlXSqH4kg0hQUW1D/M5sAck6XcUhwMpHh5yQ== @@ -1094,12 +1118,12 @@ chalk "^4" inquirer "^8.2.5" -"@salesforce/templates@^59.0.2": - version "59.0.2" - resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-59.0.2.tgz#4a0864ecde135d5b4bb0c71c5acad4ce238d761a" - integrity sha512-vCiRJS8q8XMn4gCCVQEyxIaeQ34MSpDsy6lCnSwJOqx5e9doxK+53BxAbzdFH+iy4Ze6bOESjx4xNZg0AtT8KA== +"@salesforce/templates@^59.0.4": + version "59.0.4" + resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-59.0.4.tgz#65cf640d528c244de2c98aafcd4224fb59726435" + integrity sha512-4Z4c01WjMLU+4y3zL1XoeJWtUARAqNsQ3GxvTp5u0AnKuIqGFKh/SXyibs6YoYcBfI8sW7zFXfM2NRyKYeeUOg== dependencies: - "@salesforce/core" "^5.3.19" + "@salesforce/core" "^5.3.20" "@salesforce/kit" "^3.0.15" got "^11.8.2" hpagent "^1.2.0" @@ -7593,6 +7617,25 @@ ts-node@^10.8.1, ts-node@^10.9.1: v8-compile-cache-lib "^3.0.1" yn "3.1.1" +ts-node@^10.9.2: + version "10.9.2" + resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f" + integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ== + dependencies: + "@cspotcode/source-map-support" "^0.8.0" + "@tsconfig/node10" "^1.0.7" + "@tsconfig/node12" "^1.0.7" + "@tsconfig/node14" "^1.0.0" + "@tsconfig/node16" "^1.0.2" + acorn "^8.4.1" + acorn-walk "^8.1.1" + arg "^4.1.0" + create-require "^1.1.0" + diff "^4.0.1" + make-error "^1.1.1" + v8-compile-cache-lib "^3.0.1" + yn "3.1.1" + ts-retry-promise@^0.7.1: version "0.7.1" resolved "https://registry.yarnpkg.com/ts-retry-promise/-/ts-retry-promise-0.7.1.tgz#176d6eee6415f07b6c7c286d3657355e284a6906" @@ -7744,7 +7787,7 @@ typedoc@^0.25.3: minimatch "^9.0.3" shiki "^0.14.1" -"typescript@^4.6.4 || ^5.2.2", typescript@^5.2.2, typescript@~5.2.2: +"typescript@^4.6.4 || ^5.2.2", typescript@~5.2.2: version "5.2.2" resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78" integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w== @@ -7754,6 +7797,11 @@ typescript@^4.9.5: resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g== +typescript@^5.3.3: + version "5.3.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.3.tgz#b3ce6ba258e72e6305ba66f5c9b452aaee3ffe37" + integrity sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw== + uglify-js@^3.1.4: version "3.17.4" resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.17.4.tgz#61678cf5fa3f5b7eb789bb345df29afb8257c22c" From 2723809945798ce62a704efb848134f8ba56cd0f Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 12 Dec 2023 16:32:05 -0600 Subject: [PATCH 2/3] chore: lockfile --- yarn.lock | 63 +++++++++---------------------------------------------- 1 file changed, 10 insertions(+), 53 deletions(-) diff --git a/yarn.lock b/yarn.lock index 4f19bf21..0035ce08 100644 --- a/yarn.lock +++ b/yarn.lock @@ -988,31 +988,7 @@ semver "^7.5.4" ts-retry-promise "^0.7.1" -"@salesforce/core@^6.2.2", "@salesforce/core@^6.4.0": - version "6.4.0" - resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.4.0.tgz#09e856194c8dad5bd0d86e271e84c3c47304f508" - integrity sha512-zbUuOll6RnaOyO6vHGjaO6mv2SBimu2JzInubBrbx+bgw5KFVT0y+OrN0gEhBPS94VoC9/N6ZRKve+vQ82zmmA== - dependencies: - "@salesforce/kit" "^3.0.15" - "@salesforce/schemas" "^1.6.1" - "@salesforce/ts-types" "^2.0.9" - "@types/semver" "^7.5.6" - ajv "^8.12.0" - change-case "^4.1.2" - faye "^1.4.0" - form-data "^4.0.0" - js2xmlparser "^4.0.1" - jsforce "^2.0.0-beta.29" - jsonwebtoken "9.0.2" - jszip "3.10.1" - pino "^8.16.2" - pino-abstract-transport "^1.1.0" - pino-pretty "^10.2.3" - proper-lockfile "^4.1.2" - semver "^7.5.4" - ts-retry-promise "^0.7.1" - -"@salesforce/core@^6.4.1": +"@salesforce/core@^6.2.2", "@salesforce/core@^6.4.0", "@salesforce/core@^6.4.1": version "6.4.1" resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.4.1.tgz#27edd083b62ee96d6270b60da6dfb959bff1a0a5" integrity sha512-Bn/Pox5JLeVBg35zgSmtNU+f9wdOaa7a/hmCIvQibci1dpKtLGUmSpdHibWR6zHag8ZoRkueea7zuqEjYzECyA== @@ -7598,26 +7574,7 @@ ts-json-schema-generator@^1.4.0: safe-stable-stringify "^2.4.3" typescript "~5.2.2" -ts-node@^10.8.1, ts-node@^10.9.1: - version "10.9.1" - resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.1.tgz#e73de9102958af9e1f0b168a6ff320e25adcff4b" - integrity sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw== - dependencies: - "@cspotcode/source-map-support" "^0.8.0" - "@tsconfig/node10" "^1.0.7" - "@tsconfig/node12" "^1.0.7" - "@tsconfig/node14" "^1.0.0" - "@tsconfig/node16" "^1.0.2" - acorn "^8.4.1" - acorn-walk "^8.1.1" - arg "^4.1.0" - create-require "^1.1.0" - diff "^4.0.1" - make-error "^1.1.1" - v8-compile-cache-lib "^3.0.1" - yn "3.1.1" - -ts-node@^10.9.2: +ts-node@^10.8.1, ts-node@^10.9.1, ts-node@^10.9.2: version "10.9.2" resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f" integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ== @@ -7787,20 +7744,20 @@ typedoc@^0.25.3: minimatch "^9.0.3" shiki "^0.14.1" -"typescript@^4.6.4 || ^5.2.2", typescript@~5.2.2: - version "5.2.2" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78" - integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w== +"typescript@^4.6.4 || ^5.2.2", typescript@^5.3.3: + version "5.3.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.3.tgz#b3ce6ba258e72e6305ba66f5c9b452aaee3ffe37" + integrity sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw== typescript@^4.9.5: version "4.9.5" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g== -typescript@^5.3.3: - version "5.3.3" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.3.tgz#b3ce6ba258e72e6305ba66f5c9b452aaee3ffe37" - integrity sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw== +typescript@~5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78" + integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w== uglify-js@^3.1.4: version "3.17.4" From ee573d240bad0731a40077ebe48d52c063df3138 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 12 Dec 2023 18:13:10 -0600 Subject: [PATCH 3/3] chore: update readme for broken links --- README.md | 804 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 569 insertions(+), 235 deletions(-) diff --git a/README.md b/README.md index fb488974..df1cfcd0 100644 --- a/README.md +++ b/README.md @@ -116,396 +116,730 @@ Congrats, you are debugging! # Commands -A list of the available commands + -#### `sfdx force:apex:class:create` +- [`sf analytics generate template`](#sf-analytics-generate-template) +- [`sf apex generate class`](#sf-apex-generate-class) +- [`sf apex generate trigger`](#sf-apex-generate-trigger) +- [`sf lightning generate app`](#sf-lightning-generate-app) +- [`sf lightning generate component`](#sf-lightning-generate-component) +- [`sf lightning generate event`](#sf-lightning-generate-event) +- [`sf lightning generate interface`](#sf-lightning-generate-interface) +- [`sf lightning generate test`](#sf-lightning-generate-test) +- [`sf project generate`](#sf-project-generate) +- [`sf static-resource generate`](#sf-static-resource-generate) +- [`sf visualforce generate component`](#sf-visualforce-generate-component) +- [`sf visualforce generate page`](#sf-visualforce-generate-page) -create an Apex class +## `sf analytics generate template` + +Generate a simple Analytics template. ``` USAGE - $ sfdx force:apex:class:create -n [-d ] [-t ] [--apiversion ] [--json] [--loglevel - trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sf analytics generate template -n [--json] [-d ] [--api-version ] -OPTIONS - -d, --outputdir=outputdir folder for saving the created files +FLAGS + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the Analytics template. + --api-version= Override the api version used for api requests made by this command - -n, --classname=classname(required) name of the generated Apex class +GLOBAL FLAGS + --json Format output as json. - -t, --template=ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService [default: DefaultApexClass] template - to use for file creation +DESCRIPTION + Generate a simple Analytics template. - --apiversion=apiversion override the api version used for - api requests made by this command + The metadata files associated with the Analytics template must be contained in a parent directory called + "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the + --output-dir flag to generate one or point to an existing one. - --json format output as json +ALIASES + $ sf force analytics template create - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for - this command invocation +EXAMPLES + Generate the metadata files for a simple Analytics template file called myTemplate in the + force-app/main/default/waveTemplates directory: -DESCRIPTION - If not supplied, the apiversion, template, and outputdir use default values. - The outputdir can be an absolute path or relative to the current working directory. + $ sf analytics generate template --name myTemplate --output-dir force-app/main/default/waveTemplates -EXAMPLES - $ sfdx force:apex:class:create -n MyClass - $ sfdx force:apex:class:create -n MyClass -d classes +FLAG DESCRIPTIONS + -d, --output-dir= Directory for saving the created files. + + The location can be an absolute path or relative to the current working directory. The default is the current + directory. ``` -_See code: [src/commands/force/apex/class/create.ts](https://github.com/salesforcecli/plugin-templates/blob/master/src/commands/force/apex/class/create.ts)_ +_See code: [src/commands/analytics/generate/template.ts](https://github.com/salesforcecli/plugin-templates/blob/main/src/commands/analytics/generate/template.ts)_ -#### `sfdx force:apex:trigger:create` +## `sf apex generate class` -create an Apex trigger +Generate an Apex class. ``` USAGE - $ sfdx force:apex:trigger:create -n [-d ] [-e ] [-s ] [-t ] [--apiversion - ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sf apex generate class -n [--json] [-t ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService] [-d + ] [--api-version ] -OPTIONS - -d, --outputdir=outputdir folder for saving the created files +FLAGS + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the generated Apex class. + -t, --template=