@sf-explorer/devops v0.0.24
SF Explorer Devops Rules
A set of declarative rules to validate best practices in your org:
Pre-requisite
- nodejs
- sf or sfdx connected on a default org
Running the rules
Run this command inside your sfdx repository:
npx @sf-explorer/devops.cli
The command will generate:
- an xml file named
testReport.xml
similar to the one you can find here - an csv file named
errors.csv
- an json file named
errors.json
Customize the rules
You can ignore specific errors with a file named .sfexplorerignore
(using regex similar to a .gitignore file)
- ignore an author with @ and the author name
- ignore a record with its type and target
Default Rules
EntityDefinition
A custom object Name must be in english and PascalCase
A custom object Description is required
Less than 100 custom fields
Maximum one custom trigger per object
Maximum 15 record types per object
CustomField
A CustomField API Name must be in english and PascalCase
Custom Fields must have a Description (at least 20 chars)
Flow
Flow Description is required (at least 20 chars)
Flow Label must be Short Yet Meaningful
ApexClass
An Apex class name must be PascalCase and use a correct Suffix
An ApexClass must follow the best practices
An ApexClass must have a Description
An ApexClass must have an author
Apex variables must be camelCase
Apex methods must be camelCase
LightningComponentResource
An LWC must have an author
An LWC must have a description
PermissionSet
Name is following project convention
Description is required (more than 20 chars)
PermissionSetGroup
PermissionSetGroup must have a description (more than 20 chars)
CustomPermission
CustomPermissions must have a description
FieldPermissions
No field level security on Profiles (except System Administrator)
OmniUiCard
Flexcards names must be pascal case
Flexcards must have a description
OmniProcess
Omniscript Type should be camel case (for LWC compatibility)
Omniscript SubType must be PascalCase
Omniscripts must have a description
Omniscript must have less than 100 elements
OmniProcessElement
Remote action and DataRaptor Actions must have a description
Set Values and Set Errors must start with Set+PascalCase
Remote Action must start with 'Invoke+PascalCase'
DataRaptor Extract must start with 'DRE+PascalCase'
DataRaptor Post must start with 'DRP+PascalCase'
DataRaptor Extract must start with 'IP+PascalCase'
OmniDataTransform
DataRaptors must have a description
ExternalString
CustomLabel name must be PascalCase
FlexiPage
LightningRecordPage must have a description
StaticResource
StaticResource must have a description
CustomApplication
2 days ago
9 days ago
12 days ago
16 days ago
27 days ago
27 days ago
28 days ago
29 days ago
30 days ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago