https://github.com/mbarbin/error-log

Reporting located errors and warnings
https://github.com/mbarbin/error-log

Last synced: 10 months ago
JSON representation

Reporting located errors and warnings

• Host: GitHub
• URL: https://github.com/mbarbin/error-log
• Owner: mbarbin
• License: mit
• Archived: true
• Created: 2023-11-12T20:32:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-21T09:21:59.000Z (over 1 year ago)
• Last Synced: 2025-02-28T11:45:12.964Z (over 1 year ago)
• Language: OCaml
• Homepage: https://mbarbin.github.io/error-log/
• Size: 846 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# error-log

[![CI Status](https://github.com/mbarbin/error-log/workflows/ci/badge.svg)](https://github.com/mbarbin/error-log/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/mbarbin/error-log/badge.svg?branch=main)](https://coveralls.io/github/mbarbin/error-log?branch=main)

:warning: This project is no longer being maintained or extended. I have migrated to a slightly different version of this where the error log mutates a global state instead. See [Err](https://github.com/mbarbin/pp-log/blob/main/lib/err/src/err.mli). The repository will be archived and made read-only.

`Error_log` is a library for programs that process user programs and report located errors and warnings (compilers, interpreters, etc.)

The canonical syntax for an error produced by this lib is:

```text

File "my-file", line 42, character 11-15:

Error: Some message that gives a general explanation of the issue.

Followed by more details, perhaps some sexps, etc.

((A sexp)(with more)(details)

  (such_as

   (extra_values)))

```

It is inspired by dune's user_messages and uses dune's error message rendering under the hood.

## Code Documentation

The code documentation of the latest release is built with `odoc` and published to `GitHub` pages [here](https://mbarbin.github.io/error-log).