https://github.com/nicolaspetton/indium

A JavaScript development environment for Emacs
https://github.com/nicolaspetton/indium

chrome debugger emacs inspector javascript nodejs repl

Last synced: 16 days ago
JSON representation

A JavaScript development environment for Emacs

• Host: GitHub
• URL: https://github.com/nicolaspetton/indium
• Owner: NicolasPetton
• License: gpl-3.0
• Created: 2016-05-26T11:05:48.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-06-01T20:44:29.000Z (almost 2 years ago)
• Last Synced: 2025-04-07T22:11:18.844Z (16 days ago)
• Topics: chrome, debugger, emacs, inspector, javascript, nodejs, repl
• Language: Emacs Lisp
• Homepage: https://indium.readthedocs.io
• Size: 2.24 MB
• Stars: 1,134
• Watchers: 31
• Forks: 62
• Open Issues: 31
• Metadata Files:
  • Readme: readme.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Indium

[![MELPA](https://melpa.org/packages/indium-badge.svg)](https://melpa.org/#/indium)

[![Emacs](https://img.shields.io/badge/Emacs-25-8e44bd.svg)](https://www.gnu.org/software/emacs/)

[![Build Status](https://drone.petton.fr/api/badges/nico/Indium/status.svg)](https://drone.petton.fr/nico/Indium)

[![Documentation Status](https://readthedocs.org/projects/indium/badge/?version=latest)](https://indium.readthedocs.io/en/latest/?badge=latest)

[![Liberapay](https://img.shields.io/liberapay/receives/NicolasPetton.svg?logo=liberapay)](https://img.shields.io/liberapay/receives/NicolasPetton.svg?logo=liberapay)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/indium-emacs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



A JavaScript development environment for Emacs.

Indium connects to a browser tab or nodejs process and provides many features for

JavaScript development, including:

- a REPL (with auto completion) & object inspection;

- an inspector, with history and navigation;

- a scratch buffer (`M-x indium-scratch`);

- JavaScript evaluation in JS buffers with `indium-interaction-mode`;

- a stepping Debugger, similar to `edebug`, or `cider`.

## Documentation

Installation instruction and other documentation can be found on

[readthedocs](https://indium.readthedocs.io).

**WARNING**: Indium 2.0 now uses a client/server architecture, see [installation

instuctions](https://indium.readthedocs.io/en/latest/installation.html).

## Screenshots

The stepping debugger

![Debugger](./screenshots/debugger.gif)

The REPL with company-mode

![REPL](./screenshots/repl.png)

The REPL showing clickable output

![REPL](./screenshots/repl2.png)

The inspector

![Inspector](./screenshots/inspector.png)

## Missing features

Indium is young, here's a list of missing/wanted features

- ~~Code evaluation using `C-x C-e` from project JS buffers~~

- ~~Adding breakpoints (to remove the need for `debugger` statements)~~

- Network inspector (could get inspiration from restclient.el)

- DOM inspector

- ~~Start processes (chromium, node, grunt, gulp, etc.) from Emacs and attach a

  indium connection to it.~~

## Backends

There is currently support for Chrom[e|ium] & nodejs.  The firefox backend is

in the TODO list.