diff --git a/CHANGELOG.md b/CHANGELOG.md index fa0cb25..1ad5552 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,24 +1,82 @@ +## [1.3.2](https://github.com/k-capehart/kc-sf-plugin/compare/1.3.0...1.3.2) (2024-05-28) + + +### Bug Fixes + +* remove postinstall ([a028068](https://github.com/k-capehart/kc-sf-plugin/commit/a0280687d8c0d6a3a26608c74093a8dd5970a8bf)) + + + +# [1.3.0](https://github.com/k-capehart/kc-sf-plugin/compare/1.2.1...1.3.0) (2024-05-28) + + + +## [1.2.1](https://github.com/k-capehart/kc-sf-plugin/compare/1.2.0...1.2.1) (2024-05-22) + + + +# [1.2.0](https://github.com/k-capehart/kc-sf-plugin/compare/1.1.9...1.2.0) (2024-05-22) + + + +## [1.1.6](https://github.com/k-capehart/kc-sf-plugin/compare/1.1.5...1.1.6) (2024-05-22) + + + +## [1.1.5](https://github.com/k-capehart/kc-sf-plugin/compare/1.1.4...1.1.5) (2024-05-22) + + + +## [1.1.4](https://github.com/k-capehart/kc-sf-plugin/compare/1.1.3...1.1.4) (2024-05-22) + + + +## [1.1.3](https://github.com/k-capehart/kc-sf-plugin/compare/1.1.2...1.1.3) (2024-05-22) + + +### Bug Fixes + +* add command in workflow to create .npmrc ([a2482d8](https://github.com/k-capehart/kc-sf-plugin/commit/a2482d8a187c74ffd1dd77d304b7c2f1c7438990)) +* package name ([5648c20](https://github.com/k-capehart/kc-sf-plugin/commit/5648c201e62e980558ce88f2b07581073e54f301)) +* rename token ([35f0bed](https://github.com/k-capehart/kc-sf-plugin/commit/35f0bed2ccf8f31100f004e15eac7235d390832e)) +* worflow testing ([5319403](https://github.com/k-capehart/kc-sf-plugin/commit/5319403be720234ede07c2bf01305a34c6dc3b97)) + + + # [1.1.0](https://github.com/k-capehart/kc-sf-plugin/compare/1.0.3...1.1.0) (2024-05-21) + ### Features -- diff command with basic test ([5968779](https://github.com/k-capehart/kc-sf-plugin/commit/5968779ea3de0e3cc83264aacb9a43b5ca30c587)) -- diff local project with org ([6f8b98a](https://github.com/k-capehart/kc-sf-plugin/commit/6f8b98a4f5fae4b86fa20c9f81d321c717bc7d98)) +* diff command with basic test ([5968779](https://github.com/k-capehart/kc-sf-plugin/commit/5968779ea3de0e3cc83264aacb9a43b5ca30c587)) +* diff local project with org ([6f8b98a](https://github.com/k-capehart/kc-sf-plugin/commit/6f8b98a4f5fae4b86fa20c9f81d321c717bc7d98)) + + ## [1.0.3](https://github.com/k-capehart/kc-sf-plugin/compare/1.0.2...1.0.3) (2024-05-17) + ### Bug Fixes -- **deps:** bump @salesforce/sf-plugins-core from 9.0.1 to 9.0.10 ([ae111fe](https://github.com/k-capehart/kc-sf-plugin/commit/ae111fea7d5fb58bb07d0291a0de426942a0bb73)) +* **deps:** bump @salesforce/sf-plugins-core from 9.0.1 to 9.0.10 ([ae111fe](https://github.com/k-capehart/kc-sf-plugin/commit/ae111fea7d5fb58bb07d0291a0de426942a0bb73)) + + ## [1.0.2](https://github.com/k-capehart/kc-sf-plugin/compare/1.0.1...1.0.2) (2024-05-17) + ### Bug Fixes -- **deps:** bump @salesforce/core from 7.3.3 to 7.3.8 ([3ce2d5d](https://github.com/k-capehart/kc-sf-plugin/commit/3ce2d5d8372b81e5ad434379cc52277cd578a252)) +* **deps:** bump @salesforce/core from 7.3.3 to 7.3.8 ([3ce2d5d](https://github.com/k-capehart/kc-sf-plugin/commit/3ce2d5d8372b81e5ad434379cc52277cd578a252)) + + ## [1.0.1](https://github.com/k-capehart/kc-sf-plugin/compare/2d967be5c615ba15e1be2b96e6135bdbf7a92bb9...1.0.1) (2024-05-17) + ### Bug Fixes -- **deps:** bump @babel/traverse from 7.19.1 to 7.24.5 ([2d967be](https://github.com/k-capehart/kc-sf-plugin/commit/2d967be5c615ba15e1be2b96e6135bdbf7a92bb9)) +* **deps:** bump @babel/traverse from 7.19.1 to 7.24.5 ([2d967be](https://github.com/k-capehart/kc-sf-plugin/commit/2d967be5c615ba15e1be2b96e6135bdbf7a92bb9)) + + + diff --git a/README.md b/README.md index 4afe09e..47d2238 100644 --- a/README.md +++ b/README.md @@ -41,112 +41,124 @@ sf plugins ## Commands +* [`sf kc diff`](#sf-kc-diff) +* [`sf kc trigger-framework init`](#sf-kc-trigger-framework-init) +* [`sf kc trigger-framework trigger`](#sf-kc-trigger-framework-trigger) -- [`sf kc trigger-framework init`](#sf-kc-trigger-framework-init) -- [`sf kc trigger-framework trigger`](#sf-kc-trigger-framework-trigger) -- [`sf kc diff`](#sf-kc-diff) - -## `sf kc trigger-framework init` +## `sf kc diff` -Auto generate an Apex Trigger framework. By default, the template uses this Trigger Handler Apex class: https://github.com/k-capehart/sfdc-trigger-framework +Preview a retrieval and deploy to see what will be retrieved from the org, the potential conflicts, and the ignored files. ``` USAGE - $ sf kc trigger-framework init [--json] [--flags-dir ] [-d ] + $ sf kc diff -o [--json] [--flags-dir ] [--concise] FLAGS - -d, --target-dir= [default: force-app/main/default] The target directory for your salesforce project. - There should be subdirectories for classes/ and objects/. + -o, --target-org= (required) Login username or alias for the target org. + --concise Omits files that are forceignored. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION - Using this command will initialize an Apex Trigger framework by creating an extendable Trigger Handler class based off a template. - - Also creates a CustomSetting called BypassAutomation that can be used to optionally skip triggers for specific users. + Preview a retrieval and deploy to see what will be retrieved from the org, the potential conflicts, and the ignored + files. - SObject specific trigger handlers should extend this class and override the methods for beforeInsert(), afterInsert(), etc. + You must run this command from within a project that has source tracking. - If a file already exists with the given name then it is not overwritten. + The command outputs a table that describes the difference between your local project and an org. It is equivalent to + running both the "sf project retrieve preview" and "sf project deploy preview" commands. EXAMPLES - Initialize the trigger framework in the directory: force-app/main/default - $ sf kc trigger-framework init --target-dir force-app/main/default + View differences between local org and an org with the alias "my-org" + $ sf kc diff --target-org my-org + View differences between local org and the default org, omitting ignored files + $ sf kc diff --concise + +FLAG DESCRIPTIONS + -o, --target-org= Login username or alias for the target org. + + Overrides your default org. + + --concise Omits files that are forceignored. + + Ignore files by placing them in your .forceignore and using this flag. ``` -## `sf kc trigger-framework trigger` +_See code: [src/commands/kc/diff.ts](https://github.com/k-capehart/kc-sf-plugin/blob/1.3.1/src/commands/kc/diff.ts)_ -Create a new trigger, handler class, and helper class for a Salesforce object. Recommend using `kc trigger-framework init` first. +## `sf kc trigger-framework init` + +Auto generate an Apex Trigger framework. By default, the template uses this Trigger Handler Apex class: https://github.com/k-capehart/sfdc-trigger-framework ``` USAGE - $ sf kc trigger-framework trigger -s [--json] [--flags-dir ] [-d ] + $ sf kc trigger-framework init [--json] [--flags-dir ] [-d ] FLAGS - -d, --target-dir= [default: force-app/main/default] The target directory for your apex classes and triggers. - There should be subdirectories for classes/, triggers/, and objects/. - -s, --sobject=... (required) The name of the SObject that the trigger and classes will be created for. + -d, --target-dir= [default: force-app/main/default] The target directory for your salesforce project. There + should be subdirectories for classes/ and objects/. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION - Given an SObject, creates a Trigger, a Handler class, a Helper class, a Test class, and a custom field for the BypassAutomation custom setting. + Auto generate an Apex Trigger framework. By default, the template uses this Trigger Handler Apex class: + https://github.com/k-capehart/sfdc-trigger-framework - The Handler class extends `TriggerHandler`. + Using this command will initialize an Apex Trigger framework by creating an extendable Trigger Handler class based off + a template. - The custom field is used in the Handler class to check whether implementation should be skipped. + Also creates a CustomSetting called BypassAutomation that can be used to optionally skip triggers for specific users. + + SObject specific trigger handlers should extend this class and override the methods for beforeInsert(), afterInsert(), + etc. + + If a file already exists with the given name then it is not overwritten. EXAMPLES - Create a new trigger, handler, and helper for the Account object. - $ sf kc trigger-framework trigger --sobject Account + Initialize the trigger framework in the directory: force-app/main/default + + $ sf kc trigger-framework init --target-dir force-app/main/default ``` -## `sf kc diff` +_See code: [src/commands/kc/trigger-framework/init.ts](https://github.com/k-capehart/kc-sf-plugin/blob/1.3.1/src/commands/kc/trigger-framework/init.ts)_ -Preview a retrieval and deploy to see what will be retrieved from the org, the potential conflicts, and the ignored files. +## `sf kc trigger-framework trigger` + +Create a new trigger, handler class, and helper class for a Salesforce object. Recommend using `kc trigger-framework init` first. ``` USAGE - $ sf kc diff -o [--json] [--flags-dir ] [--concise] + $ sf kc trigger-framework trigger -s [--json] [--flags-dir ] [-d ] FLAGS - -o, --target-org= (required) Login username or alias for the target - org. - --concise Omits files that are forceignored. + -d, --target-dir= [default: force-app/main/default] The target directory for your apex classes and triggers. + There should be subdirectories for classes/, triggers/, and objects/. + -s, --sobject=... (required) The name of the SObject that the trigger and classes will be created for. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION - Preview a retrieval and deploy to see what will be retrieved from the org, the potential conflicts, and the ignored - files. + Create a new trigger, handler class, and helper class for a Salesforce object. Recommend using `kc trigger-framework + init` first. - You must run this command from within a project that has source tracking. - - The command outputs a table that describes the difference between your local project and an org. It is equivalent to - running both the "sf project retrieve preview" and "sf project deploy preview" commands. - -EXAMPLES - View differences between local org and an org with the alias "my-org" - $ sf kc diff --target-org my-org - View differences between local org and the default org, omitting ignored files - $ sf kc diff --concise + Given an SObject, creates a Trigger, a Handler class, a Helper class, a Test class, and a custom field for the + BypassAutomation custom setting. -FLAG DESCRIPTIONS - -o, --target-org= Login username or alias for the target org. + The Handler class extends `TriggerHandler`. - Overrides your default org. + The custom field is used in the Handler class to check whether implementation should be skipped. - --concise Omits files that are forceignored. +EXAMPLES + Create a new trigger, handler, and helper for the Account object. - Ignore files by placing them in your .forceignore and using this flag. + $ sf kc trigger-framework trigger --sobject Account ``` -_See code: [src/commands/kc/diff.ts](https://github.com/k-capehart/kc-sf-plugin/blob/v1.1.2/src/commands/kc/diff.ts)_ - +_See code: [src/commands/kc/trigger-framework/trigger.ts](https://github.com/k-capehart/kc-sf-plugin/blob/1.3.1/src/commands/kc/trigger-framework/trigger.ts)_ diff --git a/package.json b/package.json index bdd0e41..3933b4b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "kc-sf-plugin", "description": "Various commands for enabling salesforce development with the sf cli", - "version": "1.3.1", + "version": "1.3.2", "publishConfig": { "registry": "https://registry.npmjs.org", "access": "public"