Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haskellfoundation/error-message-index
A community-driven collection of documentation for Haskell error messages and warnings
https://github.com/haskellfoundation/error-message-index
haskell
Last synced: about 4 hours ago
JSON representation
A community-driven collection of documentation for Haskell error messages and warnings
- Host: GitHub
- URL: https://github.com/haskellfoundation/error-message-index
- Owner: haskellfoundation
- Created: 2022-06-20T18:43:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-28T13:22:14.000Z (13 days ago)
- Last Synced: 2025-01-03T04:44:38.812Z (8 days ago)
- Topics: haskell
- Language: Haskell
- Homepage: https://errors.haskell.org
- Size: 1.5 MB
- Stars: 104
- Watchers: 9
- Forks: 70
- Open Issues: 334
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# The Haskell Message Index
[](https://github.com/haskellfoundation/error-message-index/actions/workflows/deploy.yml)
**View the site →** https://errors.haskell.org/
Haskell tooling emits a variety of errors, warnings, and other messages. In recent versions, some of these tools emit a unique code for each message that allows it to be identified. This site allows these codes to be looked up, providing examples, context, and further information that can make them easier to understand.
## Supported Tools
Today, the Haskell Message Index supports three tools. Any user-facing Haskell-related programming tools are welcome to join the effort!
| Tool | Earliest supported version | Namespace | Link to subpage |
|-------|----------------------------|-----------|-----------------|
| GHC | 9.6.1 | `GHC-` | [/ghc](https://errors.haskell.org/ghc) |
| Stack | 2.9.3 | `S-` | [/stack](https://errors.haskell.org/stack) |
| GHCup | 0.1.19.0 | `GHCup-` | [/ghcup](https://errors.haskell.org/ghcup) |
| Cabal | 3.12 | `Cabal-` | [/cabal](https://errors.haskell.org/cabal) |
## Setup
This site is built with [Haskell](https://haskell.org) using the static-site generator [Hakyll](https://jaspervdj.be/hakyll/).
### 'Normal' Install
To run the site locally, you need to
0. [install Haskell & Cabal](https://www.haskell.org/ghcup/):
```shell
curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
```
1. Clone the Repo
```shell
git clone https://github.com/haskellfoundation/error-message-index.git
```
2. Run it
```shell
cd error-message-index # yes,
cd message-index # both of those are needed
cabal update
cabal run -- site watch # Starts a web server on http://localhost:8000
```
### with Nix
To run the site with Nix, you need to have [Nix](https://nixos.org/) installed. You can install it via the [Determinate Systems installer](https://zero-to-nix.com/start/install):
```shell
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
```
1. Clone the Repo
```shell
git clone https://github.com/haskellfoundation/error-message-index.git
```
2. Run it
```shell
cd error-message-index # yes,
cd message-index # both of those are needed
nix develop
cabal run -- site watch # Starts a web server on http://localhost:8000
```
For more on the Nix flake, have a look [here](./CONTRIBUTING.md#nix-flake).
And now, since you're up and running, you can start [contributing](./CONTRIBUTING.md)! :)
## Contributing to the Message Index
Contributions may come in the form of changes to the code base, as well as opening or commenting on issues and pull requests. You are warmly invited to participate!
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on improving the site. Thanks!
If you're a Haskell tool developer who would like to integrate your project with the site, please refer to [tool-developers.md](./tool-developers.md) for recommendations regarding the error codes themselves.
## Maintenance
The Message Index is a project of the [Haskell Foundation](http://haskell.foundation), maintained on a volunteer basis by David Binder (@BinderDavid). Please get in touch if you have ideas, requests, or any other feedback!