HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.10, which is no longer officially supported. Click here for the latest version, 2.15!


Lint your code using regex patterns, e.g. to check for copyright headers.

To activate this with the `lint` goal, you must set `[regex-lint].config`.

Unlike other linters, this can run on files not owned by targets, such as BUILD files. To run on those, use `lint '**'` rather than `lint ::`, for example. Unfortunately, `--changed-since=<sha>` does not yet cause this linter to run. We are exploring how to improve both these gotchas.

Backend: <span style="color: purple"><code>pants.backend.project_info</code></span> Config section: <span style="color: purple"><code>[sourcefile-validation]</code></span>

## Basic options

<div style="color: purple"> <h3><code>config</code></h3> <code>--sourcefile-validation-config=&quot;{'key1': val1, 'key2': val2, ...}&quot;</code><br> <code>PANTS_SOURCEFILE_VALIDATION_CONFIG</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>{}</code></span>

<br>

Config schema is as follows:



Meaning: if a file matches some path pattern, its content must match all the corresponding content patterns.

It's often helpful to load this config from a JSON or YAML file. To do that, set `[regex-lint].config = '@path/to/config.yaml'`, for example.

</div> <br>

<div style="color: purple"> <h3><code>detail_level</code></h3> <code>--sourcefile-validation-detail-level=&lt;DetailLevel&gt;</code><br> <code>PANTS_SOURCEFILE_VALIDATION_DETAIL_LEVEL</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">one of: <code>none, summary, nonmatching, names, all</code></span><br> <span style="color: green">default: <code>nonmatching</code></span>

<br>

How much detail to include in the result.

</div> <br>

## Advanced options

None

## Deprecated options

None