Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Diagnostic Manager #2014

Open
austincondiff opened this issue Apr 2, 2025 · 0 comments
Open

✨ Diagnostic Manager #2014

austincondiff opened this issue Apr 2, 2025 · 0 comments
Labels
bug Something isn't working enhancement New feature or request extensions Issues related to the extension architecture in CodeEdit Issue language server Issues or Pull Requests related to language servers. navigator triage needed UI This is UI related

Comments

@austincondiff
Copy link
Collaborator

austincondiff commented Apr 2, 2025

Description

Introduce a DiagnosticManager responsible for managing and publishing diagnostics (e.g., build errors, linter warnings, language server issues) grouped by file. This manager will serve as the single source of truth for diagnostics across the editor, and its contents will drive visual components such as the Issue Navigator and Line Annotations.

Requirements

  • Create a DiagnosticManager class conforming to ObservableObject
  • Store diagnostics as a flat list or grouped by file:
    @Published var issues: [DiagnosticIssue]
  • Define a DiagnosticIssue model:
    struct DiagnosticIssue: Identifiable, Hashable {
        let id: UUID = UUID()
        let file: URL
        let line: Int
        let column: Int?
        let message: String
        let severity: Severity
        let source: String?
        let fixItSuggestion: String?
    
        enum Severity {
            case error, warning, info, live
        }
    }
  • Add convenience accessors:
    var issuesByFile: [URL: [DiagnosticIssue]]
    func issues(for file: URL) -> [DiagnosticIssue]
  • Add a way to update issues by file, e.g.:
    func setIssues(_ issues: [DiagnosticIssue], for file: URL)
    func clearIssues(for file: URL)

Additional Context

This manager will be used by multiple parts of the app, including the Issue Navigator and Line Annotations. It should be reactive and efficient, allowing UI components to automatically update when diagnostics change.

Future extensions may include filtering, debouncing updates, or supporting different diagnostics sources (build system, LSP, etc.).

Related Issues

@austincondiff austincondiff added the enhancement New feature or request label Apr 2, 2025
@github-actions github-actions bot added bug Something isn't working extensions Issues related to the extension architecture in CodeEdit Issue language server Issues or Pull Requests related to language servers. navigator triage needed UI This is UI related labels Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request extensions Issues related to the extension architecture in CodeEdit Issue language server Issues or Pull Requests related to language servers. navigator triage needed UI This is UI related
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant