diff options
author | Kartik Agaram <vc@akkartik.com> | 2021-11-09 06:35:53 -0800 |
---|---|---|
committer | Kartik Agaram <vc@akkartik.com> | 2021-11-09 06:35:53 -0800 |
commit | 8eae94e8609cab18342bbf44f6cd0f2b03dc9e1b (patch) | |
tree | 10936c5e8d4ce6211198a139e2bb5d37e7cacb63 | |
parent | 2bac01fb7b4e43a2f7e707b7848d1b925d598cda (diff) | |
download | mu-8eae94e8609cab18342bbf44f6cd0f2b03dc9e1b.tar.gz |
clean up VSCode extension
-rw-r--r-- | editor/VSCode/CHANGELOG.md | 9 | ||||
-rw-r--r-- | editor/VSCode/README.md | 65 | ||||
-rw-r--r-- | editor/VSCode/language-configuration.json | 24 | ||||
-rw-r--r-- | editor/VSCode/vsc-extension-quickstart.md | 29 |
4 files changed, 2 insertions, 125 deletions
diff --git a/editor/VSCode/CHANGELOG.md b/editor/VSCode/CHANGELOG.md deleted file mode 100644 index 5b37189b..00000000 --- a/editor/VSCode/CHANGELOG.md +++ /dev/null @@ -1,9 +0,0 @@ -# Change Log - -All notable changes to the "mu" extension will be documented in this file. - -Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. - -## [Unreleased] - -- Initial release \ No newline at end of file diff --git a/editor/VSCode/README.md b/editor/VSCode/README.md deleted file mode 100644 index 3230356e..00000000 --- a/editor/VSCode/README.md +++ /dev/null @@ -1,65 +0,0 @@ -# mu README - -This is the README for your extension "mu". After writing up a brief description, we recommend including the following sections. - -## 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. - -## Requirements - -If you have any requirements or dependencies, add a section describing those and how to install and configure them. - -## 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 - -## Known Issues - -Calling out known issues can help limit users opening duplicate issues against your extension. - -## 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/) - -**Enjoy!** diff --git a/editor/VSCode/language-configuration.json b/editor/VSCode/language-configuration.json index 8f162a0c..d38cd8e5 100644 --- a/editor/VSCode/language-configuration.json +++ b/editor/VSCode/language-configuration.json @@ -1,30 +1,10 @@ { "comments": { - // symbol used for single line comment. Remove this entry if your language does not support line comments - "lineComment": "//", - // symbols used for start and end a block comment. Remove this entry if your language does not support block comments - "blockComment": [ "/*", "*/" ] + "lineComment": "#" }, - // symbols used as brackets "brackets": [ ["{", "}"], ["[", "]"], ["(", ")"] - ], - // symbols that are auto closed when typing - "autoClosingPairs": [ - ["{", "}"], - ["[", "]"], - ["(", ")"], - ["\"", "\""], - ["'", "'"] - ], - // symbols that can be used to surround a selection - "surroundingPairs": [ - ["{", "}"], - ["[", "]"], - ["(", ")"], - ["\"", "\""], - ["'", "'"] ] -} \ No newline at end of file +} diff --git a/editor/VSCode/vsc-extension-quickstart.md b/editor/VSCode/vsc-extension-quickstart.md deleted file mode 100644 index 856221dc..00000000 --- a/editor/VSCode/vsc-extension-quickstart.md +++ /dev/null @@ -1,29 +0,0 @@ -# Welcome to your VS Code Extension - -## What's in the folder - -* This folder contains all of the files necessary for your extension. -* `package.json` - this is the manifest file in which you declare your language support and define the location of the grammar file that has been copied into your extension. -* `syntaxes/Mu.tmLanguage` - this is the Text mate grammar file that is used for tokenization. -* `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets. - -## Get up and running straight away - -* Make sure the language configuration settings in `language-configuration.json` are accurate. -* Press `F5` to open a new window with your extension loaded. -* Create a new file with a file name suffix matching your language. -* Verify that syntax highlighting works and that the language configuration settings are working. - -## Make changes - -* You can relaunch the extension from the debug toolbar after making changes to the files listed above. -* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes. - -## Add more language features - -* To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs - -## Install your extension - -* To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code. -* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension. |