Skip to content

Commit 6754b60

Browse files
Adjusted headlines, added link to maven enforcer plugin
1 parent c915223 commit 6754b60

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
[![Build Status](https://travis-ci.org/andrena/no-package-cycles-enforcer-rule.svg)](https://travis-ci.org/andrena/no-package-cycles-enforcer-rule)
44

5-
## Documentation
5+
## About
66

77
This Maven Enforcer Rule checks your project for package cycles. It fails the build if any package cycle is found, showing you the packages and classes involved in the cycle.
88

9-
Usage: Add the following plugin to your POM:
9+
## Usage
10+
11+
Add the following plugin to your POM:
1012

1113
```xml
1214
<plugin>
@@ -36,7 +38,7 @@ Usage: Add the following plugin to your POM:
3638
</plugin>
3739
```
3840

39-
### Include test classes
41+
### Including test classes
4042

4143
If you want to exclude tests from cycle checking, you can use the parameter `includeTests` which is set to true by default:
4244
```xml
@@ -49,11 +51,13 @@ If you want to exclude tests from cycle checking, you can use the parameter `inc
4951
...
5052
```
5153

52-
### Restrict scope
54+
### Restricting scope
5355

54-
If you want to exclude packages or restrict check to certain packages only, you can use `includedPackages` or `excludedPackages`:
55-
**:warning: only use this, if there is no other way! Once there are exceptions, the connection between those excluded packages
56+
**:warning: Only use this, if there is no other way! Once there are exceptions, the connection between those excluded packages
5657
will grow stronger and stronger, without notice!**
58+
59+
If you want to exclude packages or restrict check to certain packages only, you can use `includedPackages` or `excludedPackages` (although you really should not!):
60+
5761
```xml
5862
...
5963
<rules>
@@ -83,3 +87,4 @@ will grow stronger and stronger, without notice!**
8387
* The original version by Daniel Seidewitz on [Stackoverflow](http://stackoverflow.com/questions/3416547/maven-jdepend-fail-build-with-cycles). Improved by showing all packages afflicted with cycles and the corresponding classes importing the conflicting packages.
8488
* [JDepend](https://github.com/clarkware/jdepend), the library being used to detect package cycles.
8589
* For more information about package cycles, see ["The Acyclic Dependencies Principle" by Robert C. Martin (Page 6)](http://www.objectmentor.com/resources/articles/granularity.pdf).
90+
* The [Maven Enforcer Plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/)

0 commit comments

Comments
 (0)