Skip to content

A community-driven collection of documentation for Haskell error messages and warnings

Notifications You must be signed in to change notification settings

theophile-scrive/error-message-index

 
 

Repository files navigation

The Haskell Message Index

.github/workflows/deploy.yml

Haskell tooling emits a variety of errors, warnings, and other messages. In the latest development versions that are leading to the release of version 9.6.1, GHC emits 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.

Please see 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 for recommendations regarding the error codes themselves.

Running Locally

The site is built with the Hakyll static site generator. To view the site locally, enter the message-index directory and run:

$ cabal run -- site watch

or

$ stack run -- site watch

which fires up an HTTP server on localhost:8000.

The error messages:

cabal: There is no <pkgname>.cabal package file or cabal.project file. To
build packages locally you need at minimum a <pkgname>.cabal file. You can use
'cabal init' to create one.

For non-trivial projects you will also want a cabal.project file in the root
directory of your project. This file lists the packages in your project and
all other build configuration. See the Cabal user guide for full details.

and

No executables found.

typically indicate that the site was started from the root of the repository, rather than the message-index directory.

Contributor Expectations

We welcome contributions that help to further progress the project towards its goals.

Contributions may come in the form of changes to the code base, as well as opening or commenting on issues and pull requests.

All contributors are expected to follow the Haskell Foundation's Code of Conduct.

Maintenance

The Message Index is a project of the Haskell Foundation. Please get in touch if you have ideas, requests, or any other feedback!

About

A community-driven collection of documentation for Haskell error messages and warnings

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Haskell 76.2%
  • HTML 13.2%
  • CSS 9.1%
  • Shell 1.5%