Setup & Installation
Make sure that the following prerequisites are successfully installed on your machine:
- Java - Download & Install Java. Download Java based on your operating system (JDK 11, 17 and 19 are fine to use).
- Maven - Download & Install Maven. Choosing the latest version will suffice.
- Python - Download & Install Python. Python 3.7+ is required.
- Joern - Please see the joern repository for more details on installing joern.
- GraphViz - Download & Install GraphViz. Used to generate layout program
Ensure the relevant environment variables are set properly:
JAVA_HOMEMAVEN_HOMEjoern
dot, joern, maven, java and python must also be part of your system PATH variable to use this program.
Fig. 1 Example Environment Variable Setup on Windows
Fig. 2 Example PATH Environment Variable Setup on Windows
- Clone this repository to your local machine using the following command:
git clone https://github.com/vikiru/CodeSmell.git- Move to the root directory of the repository and run the following command to install the required dependencies (this will additionally run the tests that are created within the repo, which will begin invoking Joern - may take some time on older hardware):
mvn installHowever, Joern invocation can be skipped using this variation of the above command:
mvn -Dskip=true install - Install any missing Python dependencies by using the following command:
pip install -U -r requirements.txt
