Skip to content

Commit

Permalink
Fix KiboshRunner markdown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrismair committed Jun 16, 2024
1 parent d203beb commit b63f6b9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .idea/codeStyles/codeStyleConfig.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions docs/KiboshRunner.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ The `KiboshRunner` class is the way to execute Kibosh with a set of rules.

It includes the following fields:

| **Field (property)** | **Description and Usage** |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| baseDirectory | The base directory for searching for source files. You can specify more that one of these. |
| applyToFileNames | The filename pattern for the files that Kibosh rules should run against; e.g. "*.java" or "*.{java,properties}". Defaults to "*.java". |
| | Supports the "glob" syntax of `PathMatcher`. See `java.nio.file.FileSystem.getPathMatcher()`. |
| **Field (property)** | **Description and Usage** |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| baseDirectory | The base directory for searching for source files. You can specify more that one of these. |
| applyToFileNames | The filename pattern for the files that Kibosh rules should run against; e.g. "\*.java" or "\*.{java,properties}". Defaults to "\*.java". Supports the "glob" syntax of `PathMatcher`. See `java.nio.file.FileSystem.getPathMatcher()`. |

The `KiboshRunner` class provides a *Builder* API and an `applyRules(List<Rule> rules)` method to execute using a list of Kibosh Rules. Here is an example instantiation and invocation of `applyRules`:

Expand Down

0 comments on commit b63f6b9

Please sign in to comment.