APLint

A (soon to be) configurable linting tool for Apex and Visualforce code.

Features

• Lints Apex and Visualforce file on save, from command pallette, editor menu, and touchbar (macOS)
• Lints Apex and Visualforce file in current directory from command pallette, editor menu, and touchbar (macOS)
• Generates diagnostic output to both text editor and problems terminal
• Clear diagnostic output in problems terminal from command pallette, editor menue and touchbar (MacOS)
• View rule definition and details from within VSCode or in your default browser (see examples for usage)
• Preview your code documentation in a sperate browser window to ensure documentation is formatted correctly

Usage

APLint, by default, lints any Apex or Visualforce page on save. Other commands can be executed using Command-Shift-P (⌘ ⇧ P) or Ctrl-Shift-P on Windows. The currently supported comamnds are:

APLint: Run On file           // runs APLint on the current file
APLint: Run On Directory      // runs APLint on the currect directory
APLint: Clear Problems        // clears all diagnostics
APLint: Preview Documentation // opens a brower window with documentation preview

Example

How to: Use APLint (with onSave linting enabled)

How to: View rule documentation in VSCode

Example: Documentation Preview

Configuration

• Add custom ruleset path(s) in settings.json using the aplint.customRulesets key (see extension settings for more details)

Rule Categories

• Best Practices: Rules which enforce generally accepted best practices.
• Code Style: Rules which enforce a specific coding style.
• Design: Rules that help you discover design issues.
• Documentation: Rules that are related to code documentation.
• Error Prone: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
• Performance: Rules that flag suboptimal code.
• Security: Rules that flag potential security flaws.

A full index of the above rules can be found here.

Additional Rules

Additional rules can be enabled by selecting the Manulife linting profile in the extension settings of APLint, or by adding the key "aplint.lintingProfile": "Manulife" to the settings.json file of VSCode. These rules include:

• Class ApexDoc must have group
• ApexDoc must have author
• ApexDoc must have date
• ApexDoc must have description
• ApexDoc must have see
• Braces must be formatted
• Loops must have formatted spacing
• Must not have extra spacing
• Parantheses must be formatted
• Space must follow comma, comma must not follow space
• Variable must be formatted

All rules can be found here.

TODO

• Custom action configuration
  • Ability to turn off onSave event
  • Ability to disable APLint all together
• Custom rule configuration
  • ~~Ability to provide custom ruleset~~
  • Ablity to select from multiple default rulesets
• Warning thresholds
  • Ability to determine which level of severity determines a diagnostic warning, info, etc.
• Point to rule
  • ~~Ability to take user to the rule that triggered the linting error~~
• Quick actions
  • Auto-generate code snipits
  • Suggest fixes for common types of problems as comments

Built With

• PMD Source Code Analyzer Project
• ApexDoc
• NPM
• VSCode Extension API

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting merge requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gareth Sharpe - Initial work - @sharpga

Acknowledgments