README.md

Lupa 🔍: set of runners for the analyzers

This module contains all runners for analyzers from the repository. We separated the runners from analyzers since we use the IntelliJ Platform, and the module with runners extensions points should be separated.

The plugin to run various project analysis from the CLI:

1. Kotlin's analysers:
   • java-reflections-analysis - search for Kava reflections calls
   • kotlin-clones-analysis - command process code clones analysis
   • kotlin-dependencies-analysis - command process project dependencies and imports analysis
   • kotlin-gradle-dependencies-analysis - command process Gradle dependencies and imports analysis
   • kotlin-gradle-dependencies-by-modules-analysis - command process Gradle dependencies and imports analysis by each module in the projects
   • kotlin-gradle-plugins-analysis - command process Gradle plugins
   • kotlin-gradle-properties-analysis - command process Gradle properties
   • kotlin-project-metrics-analysis - command process projects metrics
   • kotlin-ranges-analysis - command process various ranges implementations usage analysis
   • kotlin-project-tags-analysis - command process projects from dataset tagging according to theme or content
2. Python's analysers:
   • python-call-expressions-analysis - command process python call expressions analysis
   • python-imports-analysis - command process python imports analysis

Usage

To run analysis execute task 'cli' with analysis runner name and args:

1. Kotlin's analysers:

gradle :lupa-runner:cli -Prunner="analysis-key" -Pinput="path/to/dir/with/projects" -Poutput="path/to/dir/with/results"

where analysis-key is a key from the list of the analysers.

2. Python's analysers:

   • python-call-expressions-analysis:

     gradle :lupa-runner:python-cli -Prunner="python-call-expressions-analysis" -Pinput="path/to/dir/with/projects" -Poutput="path/to/dir/with/results" -Pvenv="path/to/venv"
     

     Note: if you don't want to run the analysis with a virtual environment, just pass an empty string as path. For example: -Pvenv="".

     Note: if an empty string is passed to the --Pvenv argument and the project root contains the .venv folder, the virtual environment will be set up from it.

   • python-imports-analysis:

     gradle :lupa-runner:cli -Prunner="python-imports-analysis" -Pinput="path/to/dir/with/projects" -Poutput="path/to/dir/with/results"