Improve "commonRequireFilesInCodeowners" docs

sogame · Oct 19, 2024 · f166eb9 · f166eb9
1 parent bd424df
commit f166eb9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/validations.md b/docs/validations.md
@@ -260,17 +260,21 @@ commonPrDescriptionContribution({ minLength: 10, logType: 'fail' });
 
 Check all added files have an owner defined in CODEOWNERS.
 
+`pathsPattern` can be used to restrict the check the folders that match it.
+
 ##### Configuration
 
 | Property       | Type                       | Default Value |
 | -------------- | -------------------------- | ------------- |
+| pathsPattern   | regex                      | /.\*/         |
 | codeownersPath | string                     | CODEOWNERS    |
 | logType        | enum (warn, fail, message) | warn          |
 
 ##### Usage
 
 ```
 commonRequireFilesInCodeowners();
+commonRequireFilesInCodeowners({ pathsPattern: 'modules/' });
 commonRequireFilesInCodeowners({ codeownersPath: '.github/CODEOWNERS' });
 commonRequireFilesInCodeowners({ logType: 'fail' });
 ```