https://github.com/crispab/codekvast

Codekvast, the Truly Dead Code Detector
https://github.com/crispab/codekvast

Last synced: 7 days ago
JSON representation

Codekvast, the Truly Dead Code Detector

• Host: GitHub
• URL: https://github.com/crispab/codekvast
• Owner: crispab
• License: mit
• Created: 2014-05-04T21:05:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T08:12:41.000Z (4 months ago)
• Last Synced: 2024-12-12T11:21:15.638Z (14 days ago)
• Language: Java
• Homepage:
• Size: 118 MB
• Stars: 45
• Watchers: 14
• Forks: 5
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Codekvast - the Truly Dead Code Detector

## Overview

Codekvast detects **Truly Dead Code** in **Java-applications**.

By *Truly Dead Code* we mean code that is in production, but *has not been used by anyone for a certain period of time*.

Codekvast works by attaching the **Codekvast Collector** to your application.

The collector records the instant when methods belonging to any of your packages are invoked. 

Modern IDEs like IntelliJ IDEA can detect dead code which have *package 

private* or *private* visibility. They can never know what potential callers there are to public and protected methods though.

 

This is where Codekvast can help. Codekvast *records when your methods are invoked in production*.

The collector periodically sends the recorded data as well as an inventory of *all* methods to the **Codekvast Dashboard**.

 

By using the web interface offered Codekvast Dashboard, you can find out whether a certain method, class or package is safe to remove or not.

*Codekvast collects the data. You then combine that with your domain knowledge to make informed decisions about what is truly dead code

that safely could be deleted.*

## Performance

Codekvast Collector is extremely efficient. It adds approximately *15 ns* to each method invocation. If this is unacceptable,

you can exclude certain time critical packages from collection.

## License

Codekvast is released under the MIT license.

### Pre-built binaries

Pre-built binaries, and the User Manual are available for download from [downloads.codekvast.io](https://downloads.codekvast.io).

* codekvast-agent-x.x.x.zip contains the *Codekvast Agent* as well as a sample `codekvast.conf`.

* CodekvastUserManual.html is a complete User Manual. It contains installation and configuration guides.

* RELEASE-NOTES.md contains release notes.

`codekvast-agent-x.x.x.jar` is also available as a Maven artifact at [jcenter](https://jcenter.bintray.com/io/codekvast/codekvast-agent)

## Development Guide

See [DEVELOPMENT-GUIDE.md](DEVELOPMENT-GUIDE.md)