Skip to content

[0.1.5] Add Doctor diagnostics action - #35

Merged
unurgunite merged 2 commits into
v0.1.5from
feature/doctor-diagnostics
Jul 5, 2026
Merged

[0.1.5] Add Doctor diagnostics action#35
unurgunite merged 2 commits into
v0.1.5from
feature/doctor-diagnostics

Conversation

@unurgunite

@unurgunite unurgunite commented Jul 5, 2026

Copy link
Copy Markdown
Member

Description

Adds a DocScribe Doctor action that diagnoses the plugin setup and reports a comprehensive summary.

When invoked (Editor Popup -> DocScribe -> DocScribe Doctor), it collects and displays:

  • Project root and Gemfile location
  • Ruby SDK configured in the IDE (name, home path) and resolved Ruby binary
  • docscribe gem status (AVAILABLE / MISSING / UNCHECKED), version, and server mode support
  • Daemon server running state and fallback explanation
  • Current plugin settings (hideCommentsByDefault)
  • Issues summary with actionable steps when something is misconfigured

Implementation

  • DoctorAction.kt — new AnAction available for any open project (no file requirement). Builds a multi-line diagnostic report and displays it via the DocScribe notification group.
  • DocscribeDaemon.kt — added 4 public accessors (getRubyPath(), getDocscribeStatus(), getCapabilities(), isServerRunning()) that expose previously internal/private state in a controlled way.
  • plugin.xml — registered action and added to the DocScribe group with a separator.

Testing

  • DoctorActionTest.kt — 3 tests covering enabled state with project, disabled without project, and BGT update thread.
  • All existing tests pass (119 total).

Checklist

  • Tests pass (./gradlew test)
  • Formatting clean (./gradlew spotlessCheck)
  • Static analysis clean (./gradlew detekt)
  • Plugin verified (./gradlew verifyPlugin)
  • CHANGELOG updated

@unurgunite unurgunite self-assigned this Jul 5, 2026
@unurgunite unurgunite added the enhancement New feature or request label Jul 5, 2026
@unurgunite
unurgunite force-pushed the feature/doctor-diagnostics branch from e16ba3f to 826f91c Compare July 5, 2026 19:54
@unurgunite
unurgunite merged commit 795e5fb into v0.1.5 Jul 5, 2026
1 check passed
@unurgunite
unurgunite deleted the feature/doctor-diagnostics branch July 5, 2026 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant