If you run into issues with Indium, this document might help you.
General advices before reporting issues¶
Issues should be reported on the GitHub issue tracker.
1. If you encounter errors, you can enable
debug-on-error in Emacs using
toggle-debug-on-error and report an issue with the backtrace.
2. It is also a good idea to turn on Indium’s log mode with
indium-client-debug t), and attach to the issue report the contents of the
*indium-debug-log* buffer to help resolve the issue.
Attaching the contents of the
*indium-process* buffer can help as well in
case an error happens in the server process.
The Indium server doesn’t start¶
First, make sure that
indium is installed as documented in the
The Indium server section.
If you encounter the error:
"error in process filter: Indium server process error: env: node: No such file or directory"
Chances are that
node is not in Emacs’
exec-path. In this case, you can
fix it by appending the correct directory to
exec-path, or use the
(require 'exec-path-from-shell) (exec-path-from-shell-initialize)
Breakpoints are not set (not using sourcemaps)¶
If breakpoints do not work, chances are that the project is not configured correctly.
Indium needs to know how to map script source urls to files on disk.
It uses the
webRoot) configuration option as the
base path, as described in the General configuration page.
Indium provides a command
indium-list-script-sources to list all scripts
parsed by the backend, displaying their sources mapped to files on disk. Check
that the file where you’re trying to add a breakpoint is listed.
Breakpoints and debugging do not work (using sourcemaps)¶
Correctly mapping sourcemaps to file locations can be tedious (see Using sourcemaps).
Indium provides the command
indium-list-sourcemap-sources to help
configuring sourcemaps correctly. This command displays a list of all
sourcemap sources in the runtime as file paths on disk. Check that your files
are listed there.