General
To use Sourcehawk you must first create a sourcehawk.yml configuration file in your project root.
Simply having the file will allow your project to be scanned, but since there is no configuration in the file, all scans will pass with flying colors.
sourcehawk.yml
The following will ensure that you have a pom.xml in the root of your project. We will cover the types of enforcers in another section, but this is a simple file exists enforcer.
Remote Configurations
Sourcehawk supports merging many different smaller files together to compose and recursively store files remote. This can e extremely useful if you want to share and reuse your Sourcehawk rules without having to copy and paste them everywhere.
info
By using github raw links you can use specific tags of rules for even greater composition instead of just always using master or head.
Example
An example of this composition can be found in github.
sourcehawk.yml
And the https://github.com/raw/optum/sourcehawk-parent/v1.0.0/.sourcehawk/lombok.yml file can contain the following rules for reuse across many or all of your projects.