diff --git a/vscode-extension/README.md b/vscode-extension/README.md index ca91b26d..0fde7017 100644 --- a/vscode-extension/README.md +++ b/vscode-extension/README.md @@ -1,65 +1,28 @@ -# numbat README +# Numbat README -This is the README for your extension "numbat". After writing up a brief description, we recommend including the following sections. +The Numbat extension provides language support for the [Numbat](https://github.com/sharkdp/numbat) programming language. ## Features -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. - -For example if there is an image subfolder under your extension project workspace: - -\!\[feature X\]\(images/feature-x.png\) - -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. +- Syntax highlighting +- Code block folding +- comment toggling +- autosurounding brackets ## Requirements -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +_TO BE DONE_ ## Extension Settings -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. - -For example: - -This extension contributes the following settings: - -* `myExtension.enable`: enable/disable this extension -* `myExtension.thing`: set to `blah` to do something +_None_ ## Known Issues -Calling out known issues can help limit users opening duplicate issues against your extension. +_None so far_ ## Release Notes -Users appreciate release notes as you update your extension. - -### 1.0.0 - -Initial release of ... - -### 1.0.1 - -Fixed issue #. - -### 1.1.0 - -Added features X, Y, and Z. - ------------------------------------------------------------------------------------------------------------ - -## Working with Markdown - -**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: - -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets - -### For more information - -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) +### 0.1.0 -**Enjoy!** +Initial release of the Numbat extension! diff --git a/vscode-extension/assets/numbat-256x256.png b/vscode-extension/assets/numbat-256x256.png new file mode 100644 index 00000000..61798681 Binary files /dev/null and b/vscode-extension/assets/numbat-256x256.png differ diff --git a/vscode-extension/assets/numbat-64x64.png b/vscode-extension/assets/numbat-64x64.png new file mode 100644 index 00000000..a8ea35c4 Binary files /dev/null and b/vscode-extension/assets/numbat-64x64.png differ diff --git a/vscode-extension/language-configuration.json b/vscode-extension/language-configuration.json index 2b4ce63a..6607c4de 100644 --- a/vscode-extension/language-configuration.json +++ b/vscode-extension/language-configuration.json @@ -15,10 +15,12 @@ ["(", ")"], ["<", ">"], ["[", "]"], + ["\"", "\""], ], // symbols that can be used to surround a selection "surroundingPairs": [ ["(", ")"], + ["\"", "\""], ], "folding": { "offSide": true // This is not strictly true, but we encourage a coding style where blocks are somewhat based on indentation diff --git a/vscode-extension/package.json b/vscode-extension/package.json index 670710a8..98a4f3b7 100644 --- a/vscode-extension/package.json +++ b/vscode-extension/package.json @@ -2,24 +2,50 @@ "name": "numbat", "displayName": "Numbat", "description": "Syntax highlighting for the Numbat programming language", - "version": "0.0.1", + "version": "0.1.0", + "license": "(MIT OR Apache-2.0)", + "icon": "./assets/numbat-256x256.png", "engines": { "vscode": "^1.71.0" }, "categories": [ "Programming Languages" ], + "keywords": [ + "language", + "physics", + "units", + "calculation" + ], "contributes": { "languages": [{ "id": "numbat", "aliases": ["Numbat", "numbat"], "extensions": [".nbt"], - "configuration": "./language-configuration.json" + "configuration": "./language-configuration.json", + "icon": { + "light": "./assets/numbat-64x64.png", + "dark": "./assets/numbat-64x64.png" + } }], "grammars": [{ "language": "numbat", "scopeName": "source.numbat", "path": "./syntaxes/numbat.tmLanguage.json" }] - } + }, + "scripts": { + "vscode:package": "vsce package" + }, + "devDependencies": { + "@vscode/vsce": "3.2.1" + }, + "vsce": { + "skipLicense": true + }, + "repository": { + "type": "git", + "url": "https://github.com/sharkdp/numbat.git" + }, + "homepage": "https://github.com/sharkdp/numbat/blob/master/vscode-extension/README.md" } diff --git a/vscode-extension/syntaxes/numbat.tmLanguage.json b/vscode-extension/syntaxes/numbat.tmLanguage.json index f0915269..79032222 100644 --- a/vscode-extension/syntaxes/numbat.tmLanguage.json +++ b/vscode-extension/syntaxes/numbat.tmLanguage.json @@ -86,7 +86,20 @@ }, "strings": { "name": "string.quoted.double", - "match": "((?<=})|\")((?!(?