Skip to main content

Configuration

Pattern Patrol is configured using a JSON file named pattern-patrol.json. This file defines rules for project structure validation, file naming, and directory patterns.

Currently, only JSON is supported, but there are plans to introduce XML and YAML formats based on user demand.

Custom Configuration File Name

By default, Pattern Patrol looks for pattern-patrol.json. However, you can specify a different filename:

# Replace the {{config-filename}} with your filename
<build>
<plugins>
<plugin>
<groupId>com.patternpatrol</groupId>
<artifactId>pattern-patrol-plugin</artifactId>
<version>1.0.0</version>
<configuration>
<configFile>{{config-filename}}.json</configFile>
</configuration>
</plugin>
</plugins>
</build>

In the future, we will support multiple configuration files, allowing projects to merge configurations for enhanced flexibility.