rokucommunity / rokucommunity/brighterscript

Add diagnostics when plugins throw runtime exceptions

Open
#1,259 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
208
Forks
68
Avg merge
8h 39m
Merged PRs (30d)
39

Description

Whenever a plugin throws a runtime exception, we should add a diagnostic somewhere. Since all diagnostics must be tied to a file, perhaps we tie it to the bsconfig.json?

Currently we only show these in the console as console.error calls.

How do we clear the diagnostics though? Would we need to store them with some type of context? (like the name of the plugin event that crashed, so next time it's okay? Or are they stuck until restart? (That might be fine?).

Should we add an option to disable this functionality, or should it just be on all the time? I vote on all the time.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by tracing the current console.error calls used when plugin runtime exceptions occur. Determine how diagnostics should be associated with bsconfig.json, cleared across plugin events or restarts, and optionally disabled. Done means the lifecycle and configuration behavior are decided and diagnostics consistently replace the current console-only reporting.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.