sf-metalinter

A Salesforce CLI plugin for linting Salesforce metadata files to ensure code quality and consistency across your Salesforce projects.

Features

• ✅ Lint Salesforce metadata files with customizable rules
• 🎯 Support for multiple file paths and directories
• 📋 Custom rule configuration support
• 🚀 Easy integration with Salesforce CLI workflows

Installation

Install as a Salesforce CLI plugin:

sf plugins install sf-metalinter

Usage

Basic Linting

Lint a specific directory or file:

sf metalinter lint --path force-app/main/default

Multiple Paths

Lint multiple directories or files:

sf metalinter lint --path "force-app/main/default,force-app/lwc"

Custom Rules

Use custom rules file:

sf metalinter lint --path force-app/main/default --rules ./my-custom-rules.js

📚 Documentation

For the detailed documentation, visit the Wiki:

• 🚀 Getting Started - Installation and basic usage
• 📋 Built-in Rules - Complete list of available rules
• 🛠️ Custom Rules - Create your own linting rules
• 🤝 Contributing - How to contribute to the project
• ❓ FAQ - Frequently asked questions

Dependencies

This plugin is built with:

• @oclif/core - CLI framework
• @salesforce/core - Salesforce core libraries
• @salesforce/sf-plugins-core - SF plugin utilities
• @xmldom/xmldom - XML DOM parser
• xpath - XPath query engine
• glob - File pattern matching
• minimatch - Pattern matching

License

BSD-3-Clause © Victor Garcia Zarco