https://github.com/sogaiu/ajrepl
A mode for interacting with a Janet REPL
https://github.com/sogaiu/ajrepl
editor-plugin emacs janet repl
Last synced: 5 months ago
JSON representation
A mode for interacting with a Janet REPL
- Host: GitHub
- URL: https://github.com/sogaiu/ajrepl
- Owner: sogaiu
- Created: 2021-12-01T06:05:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T03:37:04.000Z (about 1 year ago)
- Last Synced: 2024-11-18T04:35:40.388Z (about 1 year ago)
- Topics: editor-plugin, emacs, janet, repl
- Language: Janet
- Homepage:
- Size: 164 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ajrepl
A mode for interacting with a Janet REPL
## Setup
How to set things up varies a bit depending on how one manages one's
Emacs, e.g. straight.el, Doom, etc. What's common to all situations
is likely:
* Ensure [janet-ts-mode](https://github.com/sogaiu/janet-ts-mode) or
`janet-mode` is installed and configured. (If using `janet-mode`,
replace `janet-ts-mode` and `janet-ts-mode-hook` below with
`janet-mode` and `janet-mode-hook` respectively.)
* Clone this repository.
### Manual
* If you cloned to `~/src/ajrepl`, add the following to your
`.emacs`-equivalent:
```elisp
(add-to-list 'load-path
(expand-file-name "~/src/ajrepl"))
(require 'ajrepl)
(add-hook 'janet-ts-mode-hook
#'ajrepl-interaction-mode)
```
### Elpaca
* Add something like the following to your `.emacs`-equivalent:
```elisp
(use-package ajrepl
:elpaca (:host github
:repo "sogaiu/ajrepl"
:files ("*.el" "ajrepl"))
:config
(add-hook 'janet-ts-mode-hook
#'ajrepl-interaction-mode))
```
### straight.el
* Add something like the following to your `.emacs`-equivalent:
```elisp
(straight-use-package
'(ajrepl :host github
:repo "sogaiu/ajrepl"
:files ("*.el" "ajrepl")))
(use-package ajrepl
:straight t
:config
(add-hook 'janet-ts-mode-hook
#'ajrepl-interaction-mode))
```
### Doom
* The following might work for Doom:
```elisp
(package! ajrepl
:recipe (:type git
:host github
:repo "sogaiu/ajrepl"
:files (:defaults ("ajrepl/"
"ajrepl/*"))))
(use-package! ajrepl
:after janet-ts-mode
:config
(add-hook 'janet-ts-mode-hook
#'ajrepl-interaction-mode))
```
### package.el
* Sorry, no support for that. The manual instructions should work
though.
## Usage
0. Open a Janet file
1. Start an interactive REPL for Janet by `M-x ajrepl`.
A buffer for a Janet repl should appear.
2. Various forms of sending things to the REPL should be possible, e.g.
* Send buffer (`C-c C-b`)
* Send expression at point (`C-x C-e`)
* Send top-level expression at point (`C-M-x`)
* Send expression upscoped (`C-c C-u`) - see below for details
* Send region (`C-c C-r`)
If Emacs' menus are enabled, there should be a `Ajrepl` menu
which shows the above (and other) commands.
## Misc Notes
`ajrepl-send-expression-upscoped` can be handy when evaluating forms
such as `(import ...)` which might otherwise lead to output one might
not be interested in.
## Experimental Commands
There's also a file named `ajrepl-experiment.el` that contains some
experimental (aka "may not stick around") functionality.
If the file is required, it should add some additional things to the
`Ajrepl` menu. Alternatively, using the "Enable Experimental
Features" menu item under the `Ajrepl` menu may work too.
## Credits
* sarna - discussion about repl buffer messiness
* sbocq - discussion and code about `eval-defun`
## Issues
* The REPL buffer gets very messy due to prompt information from
`janet`.
There are some commands in `ajrepl-experiment.el` (see above for how
to enable) that are an attempt to improve this situation:
* `ajrepl-simplify-repl-prompt`
* `ajrepl-timestampify-repl-prompt`
For more details, have a look starting at [this issue
comment](https://github.com/sogaiu/ajrepl/issues/4#issuecomment-3149618006)
and later.