AriaMinaei/pretty-error

Document .stop() / a way to obtain unmodified stack traces

Open

#53 opened on Aug 29, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CoffeeScript (1,524 stars) (51 forks)batch import
good first issue

Description

I had an issue where I needed to obtain an un-modified stack trace for another package to parse information out of. In the end I solved it as:

pe.stop();
const stack = (new Error()).stack;
pe.start();

It took some digging and intuition to find .stop() so it would be helpful if this was mentioned in the readme.

The reason I didn't individually format errors instead of .start() is that I have many places where errors may be output, but only one where I need this raw trace.

Question: Is the original .stack stored anywhere? I think it would be great to be able to access it, as well as the ParsedError (to eliminate the need for other parsing packages since the message is parsed once here anyway)

Contributor guide

Tech stack
javascriptnodejs
Domain
backenddocumentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicspretty error usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the main module file (likely lib/PrettyError.js) to locate the .stop() and .start() methods. Add a section in the README explaining that .stop() temporarily disables formatting to obtain an unmodified stack trace, and .start() resumes. Address whether the original stack is stored, but limit changes to documentation of existing functionality.