An open API service indexing awesome lists of open source software.

https://github.com/bobbicodes/lang-clojure-eval

Clojure plugin for Codemirror 6 with live inline evaluation
https://github.com/bobbicodes/lang-clojure-eval

Last synced: 11 months ago
JSON representation

Clojure plugin for Codemirror 6 with live inline evaluation

Awesome Lists containing this project

README

          

# lang-clojure-eval [![NPM version](https://img.shields.io/npm/v/lang-clojure-eval?color=purple)](https://www.npmjs.com/package/lang-clojure-eval)

A Codemirror 6 language extension based on the [Lezer Clojure](https://github.com/nextjournal/lezer-clojure) parser, with inline-evaluation support via the [Small Clojure Interpreter (SCI)](https://github.com/babashka/sci).

## API Reference



clojure() → LanguageSupport


Clojure language support including evaluation.




clojureLanguage: LRLanguage


A language provider based on the Lezer Clojure
parser
, extended with
highlighting and indentation information.




evalExtension: Extension


Inline-evaluation support via the Small Clojure Interpreter



## Java interop

Since many commonly used Java methods are not accessible because we are in a JavaScript environment, a limited subset have been ported into Clojure for compatibility. If you'd like to use one that has not been ported, please file an issue and we'll see what we can do.

## Status

Alpha. Certainly contains bugs. There is a [live demo](https://bobbicodes.github.io/lang-clojure-eval/) running which is continuously built from the main branch.

- ✅ Implement Lezer parser
- ✅ Hook up Clojure interpreter
- ✅ Eval-cell
- ✅ Eval-at-cursor
- ✅ Eval top-level form
- ✅ Display results inline
- ✅ Implement clear-events
- ✅ [Publish to npm](https://www.npmjs.com/package/lang-clojure-eval)
- ✅ Create test suite
- ✅ Test published package
- ✅ Handle errors
- ✅ Pretty-print eval result
- ✅ Truncate very long eval result
- ✅ Handle infinite loops

## Run demo locally

```bash
npm install
npm run dev
```

## Dev

To compile sci.js from the Clojurescript source:

```bash
npx shadow-cljs release sci
```

## Credits

- The [lang-clojure](https://github.com/nextjournal/lang-clojure/) extension provides the Lezer parser, highlighting and formatting information.
- Evaluation functionality ported from Nextjournal's [clojure-mode](https://github.com/nextjournal/clojure-mode/).
- [SCI](https://github.com/babashka/sci) compiled to ESM with [shadow-cljs](https://github.com/thheller/shadow-cljs).
- [4ever-clojure](https://github.com/oxalorg/4ever-clojure/) for the nice stacktraces