Clayton lets you scan your app metadata and check that your code doesn't contain any code quality issue. The rules applied to your source code during the analysis are configurable (see Project Rules).
Supported file types
Clayton includes in its review the following file types.
- Apex (.apxc, .apxt, .trigger, .cls, .apex)
- Lightning components (.cmp)
- Visualforce files (.page, .component, .apexp)
- Metadata files (.xml, .object, .workflow)
When performing a code reviews of a branch, Clayton retrieves the last revision for that branch, and performs a full scan of your code, selecting all supported file types found in the source code.
Branch reviews are successful if the latest revision on that branch is fully compliant to your project standards in Clayton.
- Scope of the review: all eligible files in the latest branch revision
- Git integration: a status or build result is published on your version control system against the revision that has been reviewed
Reviewing Pull requests
When performing a review of a pull request, Clayton works in incremental mode. Pull request reviews focus only on the proposed change, and are successful when the changes are deemed unlikely to introduce new problems once the code is merged.
Files and lines that haven't been changed as part of a pull requests are ignored.
- Scope of the review: only the files that have been modified as part of the proposed change.
- Git integration: depending on the version control system, an approval/code review are added to the pull requests itself. Suggestions are added inline as comments on the diff
Sometimes there are parts of your code that you don't actively intend to maintain. Clayton lets you ignore such files, so that they are never included in your scans, by adding them to the project ignore list. This is relevant, for example, in the following circumstances:
- Unmanaged packages
- Areas of the code that you are no actively maintaining
When a file in your source code matches a filename in the project ignore list, it's excluded from the analysis.