johnthagen/clion-cppcheck

Implement using ExternalAnnotator

Open

#65 opened on Dec 24, 2021

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Java (7 forks)github user discovery
enhancementhelp wantedv2

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

From https://youtrack.jetbrains.com/issue/CPP-22882#focus=Comments-27-5675064.0-0

LocalInspectionTool is not designed for running external executables, like cppcheck. For such task, ExternalAnnotator should be used. The flow is similar: inherit this class, override collectInformation to get all required data (like, virtual files, include dir, etc.), doAnnotate to actually execute cppcheck and finally apply to apply diagnostics to editor.

Contributor guide

Research direction
Study the ExternalAnnotator documentation and examples, then replace the LocalInspectionTool implementation with ExternalAnnotator following the pattern: collectInformation, doAnnotate, apply.
Tech stack
java
Domain
devtools
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaIntelliJ plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40