https://github.com/mauricioaniche/codesheriff
A library that lets you specify your quality rules via JUnit tests
https://github.com/mauricioaniche/codesheriff
code-metrics code-quality junit-plugin
Last synced: 30 days ago
JSON representation
A library that lets you specify your quality rules via JUnit tests
- Host: GitHub
- URL: https://github.com/mauricioaniche/codesheriff
- Owner: mauricioaniche
- License: mit
- Created: 2021-02-20T21:15:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-23T07:52:50.000Z (over 4 years ago)
- Last Synced: 2026-01-12T16:27:35.596Z (about 1 month ago)
- Topics: code-metrics, code-quality, junit-plugin
- Language: Java
- Homepage:
- Size: 91.8 KB
- Stars: 66
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeSheriff
[](https://travis-ci.org/mauricioaniche/codesheriff)
CodeSheriff is a simple library that helps you in writing JUnit tests
that check the quality of your code.
For example, CodeSheriff may fail because you have methods in your code that
have more than X lines of code, or that have complexity greater than Y.
CodeSheriff is highly flexible and lets you define the quality rules through
a very simple DSL. No more complicated configurations in complicated code
quality tools. Just write a test!
This framework was highly inspired by [ArchUnit](https://github.com/TNG/ArchUnit). If you want to write unit tests
to check architectural conformance, check that framework!
*Note that this is still just a prototype and is not yet battle tested. Help me out here!*
## The CodeSheriff API
The best way to understand CodeSheriff is by means of examples. See the
test class below:
```java
import com.github.mauricioaniche.codesheriff.dsl.CodeSheriff;
import com.github.mauricioaniche.codesheriff.junit.CodeSheriffJUnit5;
public class SheriffRunnerJUnitTest extends CodeSheriffJUnit5 {
// it can be a method that returns 'CodeSheriff' ...
CodeSheriff complexity() {
CodeSheriff sheriff = new CodeSheriff();
sheriff.thatEnsures()
.methods()
.inClassesOfPackage("a.b.c")
.withExceptionOfClass("Abc")
.have()
.complexity(m -> m < 10);
return sheriff;
}
// ... or a field!
CodeSheriff loc = new CodeSheriff()
.thatEnsures()
.methods()
.inClassesOfPackage("fixture.f3")
.withExceptionOfMethod("abc")
.have()
.linesOfCode(m -> m < 100);
}
```
For CodeSheriff to work, all you need to do it:
- Create a class that extends from the provided `CodeSheriffJUnit` class.
- Write as many _CodeSheriff_s as you want. A CodeSheriff is basically a rule
that the library will check later.
- See the `complexity` rule. It ensures that all methods within the `a.b.c` package
have complexity of less than 10. Complexity here is basically cyclomatic complexity (i.e.,
the number of ifs, fors, while, etc, in your code)
- See the `loc` rule. It ensures that all classes in the `a.b.c` package have
less than 100 lines of code.
This class is a JUnit 5 test class. Just run it. If no rules are broken in your
code, then, the test passes. If a rule is broken, CodeSheriff will list you all
the classes and methods that break a rule.
## How to import it in my project?
Simply add it to your Maven or Gradle file:
```xml
com.github.mauricioaniche
codesheriff
0.2.0
test
```
## How does it work?
CodeSheriff builds the AST of your entire source code and collect code metrics.
This is done by my other library, [CK](https://github.com/mauricioaniche/ck).
This means that checking the rules may take a while depending on the size of
your project.
## Available rules
Just use the DSL to explore all the options.
## License
This code is licensed under the MIT license.