https://github.com/keesschollaart81/vscode-home-assistant
Visual Studio Code Extension for Home Assistant. ⭐ if you think this is cool!
https://github.com/keesschollaart81/vscode-home-assistant
hacktoberfest home-assistant-config home-assistant-configuration
Last synced: 6 months ago
JSON representation
Visual Studio Code Extension for Home Assistant. ⭐ if you think this is cool!
- Host: GitHub
- URL: https://github.com/keesschollaart81/vscode-home-assistant
- Owner: keesschollaart81
- Created: 2019-03-16T15:13:30.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-07-27T09:15:30.000Z (about 1 year ago)
- Last Synced: 2024-08-02T16:12:36.373Z (about 1 year ago)
- Topics: hacktoberfest, home-assistant-config, home-assistant-configuration
- Language: TypeScript
- Homepage:
- Size: 13.9 MB
- Stars: 530
- Watchers: 12
- Forks: 112
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant) [](https://github.com/keesschollaart81/vscode-home-assistant/releases)
# Getting started
1. Install via the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant)
2. Open your (local copy of the) Home Assistant Configuration with VS Code
3. Configure the connection to Home Assistant via the HA Section in the VS Code Settings UI
More details in [the How-To in the Wiki](https://github.com/keesschollaart81/vscode-home-assistant/wiki/Configure-connection-to-HA)
4. Enjoy the features showcased below 👇
5. Continue reading in the Wiki:
- [Configure connection to HA](https://github.com/keesschollaart81/vscode-home-assistant/wiki/Configure-connection-to-HA)
- [VS Code Remote SSH](https://github.com/keesschollaart81/vscode-home-assistant/wiki/VS-Code-Remote-SSH)
- [Your config, local or remote?](https://github.com/keesschollaart81/vscode-home-assistant/wiki/Your-config,-local-or-remote%3F)
- [The troubleshooting guide](https://github.com/keesschollaart81/vscode-home-assistant/wiki/Troubleshooting)
# Features
## Completion for Entity IDs, Services, Scenes and Triggers
When connected with your Home Assistant server, entity id' and services will be auto-completed.
## Completion & Validation for Configuration & Lovelace Schema
Most of the scheme's of Home Assistant will be validated and things like properties, values and enums will be auto-completed. This extension understands the behaviour of Home Assistant '!include...' behaviour and use this to provide scoped validation for all your files.
Deprecation Warnings:
Schema Documentation
## Go to Definition for Includes
Easy navigate between your files references via the different !include... tags using 'f12' / 'Go to Definition'.
## Snippets
Snippets allow you to create commonly used data structures very quickly.
## Commands
Commands allow you to quickly interact with Home Assistant! Find them using Cmd+shift+P and type 'Home Assistant'
## Render templates
Evaluate jinja templates via Home Assistant's API and see how they would render.
# Contribution
- [How to update the schemas](https://github.com/keesschollaart81/vscode-home-assistant/wiki/HowTo:-Update-the-schema's)
- [Local Development](https://github.com/keesschollaart81/vscode-home-assistant/wiki/Local-development-of-this-Extension)
# Release Notes
Read all the recent changes in the [GitHub releases section](https://github.com/keesschollaart81/vscode-home-assistant/releases)
# Feedback / Ideas
Create an [issue](https://github.com/keesschollaart81/vscode-home-assistant/issues/new/choose), reach out to me on [Twitter](https://twitter.com/keesschollaart) or the [Home Assistant Discord](https://discord.gg/c5DvZ4e).
# Things to do / up for grabs
- [ ] Go to Definition for entities, scripts and automations
- [ ] Autocomplete !secrets
- [ ] Check local config with HA Server
# Telemetry
This extension collects telemetry data to help us build a better experience for
using VS Code with Home Assistant. We use [vscode-extension-telemetry](https://github.com/Microsoft/vscode-extension-telemetry),
which reports the following data:
- Extension name
- Extension version
- Machine ID and session ID from VS Code
- Operating system
- Platform version
Additionally, if the language server fails to activate, we report the diagnostic
data the language server produces. The extension respects the `telemetry.enableTelemetry`
setting, which you can learn more about at VS Code's
[telemetry FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).