k32 / erlstack-mode

Minor mode for previewing code appearing in Erlang stack traces

Analyze Erlang stack traces

Enable erlstack-mode globally to peek at the source code of functions appearing in Erlang stack traces:

(require 'erlstack-mode)

Moving point to a stack trace will reveal code in question. This plugin works best with projectile, however it’s not a hard requirement.

Key bindings

The following key mappings are activated while point is on a stack trace:

• C-<up> Jump to the next stack frame
• C-<down> Jump to the previous stack frame
• C-<return> Open code for editing

Customizations

The following variables can be customized:

erlstack-file-search-hook

A hook that is used to locate source code paths of Erlang modules

erlstack-otp-src-path

Path to the OTP source code. Customize this variable to locate OTP modules.

erlstack-file-prefer-hook

A hook that is called when erlstack-file-search-hook returns multiple paths for a module. It can be used to pick the preferred alternative

erlstack-mode's Issues

Prefer OTP library modules

E.g. searching for list.erl in OTP can return mocks

Fix popup windows

Allow user selection of module alternative

Use EDTS to locate code

Tame popup windows

Never open the code popup in the same window with the stacktrace itself

delete-side-window is missing in Emacs 26

Detect missing projectile

erlstack-locate-projectile hook should detect when projectile is missing and avoid crashing

Fix stack frame regexp

The topmost stack frame may contain function arguments, this is currently not handled

Support new format of logger traces

On OTP21+ logger formats stack traces "nicely", which doesn't work with the regexp

Change delay for the first activation

The following behavior will be more user friendly:

1. Raise run-with-idle-timer interval to, say, 1 sec when overlay is not active
2. Use the old 0.1 value when overlay is active

It will reduce unintended triggering