Skip to main content

A SonarQube-like static analysis CLI for multi-language repositories.

Project description

supersonar

supersonar is a lightweight, SonarQube-inspired static analysis CLI for multi-language repositories. It is designed for local use and CI pipelines via pip install (Python 3.10+).

Supported Languages

  • Python
  • Java
  • Kotlin
  • JavaScript / React (.js, .jsx, .ts, .tsx)
  • Go

Quick start

pip install .
supersonar scan . --format json

Pipeline install (pip)

Use an isolated environment in CI:

python -m venv .venv
. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install supersonar
supersonar --version
supersonar scan . --format sarif --out reports/supersonar.sarif

Or install from repository source directly:

python -m pip install "git+https://github.com/mortaccio/supersonar.git@main"

The scanner performs real code checks (AST + regex), including:

  • dynamic execution (eval/exec)
  • broad exception handlers
  • subprocess.*(..., shell=True) in Python
  • unsafe yaml.load(...) in Python
  • unsafe pickle.load/loads(...) in Python
  • requests(..., verify=False) in Python
  • cross-language readability checks (line too long, trailing whitespace, oversized file)
  • duplicate-code block detection (repeated multi-line chunks)
  • Java package naming convention checks (lower.case.package)
  • Java type naming convention checks (UpperCamelCase)
  • Java class/file naming consistency checks (MyClass in MyClass.java)
  • Java method naming convention checks (lowerCamelCase)
  • Java constant naming convention checks (UPPER_SNAKE_CASE)
  • Java complexity checks (too many method parameters, very long methods, deep nesting)
  • Java coupling/cohesion checks (high import fan-out, classes with too many methods, low cohesion)
  • Java command execution usage (Runtime.exec, ProcessBuilder)
  • Kotlin checks (package/type/function naming, too many parameters, long functions, deep nesting)
  • Kotlin command execution usage (Runtime.exec, ProcessBuilder)
  • Python naming checks (snake_case functions, UpperCamelCase classes)
  • Python complexity checks (too many parameters, very long functions, deep nesting)
  • Python coupling/cohesion checks (high import fan-out, classes with too many methods, low cohesion)
  • JavaScript/React checks (function/component naming, too many parameters, long functions, deep nesting)
  • Node.js command execution usage (child_process.exec/execSync)
  • Go checks (package/function naming, too many parameters, long functions, deep nesting, import fan-out)
  • Go security checks (InsecureSkipVerify: true, exec.Command("sh", "-c", ...))
  • hardcoded secret-like assignments
  • insecure external http:// endpoint literals
  • Dockerfile hardening checks (root user, unpinned image tags, curl/wget piped to shell)
  • Kubernetes manifest checks (privileged containers, privilege escalation, root policies, host namespace sharing)
  • private key block markers (for example BEGIN ... PRIVATE KEY)
  • TODO/FIXME markers
  • unresolved merge conflict markers

Python files use AST rules. Other file types use generic cross-language text rules.

CI usage

pip install supersonar
supersonar scan . \
  --format sarif \
  --out reports/supersonar.sarif \
  --fail-on high \
  --max-high 0 \
  --max-critical 0 \
  --coverage-xml coverage.xml \
  --min-coverage 80

Config (supersonar.toml)

[scan]
exclude = [".git", ".venv", "venv", "build", "dist", "__pycache__"]
include_extensions = [".py", ".java", ".js", ".jsx", ".ts", ".tsx", ".go", ".rs", ".cs", ".yaml", ".yml", ".json", ".toml"]
include_filenames = ["Dockerfile", "Jenkinsfile", "Makefile"]
max_file_size_kb = 1024
skip_generated = true
inline_ignore = true
security_only = false
disabled_rules = []
# enabled_rules = ["SS001", "SS003"]
coverage_xml = "coverage.xml"

[quality_gate]
fail_on = "high"
max_issues = 200
max_files_with_issues = 25
max_high = 0
max_critical = 0
min_coverage = 80.0
baseline_report = "reports/supersonar-baseline.json"
only_new_issues = true

[report]
format = "json"

Use CLI overrides when needed:

supersonar scan . --include-ext .java --include-ext .kt --include-file Dockerfile
supersonar scan . --security-only
supersonar scan . --security-only --format json --out reports/security-report.json

Quality gates

  • fail_on: fail if any issue exists at/above severity
  • max_issues: fail if total issues exceed threshold
  • max_files_with_issues: fail if number of files with at least one issue exceeds threshold
  • max_low, max_medium, max_high, max_critical: per-severity caps
  • min_coverage: minimum line coverage percentage from Cobertura XML
  • baseline_report + only_new_issues: gate only on issues not present in a previous report

Generate coverage.xml in Python projects with:

python -m pip install coverage
coverage run -m pytest
coverage xml -o coverage.xml

Noise control

  • Generated artifacts are skipped by default (target/, .mypy_cache/, .pytest_cache/, .tox/, .nox/, .gradle/, node_modules/, and common binary suffixes).
  • Use --include-generated when you explicitly want to scan generated/build outputs.
  • Inline suppression is supported per line:
    • # supersonar:ignore ignores all rules on that line.
    • # supersonar:ignore SS001,SS007 ignores specific rules on that line.
  • Rule-level controls:
    • --disable-rule SS004 (repeatable)
    • --enable-rule SS001 --enable-rule SS003 (allowlist mode)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

supersonar-0.3.5.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

supersonar-0.3.5-py3-none-any.whl (34.3 kB view details)

Uploaded Python 3

File details

Details for the file supersonar-0.3.5.tar.gz.

File metadata

  • Download URL: supersonar-0.3.5.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for supersonar-0.3.5.tar.gz
Algorithm Hash digest
SHA256 b3333e36db3b6c27eb08709544d270b57615be81c334f641b883c325074f8cc5
MD5 7c292c2a8ae3971bbfe678d3775877af
BLAKE2b-256 42a7f40733368a6bb0e93dff52480bfca0005bc70f6764b36723a59e6a0582ca

See more details on using hashes here.

File details

Details for the file supersonar-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: supersonar-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 34.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for supersonar-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bfb99483fd277819c844b0bcb4bd7ae56db147b3de64c6f217610c9cfab07341
MD5 353447726ac7e6d5f0329a114c3b01c4
BLAKE2b-256 e09b6482bc515536c1b88a51fd08ee3b302d54de63e9099aea92c8c96ed175bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page