Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonathanwiesel/sfdx-valkyrie
DX Plugin to detect the implementation of the bypassing pattern
https://github.com/jonathanwiesel/sfdx-valkyrie
Last synced: 8 days ago
JSON representation
DX Plugin to detect the implementation of the bypassing pattern
- Host: GitHub
- URL: https://github.com/jonathanwiesel/sfdx-valkyrie
- Owner: jonathanwiesel
- Created: 2020-02-16T12:07:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T16:54:07.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T06:32:19.370Z (16 days ago)
- Language: TypeScript
- Homepage:
- Size: 1.91 MB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-sfdx-plugins - sfdx-valkyrie
README
[]()
sfdx-valkyrie
====
This plugin aims to enforce the implementation of the bypassing pattern.
As mentioned in the "[Success Cloud Coding Coventions][1]" Trailhead:
> Bypass patterns: Configurations like validation rules, workflow rules, triggers, and process builders are necessary, but sometimes they get in your way (when you're loading large amounts of data or trying to debug a pesky error, for example). Bypass patterns use hierarchical custom settings or custom permissions to temporarily disable these configurations on the level of a user, profile, or org. Because both hierarchical custom settings and custom permissions are supported in formula fields, you can read their values in your validation rules, triggers, and process builders.
Valkyrie will report on bypass implementation not enforced in the following metadata types:
* Process builder (decision nodes)
* Validation rules
* Workflow rules
[1]: https://trailhead.salesforce.com/content/learn/modules/success-cloud-coding-conventions/implement-frameworks-sc
# Usage
```sh-session
$ sfdx plugins:install sfdx-valkyrie
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-valkyrie/1.0.0 darwin-x64 node-v14.1.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
```
# Commands
* [`sfdx vlk:bypasser:process -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-vlkbypasserprocess--n-string--o-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx vlk:bypasser:validrules -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-vlkbypasservalidrules--n-string--o-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx vlk:bypasser:workflows -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-vlkbypasserworkflows--n-string--o-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
## `sfdx vlk:bypasser:process -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Scan for bypassers in processes
```
USAGE
$ sfdx vlk:bypasser:process -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) specify the bypasser's
custom setting object API name to
search
-o, --objects=objects search in specified objects.
Separate by comma if many
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
sfdx vlk:bypasser:process -u someOrg
sfdx vlk:bypasser:process -u someOrg -o Account,Contact
sfdx vlk:bypasser:process -u someOrg -n Bypasser_API_Name__c
```
_See code: [lib/commands/vlk/bypasser/process.js](https://github.com/jonathanwiesel/sfdx-valkyrie/blob/v1.0.0/lib/commands/vlk/bypasser/process.js)_
## `sfdx vlk:bypasser:validrules -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Scan for bypassers in validation rules
```
USAGE
$ sfdx vlk:bypasser:validrules -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) specify the bypasser's
custom setting object API name to
search
-o, --objects=objects search in specified objects.
Separate by comma if many
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
sfdx vlk:bypasser:validrules -u someOrg
sfdx vlk:bypasser:validrules -u someOrg -o Account,Contact
sfdx vlk:bypasser:validrules -u someOrg -n Bypasser_API_Name__c
```
_See code: [lib/commands/vlk/bypasser/validrules.js](https://github.com/jonathanwiesel/sfdx-valkyrie/blob/v1.0.0/lib/commands/vlk/bypasser/validrules.js)_
## `sfdx vlk:bypasser:workflows -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Scan for bypassers in workflow rules
```
USAGE
$ sfdx vlk:bypasser:workflows -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name (required) specify the bypasser's
custom setting object API name to
search
-o, --objects=objects search in specified objects.
Separate by comma if many
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
sfdx vlk:bypasser:workflows -u someOrg
sfdx vlk:bypasser:workflows -u someOrg -o Account,Contact
sfdx vlk:bypasser:workflows -u someOrg -n Bypasser_API_Name__c
```
_See code: [lib/commands/vlk/bypasser/workflows.js](https://github.com/jonathanwiesel/sfdx-valkyrie/blob/v1.0.0/lib/commands/vlk/bypasser/workflows.js)_