BetterThanTomorrow / calva

Clojure & ClojureScript Interactive Programming for VS Code
https://marketplace.visualstudio.com/items?itemName=betterthantomorrow.calva
Other
1.62k stars 213 forks source link

User Guide: Calva + REBL + deps.edn #1234

Open BillyBadBoy opened 3 years ago

BillyBadBoy commented 3 years ago

I've only just started with Clojure so this may just be a case of my ignorance, but I had a problem following the instructions for setting up Calva + REBL + deps.edn. The user guide says add the following to settings.json

{
    "calva.replConnectSequences": [
        {
            "name": "Rebl Connect",
            "projectType": "deps.edn",
            "menuSelections": {
                "cljAliases": [
                    "rebl",
                    "rebl-12",
                    "nrebl"
                ]
            }
        }
    ]
}

But this didn't work because it's missing an entry for cljsType. (I fixed this by adding "cljsType": "none")

Should the snippet in the user guide include a cljsType entry or is it deliberately missing?

bpringe commented 3 years ago

Thanks for reporting that. Judging by the related ReplConnectSequence Typescript interface and the package.json, it looks like it's required. Judging by some of the code, it looks like maybe that was not the case at some point.

We probably should update both the deps.edn and Leiningen sections on this page to include that property: https://calva.io/rebl/

We probably should also update this page to say that the property is required: https://calva.io/connect-sequences/

Let's make sure with @PEZ that this is the right thing to do, and if so, a PR for the doc changes would be very welcome.

PEZ commented 3 years ago

I don't recall why that would be mandatory. I agree we should make that clearer, and certainly fix broken examples.