Calva Power Tools

A VSCode extension for Clojure and ClojureScript development that adds commands for popular Clojure libraries and tools.

Usage

1. Install the extension from the VSCode Marketplace.
2. Open the command palette with ctrl+shift+p or cmd+shift+p.
3. Start typing to fuzzy search for commands. E.g. Clay to see the available Clay commands.

Supported Tools

• Clay for literate programming and data visuallization.

Prerequisites

• Calva will be installed automatically when you install Calva Power Tools.
• Clay added to deps.edn (when using Clay)

Rationale

Users access IDE functionality via commands and the command palette, but tools and libraries cannot add these to VSCode except via an extension. Calva Power Tools is a contributor friendly way for library and tool authors to provide commands in VSCode without making a separate extension.

Contributing

Issues and pull requests are welcome. Please see CONTRIBUTING

Adding a new command

1. Add the command name and title in package.json.
   • The command name should be unique and follow the format <library>.<command>.
   • The title should be a human-readable name for the command.
   • The command should be added to the contributes.commands array.
2. Add keybindings for the command in package.json (optional).
   • The keybinding should be added to the contributes.keybindings array.
3. Add clojure snippets they should invoke in src/calva_power_tools/tool (see src/calva_power_tools/tool/clay.cljs for an example).
   • Fully qualify symbols in snippets to avoid uninitialized namespace issues
4. Register them in src/extension.cljs in the activate function.

Development

The paved path is:

1. npm run watch. This starts Clojure with an nREPL server. (You can run the build task command inside VSCode).
   • Wait for it to report something like:

     nREPL server started on port 56749 on host localhost - nrepl://localhost:56749
     

2. ctrl+alt+c ctrl+alt+c. This runs the command: Calva: Connect to a Running REPL Server in the Project
   • It will connect the Clojure REPL, start a ClojureScript (shadow-cljs) REPL, and build the extension.
   • This will compile the extension and run the tests. Wait for the Build+watch extension to show that the tests have ran, and for Calva to pop up a progress dialog looking something like so:
   • Hint: The ClojureScript app is your extension.
3. F5. This starts the VS Code Development Extension Host (because configured to do so in .vscode/launch.json)
   • The development extension host is a VS Code window where your extension under development is installed. You now need to activate it to actually start the ClojureScript app.
   • The extension auto-activates, now your ClojureScript app and its REPL is started 🎉
4. Back in the development project you will see the progress dialog go away. Because now the development project window is connected to the Development Extension Host window's REPL.
   • Now you can hack on the extension code, which will update the app in the extension host window while it is running (a.k.a. interactive programming).

An important thing to note here is the steps where you activate your extension in the development host, starting the ClojureScript repl which Calva can connect to.

License

MIT

Free to use, modify and redistribute as you wish. 🍻🗽

Built VSC-ET, the VS Code Extension Template

• https://github.com/PEZ/vscode-extension-template