VS Code extension: status bar and Problems panel diagnostics

Open
  • Is something wrong?
#45 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, typescript, vscode
Domain
cli, devtools, release, testing

Research direction

Start with section 7 of docs/plans/features-5-8.md and inspect the existing npm/ package and repository workflows; the new extension belongs in vscode/. The issue divides the work into separate steps, from SARIF checks and diagnostics through commands, tests, publishing, and README media. Done means pin-file diagnostics update on save, the status bar reports the result, and publish.yml publishes to both marketplaces; publishing also needs maintainer-provided secrets.

Written by the indexing model from the issue text.

Description

enhancement help wanted

Problem: DevReady only helps when someone remembers to run it. A status-bar item that turns red when .nvmrc changes gives daily visibility, and is the best discovery channel DevReady can have.

Do: follow section 7 of the team features plan. The extension lives in vscode/ in this repo (like npm/), TypeScript, no runtime dependencies beyond the VS Code API. One PR per step:

  • Scaffold: vscode/package.json, activation on pin files, status bar, run devready check --format sarif --project <workspaceFolder> (falling back to uvx devready-cli) and parse the SARIF.
  • Diagnostics on the pin file (Problems panel), debounced re-run on save of watched pin files, tests with @vscode/test-electron in CI (Ubuntu only).
  • Commands: DevReady: Check, DevReady: Explain…, DevReady: Show fix plan; an "Explain this check" code action.
  • Publish job in publish.yml for the VS Marketplace and Open VSX.
  • README badge and GIF.

Done when:

  • Opening a project with a mismatched .nvmrc shows a diagnostic on that file and DevReady: 1 warn in the status bar.
  • Editing and saving a pin file re-runs the check.
  • The extension is published to both marketplaces from publish.yml.

Notes:

  • It never runs fix commands, has no telemetry, and is disabled in untrusted workspaces.
  • Publishing needs VSCE_PAT and OVSX_PAT repository secrets (maintainer setup).
Dominant language
Python
Stars
2
Forks
3
Avg merge
10h 51m
Merged PRs (30d)
40

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Evalogical-Inc/devReady

All issues in Evalogical-Inc/devReady

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.