https://github.com/pez/my-extension

https://github.com/pez/my-extension

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pez/my-extension
• Owner: PEZ
• License: mit
• Created: 2024-12-22T10:22:16.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-22T10:22:18.000Z (over 1 year ago)
• Last Synced: 2025-06-13T05:15:46.383Z (about 1 year ago)
• Language: Clojure
• Size: 2.81 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# VSC-ET

A VS Code Extension Template. Or an automated [VS Code](https://code.visualstudio.com) **extension development** workflow, with support for [coding](#coding), [building](#building), [testing](#testing), [end-to-end testing](#end-to-end-testing), and [publishing the extension](#publishing-the-extension) to the [VS Code Marketplace](https://marketplace.visualstudio.com/vscode) and the [Open VSX Registry](https://open-vsx.org/).

![alt text](assets/vsc-et-published.png)

The workflow is powered by [Interactive Programming](https://en.wikipedia.org/wiki/Interactive_programming). You can use the extension while you are hacking on it, without reloading the extension host. The feedback is instantaneous. As it should be to keep coding productive and maximum fun.

## Who is this for?

It is probably for you. 😄 Especially if you would like to build an extension for VS Code. Also if:

- You want to explore what it takes to publish an extension to the VS Code Marketplace in an automated manner.

- Like to have the plumbing for testing, including end-to-end testing, in place from the get-go, ready for you to fill in as you build your extension

- You would like to learn Clojure/ClojureScript in a fun way

- Interactive Programming is your thing

- You think that Interactive Programming might be your thing

## What are the prerequisites?

The tools you need to get started are:

- [VS Code](https://code.visualstudio.com/)

  - The [Calva](https://calva.io) extension

  - The [Joyride](https://github.com/BetterThanTomorrow/joyride) extension

- [Node.js](https://nodejs.org/)

- [Java](https://jdk.java.net/23/)

- [Clojure CLI](https://clojure.org/guides/install_clojure)

- [Babashka](https://github.com/babashka/babashka#installation)

Add your curiosity and you should be good to go. To just try the template/workflow out, you do not need to know any ClojureScript (or even programming). When you start to try make the extension do something interesting, you will need to know _some_ Clojure/ClojureScript. Learning Clojure will be a fun endeavor, I promise.

## How do I get started?

On Github **Use this template**, and name your repository, say you are full of imagination and name it **my-extension**. Clone your repo and open it in VS Code.

Then the paved path is:

1. cmd/ctrl+shift+b. This starts the default build task, which is configured (in [.vscode/tasks.json](.vscode/tasks.json) to start shadow-cljs watcher.

   * Let it compile the extension and run the tests.

1. F5. Starts the VS Code Development Extension host (because configured to do so in [.vscode/launch.json](.vscode/launch.json))

   * This is a VS Code window where your extension under development is installed.

1. In the extension development host cmd/ctrl+shift+p, find and run the command **Extension template: Say hello!**

   ![VS Code Command Palette, ET hHello command](assets/usage/say-hello.png)

   * This activates your extension and starts the ClojureScript REPL

1. Back in the development project run the command **Calva: Connect to a Running REPL Server in the Project**:

   1. Select the project root **my-extension**

   1. Select the project type **shadow-cljs**

   1. Select to connect to the build `:extension`

      * Now you can hack on the extension code and the extension in the development host window will be updated while it is running (interactive programming).

The 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. Depending on the extension you build, it may be that it activates automatically, or by some specific file appearing or whatever. The point is that it needs to be started for Calva to connect to it, and it starting the development host is often not enough to start your extension. (You can actually start the Calva connect before you start the extension host. Calva will connect when the repl is started.)

To be continued...

## Who built this?

My name is Peter Strömberg, a.k.a. [PEZ](https://github.com/PEZ). I love Clojure and VS Code, and I love to build things. I created Calva, an extension for working with Clojure in VS Code. I also co-created Joyride, a scripting environment for VS Code that lets you extend the editor in user space (i.e. without creating an extension). I've also created Paste Replace, and a whole bunch of Joyride scripts, big and small (mostly small).

I created this template because I want to share what I have figured out about building and maintaining extensions for VS Code. To me it is the most fun and rewarding way to spend my time, and I want you to have as much fun as I get. 😄 Calva is mostly built with TypeScript, and I'd like to contribute to you building your extensions in a more civilized programming language.

That said, the workflow and automation used in the template are used for Calva, as well as with my pure ClojureScript extensions, so if you find the rest of the automation in this template useful, you can most definitely use it with a TypeScript tool chain.

## License

MIT

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

## Sponsor my open source work ♥️

That, said, you are welcome to show me you like my work using this link:

* https://github.com/sponsors/PEZ