https://github.com/stateful/vscode-awesome-ux

Showcase of how to employ best practices to provide a high-fidelity user experience inside of VS Code extensions.
https://github.com/stateful/vscode-awesome-ux

List: vscode-awesome-ux

best-practices bestpractices extension vscode vscode-extension

Last synced: 3 months ago
JSON representation

Showcase of how to employ best practices to provide a high-fidelity user experience inside of VS Code extensions.

• Host: GitHub
• URL: https://github.com/stateful/vscode-awesome-ux
• Owner: stateful
• License: mit
• Created: 2021-10-20T19:37:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T22:13:29.000Z (over 1 year ago)
• Last Synced: 2024-08-09T17:26:50.312Z (3 months ago)
• Topics: best-practices, bestpractices, extension, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=stateful.awesome-ux
• Size: 825 KB
• Stars: 42
• Watchers: 9
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
An Awesome VSCode Extension [![Tests](https://github.com/stateful/vscode-awesome-ux/actions/workflows/test.yaml/badge.svg)](https://github.com/stateful/vscode-awesome-ux/actions/workflows/test.yaml) ![license](https://img.shields.io/github/license/stateful/vscode-awesome-ux.svg)

===========================

This extension is a best practices guide for writing great VSCode extensions. It can be used as boilerplate template to start of with a new extension.

## Features

In itself this extension doesn't do much. It has some webviews, panels and commands implemented to show you how to interact with the [VSCode APIs](https://code.visualstudio.com/api/references/vscode-api).

The current version looks as follows:

![Demo](./.github/assets/vscode.gif)

## Best Practices

We have accumulated a set of best practices while developing VSCode extensions. Please note that these are just recommendations, sometimes based on personal preference. There are many ways to write an extension, and we found the following allow you to write them in a scaleable and testable way:

- [Initiate Extensions through an `ExtensionController`](./docs/ExtensionController.md)

- [Building WebViews](./docs/WebViews.md)

If you have more best practices, please share them with us by raising a PR or [filing an issue](https://github.com/stateful/vscode-awesome-ux/issues/new).

## Extension Settings

This extension contributes the following settings:

* `vscode-awesome-ux.configuration.defaultNotifications`: The default value of received example notification (default `0`)

## Release Notes

See [release section](https://github.com/stateful/vscode-awesome-ux/releases).

---

Copyright 2022 - 2023 © Stateful – MIT License