Have yourself a VSCode Biscuit
September 27, 2020
We have a series of VSCode plugins that make code easier to read without having to lose your current context.
- Assorted Biscuits Marketplace - Github
- HTML Biscuits Marketplace - Github
- CSS Biscuits Marketplace - Github
- JS/TS Biscuits Marketplace - Github
This story starts like many others. The idea sprang from a completely unrelated project. We were working on some Flutter and the extension for Flutter adds some really nice annotations to improve the legibility of the nested component syntax.
I don't know what they call the annotations, but I wanted the same kind of functionality in more than just flutter. HTML and div soup was an obvious first problem to solve. When I thought about the use case, it reminded of breadcrumbs helping me navigate my code. But, bigger and better, so they became biscuits.
Visual Studio Code makes it incredibly easy to customize the functionality of the whole thing. There are even some boilerplates to help get up and running quicker.
One of the nice things is that VSCode includes a Language Server for HTML out of the box. So, I didn't have to do too much extra dependency bundling. If you are not familiar with the LSP(Language Server Protocol), it is an effort to standardize how all editors can interact with compilers. Many of them expose direct access the Abstract Syntax Tree.
What this means, is that I can crawl the the entire tree of source code and reference all the awesome metadata that the compiler has access to.
Next, we needed to figure out how to annotate the lines. I figured that the Flutter plugin already does and so does Git Lens. So, we know there is an API. It turns out that VSCode calls those "Decorations"
After that, we just made sure the user can configure the important things about the Biscuits. Their prefix text, max length, minimum block lines, and color. Yes, the prefix supports emoji.
The HTML plugin opened up more ideas. What other languages did we have Language Servers for in VSCode? CSS Biscuits just uses the SCSS language server under the hood. We also have a JS/TS one, but it is the buggiest of the bunch.
However, we ran into some trouble when I tried to do the C# extension. For the life of me, I could not figure out how to get the Language Server working. It could have been missing build tools etc, but if I was missing them, other people would be too. This needed to be a smooth install process.
A viewer on my stream mentioned Tree Sitter. At first, it seemed unrelated because it's at the same level as any other build tool you would need. However, then we discovered web-tree-sitter, a WASM compiled version of tree sitter itself. Its maintained in the same repo as a sub package.
Armed with that, we needed to find "grammars" to allow tree sitter to parse our code in the editor.These grammars end up also needing to be compiled to WASM and some of them just didnt work. The problem most likely existed between the keyboard and the chair. However, we ended up still getting the ability to support these languages to varying degrees:
It was a lot of fun and a huge adventure digging into the APIs and tools available for extension developers. I have seen more downloads for HTML biscuits than I ever expected.