Skip to content

Commit ba990c2

Browse files
committed
Update README and CHANGELOG for v2.0.47
1 parent 058dd2b commit ba990c2

File tree

2 files changed

+21
-29
lines changed

2 files changed

+21
-29
lines changed

CHANGELOG.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ Changes to Calva.
33

44
## [Unreleased]
55

6-
- [Fix dimming out of stacked ignored forms](https://github.com/BetterThanTomorrow/calva/issues/385)
7-
- [The extension should specify the default schemes for document selectors](https://github.com/BetterThanTomorrow/calva/issues/368)
8-
- [Make code more robust in case Jack-in task fails](https://github.com/BetterThanTomorrow/calva/issues/367)
6+
## [2.0.47] - 10.10.2019
97
- [Support Jack-in without file open for single-rooted workspace](https://github.com/BetterThanTomorrow/calva/issues/366)
108
- [Show argument list of fn](https://github.com/BetterThanTomorrow/calva/issues/238)
9+
- [Make code more robust in case Jack-in task fails](https://github.com/BetterThanTomorrow/calva/issues/367)
10+
- [Fix dimming out of stacked ignored forms](https://github.com/BetterThanTomorrow/calva/issues/385)
11+
- [The extension should specify the default schemes for document selectors](https://github.com/BetterThanTomorrow/calva/issues/368)
1112

1213
## [2.0.46] - 08.10.2019
1314
- [Connect warnings and errors as popups](https://github.com/BetterThanTomorrow/calva/issues/356)

README.md

+17-26
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@ Calva's main reason for existance is to _provide Visual Studio Code users with a
1616

1717
## How to Connect Calva to your project
1818

19-
Let Calva start your project (_a.k.a. **Jack-in**_).
19+
Let Calva start your project _a.k.a. **Jack-in**_. (Assuming you have a single project workspace. See [Workspace Layout](https://github.com/BetterThanTomorrow/calva/wiki/Workspace-Layouts) on the wiki for other setups)
2020

21-
1. Open your project in VS Code, and a file in the project. From the command line it could be something like: `code path/to/myproject README.md`.
21+
1. Open your project folder in VS Code.
2222
1. Issue the command **Start a Project REPL and Connect (aka Jack-In)**: `ctrl+alt+c ctrl+alt+j`.
2323
1. Answer the prompts where Calva asks you a few things about your project.
2424

25-
When Calva has connected, it will open a REPL window giving you some getting started tips, and you can start hacking. The first thing you should always do to ”wake” Calva is to load/evaluate the current Clojure(Script) file: `ctrl+alt+c enter`.
25+
When Calva has connected, it will open a REPL window giving you some getting started tips, and you can start hacking.
2626

27-
Troubles connecting? [Check here](https://github.com/BetterThanTomorrow/calva/wiki/Connect-Calva-to-Your-Project). (Please help keep that wiki page updated.)
27+
Troubles connecting? See [Connect Calva to Your Project](https://github.com/BetterThanTomorrow/calva/wiki/Connect-Calva-to-Your-Project) on the wiki. (Please help keep that page updated.)
2828

2929
## Something to try first
3030

31-
You might want to start with evaluating some code. Calva has this notion about the ”current” form (the symbol under the cursor or the paren enclosed s-expr immediately adjacent to the cursor). Issue the **Evaluate Current Form Inline** command: `ctrl+alt+c e`.
31+
You might want to start with evaluating some code. Calva has this notion about the ”current” form. Issue the **Evaluate Current Form Inline** command, `ctrl+alt+c e` with the cursor placed in different locations to get a feeling for how the current form is determined.
3232

33-
There is also a command for evaluating the current top level form, which aösp works inside `(comment)` forms supporting code experimentation. It looks something like so:
33+
There is also a command for evaluating the current top level form. Good for evaluating various `def`s `defn`, `defthis`, `defthat`. With your cursor placed anywhere inside such a form, issue the **Evaluate Current Top Level Form (defun)** command (`ctrl+alt+c space`).
34+
35+
The Top Level command also works inside `(comment ...)` forms, treating the `comment` as creating a new top level context. It is good for in-file code experimentation. To use it place the cursor inside a form contained inside a `(comment...)` and issue the command from there. It looks something like so:
3436

3537
![Annotate clojure code evaluation!](assets/howto/evaluate.gif)
3638

@@ -40,37 +42,22 @@ See also [Calva Top 10 Commands](https://github.com/BetterThanTomorrow/calva/wik
4042

4143
When something doesn't work and you think there might be a workaround for it, please see the [wiki](https://github.com/BetterThanTomorrow/calva/wiki/). Anyone can author the wiki so if you know about workarounds or gotchas or anything that is good to know about when using Calva, please edit the appropriate page (or create a new page).
4244

43-
4445
## Features
45-
46-
### At a glance
4746
- Syntax highlighting, plus:
4847
- Rainbow parens
4948
- Highlights misplaced brackets
5049
- LISP friendly bracket matching
5150
- Ignore form (`#_`) dimming and `(comment)` form highlighting
52-
- Clojure code formatting
53-
- Quickly and easily get your REPL connected
54-
- Evaluate code inline
55-
- Run tests
56-
- Integrated REPL windows
51+
- Code formatting and autoindent according to https://github.com/bbatsov/clojure-style-guide
52+
- Support for [Clojure tools/deps](https://clojure.org/guides/deps_and_cli), [Leiningen](https://leiningen.org), [shadow-cljs](http://shadow-cljs.org), [lein-figwheel](https://github.com/bhauman/lein-figwheel), and [Figwheel Main](https://figwheel.org), and Nashorn repls. (For [Boot](https://boot-clj.com), only Connect scenarios work, there is no Jack-in yet.)
53+
- Your [Custom Connect Sequences](https://github.com/BetterThanTomorrow/calva/wiki/Custom-Connect-Sequences), including fully customized CLJS REPLs.
54+
- Switch the CLJS REPL connection between your different CLJS builds at will.
5755
- Intellisense
5856
- Go to / Peek at definition
5957
- View docstrings on hover
6058
- View function signatures on hover
61-
- Supports all Clojure filetypes: `clj`, `cljc`, and `cljs`
62-
- Easy toggle between `clj` and `cljs` repl for `cljc` files
63-
- Autoindent according to https://github.com/bbatsov/clojure-style-guide
64-
- Enables `clj` evaluation of Clojure code in all files (e.g. Markdown, etcetera).
65-
- Support for [Clojure tools/deps](https://clojure.org/guides/deps_and_cli), [Leiningen](https://leiningen.org), [shadow-cljs](http://shadow-cljs.org), [lein-figwheel](https://github.com/bhauman/lein-figwheel), and [Figwheel Main](https://figwheel.org), and Nashorn repls. (For [Boot](https://boot-clj.com), only Connect scenarios work, no Jack-in yet.)
66-
- Your [Custom Connect Sequences](https://github.com/BetterThanTomorrow/calva/wiki/Custom-Connect-Sequences), including fully customized CLJS REPLs.
67-
- Switch the CLJS REPL connection between your different CLJS builds at will.
6859

69-
Demo: switch between `clj` and `cljs` repl sessions for `cljc` files:
70-
71-
![CLJC repl switching](/assets/howto/cljc-clj-cljs.gif)
72-
73-
### More in depth (and some usage info)
60+
### More features (and some usage info)
7461
- Running tests through the REPL connection, and mark them in the Problems tab
7562
- Run namespace tests: `ctrl+alt+c t`
7663
- Run all tests: `ctrl+alt+c shift+t`
@@ -103,6 +90,10 @@ Demo: Peek at definitions, etcetera:
10390

10491
![Features](/assets/howto/features.gif)
10592

93+
Demo: switch between `clj` and `cljs` repl sessions for `cljc` files:
94+
95+
![CLJC repl switching](/assets/howto/cljc-clj-cljs.gif)
96+
10697
### Test features not available with ClojureScript
10798

10899
Currently [`cider-nrepl` does not provide its test functionality for ClojureScript](https://github.com/clojure-emacs/cider-nrepl/issues/555) code. Please consider contributing to fixing that.

0 commit comments

Comments
 (0)