Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/pretty_trace
Love Your Ruby's Backtrace
https://github.com/dannyben/pretty_trace
backtrace debugging gem ruby
Last synced: about 1 month ago
JSON representation
Love Your Ruby's Backtrace
- Host: GitHub
- URL: https://github.com/dannyben/pretty_trace
- Owner: DannyBen
- License: mit
- Created: 2017-09-16T14:42:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-27T16:22:14.000Z (10 months ago)
- Last Synced: 2024-05-01T14:12:10.065Z (7 months ago)
- Topics: backtrace, debugging, gem, ruby
- Language: Ruby
- Size: 641 KB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pretty Trace - Pretty Errors and Backtrace
[](https://badge.fury.io/rb/pretty_trace)
[](https://github.com/DannyBen/pretty_trace/actions?query=workflow%3ATest)
[](https://codeclimate.com/github/DannyBen/pretty_trace/maintainability)
---
Make your Ruby backtrace pretty again. Just require `pretty_trace/enable`
in your ruby script, and errors will become clearer and more readable.
---
## Install
```shell
$ gem install pretty_trace
```
Or with bundler:
```ruby
# Just install, do not activate
gem 'pretty_trace'
# Or, install and enable
gem 'pretty_trace', require: 'pretty_trace/enable'
# Or, install, enable and enable trimming
gem 'pretty_trace', require: 'pretty_trace/enable-trim'
```
## Quick Start
```ruby
# test.rb
require "pretty_trace/enable-trim"
require "fileutils"
FileUtils.rm 'no_such_file'
```
## Usage
The easiest way to use Pretty Trace is to require its activation script in
your script:
```ruby
require 'pretty_trace/enable'
```
From this point on, any exception will be formatted.
If you wish to show a trimmed version of the backtrace (where errors from the
same file are collapsed into one line), require this script instead:
```ruby
require 'pretty_trace/enable-trim'
```
If you prefer to have more control, you can configure these settings
manually:
```ruby
require 'pretty_trace'
# Exceptions here will not be formatted
PrettyTrace.enable
# Exceptions here will be formatted
PrettyTrace.disable
# Exceptions here will not be formatted
PrettyTrace.enable
PrettyTrace.trim
PrettyTrace.reverse
# Exceptions here will be formatted, trimmed and in reverse order
PrettyTrace.no_trim
PrettyTrace.no_reverse
# Exceptions here will not be trimmed or reversed
```
## Configuration
### Filtering specific paths
To filter out lines in the backtrace, use `PrettyTrace.filter`. This method
accepts a single regular expression, or an array of regular expressions.
Note that you can call this method several times, and it will aggregate all
your filters together.
```ruby
require 'pretty_trace/enable'
PrettyTrace.filter /rails/
PrettyTrace.filter [/gem/, /lib/]
```
If you wish to temporarily disable Pretty Trace (for example, when you need
to see the full trace paths), you can set the environment variable
`PRETTY_TRACE=off` before running your script:
```shell
$ PRETTY_TRACE=off ruby myscript.rb
```
If you wish to temporarily disable trimming and filtering, you can set the
environment variable `PRETTY_TRACE=full` before running your script:
```shell
$ PRETTY_TRACE=full ruby myscript.rb
```
### Showing a debug tip
If you wish to see a debug tip, reminding you to set `PRETTY_TRACE` to `full` or `off` when an error occurs, use `PrettyTrace.debug_tip`:
```ruby
require 'pretty_trace/enable'
PrettyTrace.debug_tip # enable debug tip
PrettyTrace.no_debug_tip # disable debug tip
```
## Contributing / Support
If you experience any issue, have a question or a suggestion, or if you wish
to contribute, feel free to [open an issue][issues].
---
[issues]: https://github.com/DannyBen/pretty_trace/issues