BetterThanTomorrow/calva

Make calva-lib able to use Token Cursor things

Open

#479 opened on Nov 21, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Clojure (1,243 stars) (194 forks)batch import
calva-libdevhelp wantedpareditparsing

Description

Today the TypeScript code uses the calva-lib JavaScript library built by shadow-cljs. But we need to be able to use parts of the TS code as well.

The main use case right now is to be able to use our own Paredit module from calva-lib. Which is currently not possible.

PR #475 is trying to help us get rid of using paredit.js in exchange for our own, maintained, and much more complete implementation.

The reason we can't use our Token Cursor and Paredit in calva-lib is that it creates circular referencing the TS needs calva-lib.js to compile, and thus calva-lib can't depend on the TS code. The solution seems to be to be able to first compile a library of TS code that is not dependent on calva-lib.js, that can then be used from calva-lib.

I suspect there might be other issues needed to be solved here. Mainly to figure out how such a library should be built in a way that will:

  • be consumable by shadow-cljs
  • let us keep the ability to use the debugger on the library code

Contributor guide

Tech stack
typescriptjavascript
Domain
toolingbuild systemdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
understanding of TypeScriptunderstanding of JavaScriptfamiliarity with shadow cljs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The issue aims to enable calva lib to use TypeScript code (Token Cursor and Paredit) currently only available in the TS side. The main blocker is circular dependency: TS needs calva lib.js, and calva lib cannot depend on TS. The proposed solution is to compile a TS library independent of calva lib.js that can be consumed by shadow cljs. Investigate PR #475 which attempts to replace paredit.js. Determine how to build such a library while preserving debugger capabilities and ensuring shadow cljs compatibility.
Make calva-lib able to use Token Cursor things · BetterThanTomorrow/calva#479 | Good First Issue