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

Machine Readable List of Errors #531

Closed
dylan-thinnes opened this issue Jun 20, 2024 · 2 comments
Closed

Machine Readable List of Errors #531

dylan-thinnes opened this issue Jun 20, 2024 · 2 comments

Comments

@dylan-thinnes
Copy link
Contributor

dylan-thinnes commented Jun 20, 2024

I have a PR for this that I think does the job: #532

At HLS we'd like to link people to the error index, but only do so when it is actually documented in the index. For that we'd need some machine-readable and durable spec, I'd prefer JSON for selfish reasons, from which we can get the list of errors and a bit of their metadata.

We'd cache the lookup so as not to hammer HEI too much - this shouldn't affect Github Pages, be we should avoid too much load on the Haskell error index in case we ever need to move off of that onto our own solution.

More background on why we feel we need this and alternatives we've considered here: haskell/haskell-language-server#4327

I've looked through the history and didn't find any mention of this, so I've been a bit presumptuous and opened an issue - sorry if this isn't the right place!

@BinderDavid
Copy link
Collaborator

BinderDavid commented Jun 20, 2024

Yes, that sounds very reasonable. I will merge any sensible PR which implements this :)

@BinderDavid
Copy link
Collaborator

Closed in #532

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants