Skip to content

Commit

Permalink
Prepare for Marketplace
Browse files Browse the repository at this point in the history
  • Loading branch information
wfurphy authored Jan 12, 2023
1 parent 1e4a8ff commit cc4f636
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 22 deletions.
3 changes: 1 addition & 2 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
.vscode-test/**
.gitignore
vsc-extension-quickstart.md
*.vsix
images
*.vsix
10 changes: 6 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Change Log
# Button Card JS for VSCode Change Log

All notable changes to the "vscode-home-assistant-button-card-js" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
All notable changes to the `vscode-button-card-js` extension will be documented in this file. Using [Semantic Versioning](https://semver.org/).

## [Unreleased]

Expand All @@ -17,3 +15,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
### Added

- JS Tripple Square Brackets Injection Grammar for YAML language.

## [0.2.1] - 13th January 2023

- Prepare for VSCode Marketplace
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# Button Card Javascript Syntax Highlighting in VSCode

![release](https://img.shields.io/github/v/release/wfurphy/vscode-home-assistant-button-card-js)
![license](https://img.shields.io/github/license/wfurphy/vscode-home-assistant-button-card-js)
![release](https://img.shields.io/github/v/release/wfurphy/vscode-button-card-js)
![license](https://img.shields.io/github/license/wfurphy/vscode-button-card-js)

This is a very niche extension for Visual Studio Code which provides syntax highlighting of Javascript code blocks in YAML which are enclosed by triple square brackets (`[[[ ... ]]]`). Used when configuring the advanced _javascript templates_ properties of [Button-Card](https://github.com/custom-cards/button-card) cards for Home Assistant Lovelace dashboards.

* Syntax highlighting provided using built-in Javascript grammar
* "Double quoted" and block YAML strings supported
* Works with the standard YAML language and the `home-assistant` YAML language created by the [Home Assistant Config Helper](https://github.com/keesschollaart81/vscode-home-assistant) plugin.

## Preview

![VSCode BC JS Example](images/vscodebcjs-example.png)
_I made this while I was working on [Creative Button Card Templates](https://github.com/wfurphy/creative-button-card-templates) and could not handle writing any more JS without syntax highlighting. Hopefully it gives someone else the same relief it gave me._

_The preview above is using the OneDark Pro theme. This plugin only provides language grammar and will work with any theme you currently use._
## Preview

## Installation
![VSCode BC JS Example](https://raw.githubusercontent.com/wfurphy/vscode-button-card-js/master/images/vscodebcjs-example.png)

I will eventually publish this on the marketplace. Until then you need to [download the latest release](https://github.com/wfurphy/vscode-home-assistant-button-card-js/releases/latest) as a VSIX file. Then in Visual Studio Code navigate to your Extensions screen. From the three dots at the top right of the Extension browser chose "Install from VSIX...", select the file and follow the prompts. Restart Visual Studio Code. Enjoy.
_The preview above is using the OneDark Pro theme, however this plugin will work with any theme that supports yaml and javascript._
Binary file added images/vscode-bc-js-256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 29 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,42 @@
{
"name": "vscode-home-assistant-button-card-js",
"name": "vscode-button-card-js",
"displayName": "Button Card Javascript Syntax Highlighting in VSCode",
"description": "Syntax highlighting of Javascript code blocks in YAML which are enclosed by triple square brackets (`[[[ ... ]]]`). Used when configuring the advanced _javascript templates_ properties of [Button-Card](https://github.com/custom-cards/button-card) cards for Home Assistant Lovelace dashboards.",
"homepage": "https://github.com/wfurphy/vscode-home-assistant-button-card-js",
"author": "Will Furphy (https://github.com/wfurphy)",
"categories": [
"Programming Languages"
],
"keywords": [
"home assistant",
"button-card",
"javascript",
"triple square brackets",
"syntax"
],
"extensionPack": [
"keesschollaart.vscode-home-assistant"
],
"icon": "images/vscode-bc-js-256.png",
"galleryBanner": {
"color": "#55c1f1",
"theme": "dark"
},
"homepage": "https://github.com/wfurphy/vscode-button-card-js",
"author": {
"name": "Will Furphy",
"url": "https://github.com/wfurphy"
},
"bugs": {
"url": "https://github.com/wfurphy/vscode-button-card-js/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/wfurphy/vscode-home-assistant-button-card-js.git"
"url": "https://github.com/wfurphy/vscode-button-card-js.git"
},
"license": "MIT",
"version": "0.2.0",
"version": "0.2.1",
"engines": {
"vscode": "^1.45.1"
},
"categories": [
"Programming Languages"
],
"contributes": {
"grammars": [
{
Expand Down

0 comments on commit cc4f636

Please sign in to comment.