Important note: This project is in early stage. It's just a PoC published for evaluation with the help of the community. If the idea is successful, the project may be renamed and the code base will be completely rewritten in a clean way, otherwise this repository will be deleted. Even though the project is not released yet, you can still give it a try and send us your feedback, you are very welcome!

JCQL (Java Code Query Linter) makes it possible to query Java source code in plain SQL. This allows you to ask questions like:

• Is there any class that has no unit tests?
• What is the longest class name?
• Is there any class that has more than 20 methods?

This kind of static analysis gives you precious insights in order to improve the quality of your code base. JCQL tools can be easily integrated in your build process to continuously check if your coding rules are respected.

JCQL tools create a relational model from a given Java source code base. Once you have created the relational model, you can query it with standard SQL. The relational model has been designed to be intuitive, natural and easy to understand and query. Here is a quick overview of the core tables:

Here are some examples of queries:

select NAME, LENGTH(NAME) as length from CLASS order by length desc limit 10

select NAME, LENGTH(NAME) as length from METHOD order by length desc limit 10

JCQL tools are in early stage and are not released yet. You can still try the first snapshot version:

• jcql-core: download jar
• jcql-shell: download jar

Note: JCQL tools require Java 1.8+

JCQL tools provide two ways to create a relational database from a given code base:

Add the following repository in your pom.xml :

<repository>
    <id>ossrh</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>

and run the following command in the root folder of the project you want to analyse:

mvn io.github.benas:jcql-maven-plugin:0.1-SNAPSHOT:index

This will create a file named jcql.db in the target directory that you can query with your favorite SQL client or the one provided by JCQL tools

Run the following command:

java -jar jcql-core-{latest-version}.jar /path/to/project/to/analyse /path/to/database/directory

Once you have indexed your Java code in a relational format, you can query it with plain SQL:

Just open the jcql.db file with your favorite SQL client and start writing queries. You can use Sqlite tools or Sqlite browser.

The JCQL shell is a command line tool that allows you to write queries against the generated database.

You can start it as follows:

java -jar /path/to/jcql-shell-{latest-version}.jar /path/to/jcql.db

• JCQL tools use the great java-parser library to parse Java code and transform it a relational model.

• JCQL tools use Sqlite to store and query relational data about Java code