https://github.com/forcedotcom/sfdx-scanner

https://github.com/forcedotcom/sfdx-scanner

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/forcedotcom/sfdx-scanner
• Owner: forcedotcom
• License: mit
• Created: 2020-01-13T23:03:11.000Z (over 6 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-29T15:06:01.000Z (over 1 year ago)
• Last Synced: 2024-10-29T15:55:25.306Z (over 1 year ago)
• Language: HTML
• Size: 52.2 MB
• Stars: 215
• Watchers: 29
• Forks: 49
• Open Issues: 79
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-sfdx-plugins - sfdx-scanner - does not replace Checkmarx for Partners (Official plugins/modules from Salesforce)

README

          
[![License](https://img.shields.io/npm/l/scanner.svg)](https://github.com/forcedotcom/sfdx-scanner/blob/master/package.json)

# Salesforce Code Analyzer

Salesforce Code Analyzer is a unified tool for static analysis of source code.

Code Analyzer analyzes multiple languages.

It relies on a consistent command-line interface and produces a results file of rule violations.

Use the results to review and improve your code.

If you're listing a managed package on AppExchange, it must pass security review.

You're also required to upload your Salesforce Code Analyzer scan reports.

Attach your Code Analyzer reports to your submission in the AppExchange Security Review Wizard.

For more info, read [Scan Your Code with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) and [AppExchange Security Review](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_overview.htm).

Code Analyzer current supports the PMD rule engine, PMD Copy Paste Detector, ESLint, RetireJS, and Salesforce Graph Engine.

Integrate Code Analyzer into your Continuous Integration/Continuous Development (CI/CD) process to enforce rules that you define and to produce high-quality code.

# Salesforce Code Analyzer Documentation

Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview) documentation to learn:

* how to install Code Analyzer

* what is included in the Code Analyzer command reference

* the structure of Code Analyzer architecture

* how to write and manage custom rules

### Contribute to Salesforce Code Analyzer

Read these instructions to [contribute to Code Analyzer](https://github.com/forcedotcom/sfdx-scanner/blob/dev/CONTRIBUTING.md)