https://github.com/patrickdoc/auto-cluster-maven-plugin
Hierarchical cluster of Java source files in a convenient Maven plugin
https://github.com/patrickdoc/auto-cluster-maven-plugin
Last synced: about 1 year ago
JSON representation
Hierarchical cluster of Java source files in a convenient Maven plugin
- Host: GitHub
- URL: https://github.com/patrickdoc/auto-cluster-maven-plugin
- Owner: patrickdoc
- License: mit
- Created: 2021-07-03T02:38:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-20T14:28:41.000Z (almost 4 years ago)
- Last Synced: 2025-03-27T21:03:26.219Z (about 1 year ago)
- Language: Java
- Size: 1.56 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# auto-cluster-maven-plugin
Extract Java dependency information, run a hierarchical clustering algorithm,
organize your code.
## Usage
To generate a dry-run folder: `src/main/auto-cluster-maven-plugin1234...`
```bash
mvn io.github.patrickdoc:auto-cluster-maven-plugin:cluster
```
To delete your existing structure and fully embrace the plugin
> :warning: **WARNING**: This will delete your existing files. Please be very
> careful, and also use version control.
```bash
mvn io.github.patrickdoc:auto-cluster-maven-plugin:cluster -DdryRun=false
```
## Why?
I think dependencies are an under-examined aspect of code and we can do a lot
more with them.
This plugin has two goals:
- For individual projects, the goal is to make
the internal dependency structure easy to analyze. By putting it front and
center, you will hopefully be able to identify and resolve potential structural
issues in your code.
- For the general community, the goal is to provide a language for talking about
code organization and style.
I don't like organizing interfaces into an `inf` package or enums into an `enum`
package, but there is no productive conversation we can have about that.
On the other hand, if you submit a pull request to increase the effect of
transitive dependencies on the clustering algorithm, then we can look at
concrete examples of how it would work on any codebase. This seems like a much
better starting point than "I don't like X".
For a longer form dev log and discussion, see
[here](https://patrickdoc.github.io/dependencies.html).
## Example
The ClassGraph repo is as good an example of any of medium sized project with
non-zero complexity in the code. So I've used it as an example here. Note, this
is not a criticism of the existing structure. In fact, I'm quite pleased that
the plugin reproduces some of the existing structure.
Running a dry run in the ClassGraph repo (with a parameter to handle multiple base packages):
```bash
mvn io.github.patrickdoc:auto-cluster-maven-plugin:cluster -DbasePackages=io.github.classgraph,nonapi.io.github.classgraph
```
You can see a side by side comparison of the original repo:
and the clustered code:
You can also browse the files in [this fork](https://github.com/patrickdoc/classgraph/tree/clustered/src/main).
## Acknowledgements and References
[ClassGraph](https://github.com/classgraph/classgraph): This project powers the
dependency data extraction, but can also do much more
[Hierarchical Clustering Primer](https://uc-r.github.io/hc_clustering): A useful
introduction to hierarchical clustering
[Clustering Algorithm](https://arxiv.org/pdf/1109.2378.pdf): The base algorithm
for clustering, available in Python and R packages as `fastcluster`