@githubocto/snowpack-vscode-extension-template

A create-snowpack-app template for writing VS Code extensions with webviews

Showing:

Popularity

Downloads/wk

2

GitHub Stars

6

Maintenance

Last Commit

1mo ago

Contributors

2

Package

Dependencies

4

Size (min+gzip)

1.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

snowpack-vscode-extension-template

This is a template for create-snowpack-app which scaffolds a VS Code extension with webviews.

npx create-snowpack-app my-vscode-extension --template @githubocto/snowpack-vscode-extension-template

🚫 Edit: Nope, this won't work for create-snowpack-app because CSA strips out all the parts in package.json that are needed for a VS Code extension.

Workaround: Clone this repo, rm -rf .git and then edit to your hearts' content.

Why does this exist?

The VS Code extension environment comes with a lot of limitations that make it difficult to develop for. Webviews run inside an iframe, and must communicate with the extension via message passing. A strict content security policy is imposed, so that extensions can't go off and do Bad Things™ willy-nilly. There's no such thing as HMR.

While it's still fundamentally web technologies, it's a bear to set up in a fashion that feels like modern web development.

This CSA template offers the following niceties:

  • A working Typescript setup for both the extension and the webview.
  • A sample react app
  • Tailwind CSS for styling, using JIT
  • VS Code theme colors exposed as Tailwind colors for ease of "theme-native" styling.
  • Lots of little quality-of-life refinements, like a tasks.json which knows to wait for builds to complete before launching the extension host, and css_custom_data.json so that VS Code doesn't complain at you for using @tailwind directives in your css.
  • … And, of course, Snowpack for the fastest possible builds.

Sadly, incremental builds are not possible with the way that VS Code currently works. That means that each build is effectively "bundling for production" and is executing snowpack build for you.

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial