Salesforce Easy Checks

The differences between Apex, SOQL, Aura, and LWC can be confusing. Let's make life easier.

Clone from Salesforce Easy Checks and improve your code quality today!

Features

✔️ Local scripts provide quick feedback on Apex, Aura, and LWC code

✔️ Github Action publishes linting results to increase confidence in Pull Requests

✔️ Included Unit Tests and Integration Tests allow painless expansion of features

Requirements

The following dependencies and versions are recommended for Salesforce Easy Checks:

• A POSIX-complaint environment (ie: Debian, macOS, WSL2)
• Node.js 16.14.0 and npm 8.3.1
• unzip 6.00
• git 2.30.2

If other versions are used, please run the Unit Tests and Integration Tests first.

./scripts/testpipeline.sh

Getting Started

1. Create your Github Repo from this Template.

2. Clone your newly created Repo. Navigate into it.

   git clone https://github.com/benjamin-ngo/salesforce-easy-checks.git
   cd salesforce-easy-checks

   The URL and Directory above will differ based on your Repo.

3. Set up PMD, ESLint, and the related dependencies.

   npm install

4. To lint new code:

   ./scripts/lint.sh diff:all

   To lint the entire repo:

   ./scripts/lint.sh repo:all

   The scripts will handle git commands, linters, and any unexpected errors!

5. For Pull Requests, a Github Action lints changed code and publishes the results.

   This increases the confidence of Pull Requests.

   

Expert Users

Feel free to customize Salesforce Easy Checks to meet your needs.

All scripts have extensive error handling and are built with modular design.

Just run the included Unit Tests and Integration Tests after each customization.

./scripts/testpipeline.sh