Refactor Guidance Tool

A tool designed to aid developers perform code refactorings by giving structural refactoring advice.

Features

• Probably
• Some
• Cool
• Stuff

Docker

cd path\to\Refactor-Guidance-Tool
docker build -t isa-lab/refactor-guidance-tool .

This will create the Refactor Guidance Tool image and pull in the necessary dependencies.

After that run the Docker image, and map the port you want to use to access Swagger (in this case 1337). Also make sure to mount the directory of the project you want to refactor to the /app/project directory.

docker run -d -p 1337:80 --name refactor-guidance-tool --rm -v path/to/refactor/project:/app/project isa-lab/refactor-guidance-tool

Note: :80 is required to put after the desired port, as port 80 is exposed by default by the Docker image.

All set! Now you can open up the Swagger panel:

http://localhost:1337/Swagger

Implementing a microstep

All microsteps are defined in the Detectors folder. Their path follows the convention of ./Detectors/{Language}/Base/{Microstep}/. A microstep is a folder containing it's detectors, configured with CodeQL's query language.

A detector followes the convention of

/**
 * @id isa-lab/detectors/{Language}/{Microstep}/{HazardName}
 * @kind problem
 * @name {HazardName}: <DESCRIPTION OF HAZARD>.
 * @description <DESCRIPTION OF CODEQL QUERY>.
 */

import java

from subject
where predicate
select subject, "Description of problem " + subjectAsString

In a detector variables can be used by prepending them the captialized word with a $, such as $CLASS. A refactoring can then replace that string with the actual variable.

License

Yes