LostKobrakai

LostKobrakai

I’m in the process of working on a library, where I want to have quite expressive exceptions (due to a lot of domain specific constraints). I’m wondering if there any guidelines of how to best format those though?

There are questions like:

  • Are multi line exceptions generally fine?

  • When to start using blame if the stacktrace or expensive operations are not needed?

  • Is it generally ok to add ANSI escape sequences for formatting, or would this cause issues?

I noticed that e.g. the FunctionClauseError exception doesn’t add ANSI sequences by itself, but it’s special cased within IEx to add some proper coloring, while for other exceptions there’s a check for a reset sequence in the exception string.

First 2 of 2 Posts Switch mode

dimitarvp

dimitarvp

What do you mean by expressive exceptions? Is there any required format, or in general, a bucket list of requirements?

To me multi-line exceptions are always fine; you either need a stack trace or sometimes the error message cannot be super short. Both things shouldn’t ever be a deal-breaker when constructing exceptions / errors.

Another example: when showing errors in tests I love the “expected X, got Y” format.

I am definitely not an authority on anything (it’s questionable if I’ll be working commercial programming 10 years from now even) but I have found the following format successful when I was working on and with huge Java monstrosities a lifetime ago:

Action: Saving config to ~/.config/my_program/my_program.toml
Error: Access denied
Suggestion: Change the permission flags of the file.
LostKobrakai

LostKobrakai OP

Not specifically, but I was experimenting with e.g. visualizing how a given input string doesn’t fit the things like expected lengths over just showing some abstract numbers.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
roeland
Kia ora, We have been using elixir-google-api to connect to Google Drive. However, with the updates to Tesla due to CVEs this is now bro...
New
rahultumpala
Hello, I have an Elixir backend that implements a custom protocol over TCP. I want to load test the backend and assess the performance o...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement