practicalli / practicalli/clojure

Reveal with Rebel Readline

Open
#315 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clojure cli data-tools
Dominant language
Makefile
Stars
117
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Test drive the alias below to make reveal work with Rebel Readline and add it to the practicalli/clojure-deps-edn configuration

Update the section on using Reveal with Rebel with the use of the alias
https://practicalli.github.io/clojure/clojure-tools/data-browsers/reveal.html#using-reveal-with-rebel-and-tap

This is a main-opts that should be tested

 :main-opts  ["-e" "(require,'rebel-readline.core),(require,'rebel-readline.clojure.line-reader),(require,'rebel-readline.clojure.service.local),(require,'rebel-readline.clojure.main),(require,'vlaaad.reveal)(rebel-readline.core/with-line-reader,(rebel-readline.clojure.line-reader/create,(rebel-readline.clojure.service.local/create)),(vlaaad.reveal/repl,:prompt,(fn,[]),:read,(rebel-readline.clojure.main/create-repl-read)))"]

More specifically it should be added full alias to practicalli/clojure-deps-edn

:repl/rebel-reveal 
{:extra-deps {com.bhauman/rebel-readline {:mvn/version "RELEASE"}
                               org.clojure/clojure {:mvn/version "RELEASE"}
                               vlaaad/reveal {:mvn/version "RELEASE"}}
  :main-opts  ["-e" "(require,'rebel-readline.core),(require,'rebel-readline.clojure.line-reader),(require,'rebel-readline.clojure.service.local),(require,'vlaaad.reveal)(rebel-readline.core/with-readline-in,(rebel-readline.clojure.line-reader/create,(rebel-readline.clojure.service.local/create)),(vlaaad.reveal/repl,:prompt,(fn[])))"]}

The improved way to use rebel and reveal together

:main-opts  ["-e" "(require,'rebel-readline.core),(require,'rebel-readline.clojure.line-reader),(require,'rebel-readline.clojure.service.local),(require,'rebel-readline.clojure.main),(require,'vlaaad.reveal)(rebel-readline.core/with-line-reader,(rebel-readline.clojure.line-reader/create,(rebel-readline.clojure.service.local/create)),(vlaaad.reveal/repl,:prompt,(fn,[]),:read,(rebel-readline.clojure.main/create-repl-read)))"]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by testing the supplied main-opts with Rebel Readline and Reveal, then compare the improved variant. Add the working full alias to the practicalli/clojure-deps-edn configuration and update the “using Reveal with Rebel and tap” section at the linked documentation page; done means the alias works and the instructions match it.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.