https://github.com/cirru/calcit-editor
Intuitive S-expressions editing for Clojure(Script).
https://github.com/cirru/calcit-editor
cirru clojurescript respo syntax-tree
Last synced: about 1 month ago
JSON representation
Intuitive S-expressions editing for Clojure(Script).
- Host: GitHub
- URL: https://github.com/cirru/calcit-editor
- Owner: Cirru
- License: mit
- Created: 2017-07-04T10:59:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T04:26:51.000Z (6 months ago)
- Last Synced: 2025-02-25T02:39:58.657Z (about 2 months ago)
- Topics: cirru, clojurescript, respo, syntax-tree
- Language: Cirru
- Homepage: http://calcit-editor.cirru.org/
- Size: 7.6 MB
- Stars: 226
- Watchers: 11
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Calcit Editor
------
> Intuitive S-expressions editing for Clojure(Script).
* **Auto Layout**: expressions in blocks and inline-blocks, styled with CSS
* **Tree Editing**: intuitive way of structural editing as nested expressions
* **Call Stack Navigation**: more fine-grained functions navigation
* **Collaboration**: changes real-time synced among multiple clients via WebSockets
One function/definition in a screen, `Command d` to open called function at next tab, `Command j` `Command k` `Command i` to switch:
Based on DOM/CSS, easy for another theme:
`Command p` to search and jump inspired by Sublime Text :
Browse namespaces and functions/variables:
### Usages
Install CLI and start a local WebSocket server, it uses `calcit.cirru` as a snapshot file:
```bash
npm i -g calcit-editor
calcit-editor
```
UI of the editor is a webapp on http://calcit-editor.cirru.org/?port=6001
You may try with my project templates:
* simple virtual DOM playground [calcit-workflow](https://github.com/mvc-works/calcit-workflow)
* a toy Node.js script [calcit-nodejs-workflow](https://github.com/mvc-works/calcit-nodejs-workflow)
or even clone current repo for trying out.
Don't forget to check out [keyboard shortcuts](https://github.com/Cirru/calcit-editor/wiki/Keyboard-Shortcuts). My old [introduction videos](https://www.youtube.com/watch?v=u5Eb_6KYGsA&t) can be found on YouTube.
### Options
CLI variables for compiling code directly from `calcit.cirru`:
```bash
op=compile calcit-editor
```
The web UI takes several query options:
```
http://calcit-editor.cirru.org/?host=localhost&port=6001
```
* `port`, defaults to `6001`
* `host`, defaults to `localhost`, connects via WebSocket
By default, ClojureScript code is emitted in `src/` by pressing `Command s`.
When server is stopped with `Control c`, `calcit.cirru` is also updated.
There are also several options in `:configs` field in `calcit.cirru`:
* `port`, defaults to `6001`
* `output`, defaults to `src/`
* `extension`, defaults to `.cljs`
Editor UI is decoupled with WebSocket server, so it's okay to connect remote server from multiple pages with all expressions synced in real-time.
Also there's a local version of web editor to enable:
```bash
ui=local calcit-editor
# serving UI at http://localhost:6101
```
### Compact output
> It's now also splitted into https://github.com/calcit-lang/editor .
```bash
compact=true caclcit-editor
```
When `:compact-output? true` is specified in `calcit.cirru`, "Compact Mode" is activated. Clojure(Script) will no longer be emitted,
instead two files will be emitted:
* `compact.cirru` contains a compact version of data tree of the program.
* `.compact-inc.cirru` contains diff information from latest modification of per definition.
It's not useful for Clojure but would can be used for other experiments in [calcit-runner](https://github.com/Cirru/calcit-runner.rs).
### Workflow
Based on https://github.com/Cumulo/cumulo-workflow
### License
MIT