From 888edfbb9bfc1b1e4e6db19197c31798c65bc63a Mon Sep 17 00:00:00 2001 From: Tom Harrington Date: Tue, 22 Jan 2019 20:44:31 -0700 Subject: [PATCH] Add template syntax highlighting for Visual Studio Code --- resources/README.md | 0 .../.vscode/launch.json | 18 +++++ .../mogenerator-template-vscode/.vscodeignore | 4 ++ .../mogenerator-template-vscode/CHANGELOG.md | 7 ++ .../mogenerator-template-vscode/README.md | 65 +++++++++++++++++++ .../language-configuration.json | 31 +++++++++ .../mogenerator-template-vscode/package.json | 26 ++++++++ .../mogenerator-template.tmLanguage.json | 47 ++++++++++++++ .../vsc-extension-quickstart.md | 27 ++++++++ 9 files changed, 225 insertions(+) create mode 100644 resources/README.md create mode 100644 resources/mogenerator-template-vscode/.vscode/launch.json create mode 100644 resources/mogenerator-template-vscode/.vscodeignore create mode 100644 resources/mogenerator-template-vscode/CHANGELOG.md create mode 100644 resources/mogenerator-template-vscode/README.md create mode 100644 resources/mogenerator-template-vscode/language-configuration.json create mode 100644 resources/mogenerator-template-vscode/package.json create mode 100644 resources/mogenerator-template-vscode/syntaxes/mogenerator-template.tmLanguage.json create mode 100644 resources/mogenerator-template-vscode/vsc-extension-quickstart.md diff --git a/resources/README.md b/resources/README.md new file mode 100644 index 00000000..e69de29b diff --git a/resources/mogenerator-template-vscode/.vscode/launch.json b/resources/mogenerator-template-vscode/.vscode/launch.json new file mode 100644 index 00000000..7bc18a44 --- /dev/null +++ b/resources/mogenerator-template-vscode/.vscode/launch.json @@ -0,0 +1,18 @@ +// A launch configuration that launches the extension inside a new window +// Use IntelliSense to learn about possible attributes. +// Hover to view descriptions of existing attributes. +// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 +{ + "version": "0.2.0", + "configurations": [ + { + "name": "Extension", + "type": "extensionHost", + "request": "launch", + "runtimeExecutable": "${execPath}", + "args": [ + "--extensionDevelopmentPath=${workspaceFolder}" + ] + } + ] +} \ No newline at end of file diff --git a/resources/mogenerator-template-vscode/.vscodeignore b/resources/mogenerator-template-vscode/.vscodeignore new file mode 100644 index 00000000..f369b5e5 --- /dev/null +++ b/resources/mogenerator-template-vscode/.vscodeignore @@ -0,0 +1,4 @@ +.vscode/** +.vscode-test/** +.gitignore +vsc-extension-quickstart.md diff --git a/resources/mogenerator-template-vscode/CHANGELOG.md b/resources/mogenerator-template-vscode/CHANGELOG.md new file mode 100644 index 00000000..060fe591 --- /dev/null +++ b/resources/mogenerator-template-vscode/CHANGELOG.md @@ -0,0 +1,7 @@ +# Change Log +All notable changes to the "mogenerator-template" 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/resources/mogenerator-template-vscode/README.md b/resources/mogenerator-template-vscode/README.md new file mode 100644 index 00000000..596ba727 --- /dev/null +++ b/resources/mogenerator-template-vscode/README.md @@ -0,0 +1,65 @@ +# mogenerator-template README + +This is the README for your extension "mogenerator-template". 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/resources/mogenerator-template-vscode/language-configuration.json b/resources/mogenerator-template-vscode/language-configuration.json new file mode 100644 index 00000000..e132f855 --- /dev/null +++ b/resources/mogenerator-template-vscode/language-configuration.json @@ -0,0 +1,31 @@ +{ + "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": [ "<$comment", "$>" ] + }, + // symbols used as brackets + "brackets": [ + ["{", "}"], + ["[", "]"], + ["(", ")"] + //["<\\$", "\\$>"] + ], + // symbols that are auto closed when typing + "autoClosingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ], + // symbols that that can be used to surround a selection + "surroundingPairs": [ + ["{", "}"], + ["[", "]"], + ["(", ")"], + ["\"", "\""], + ["'", "'"] + ] +} \ No newline at end of file diff --git a/resources/mogenerator-template-vscode/package.json b/resources/mogenerator-template-vscode/package.json new file mode 100644 index 00000000..9a3d93f2 --- /dev/null +++ b/resources/mogenerator-template-vscode/package.json @@ -0,0 +1,26 @@ +{ + "name": "mogenerator-template", + "displayName": "Mogenerator template", + "description": "Syntax highlighting for mogenerator template files", + "version": "0.0.1", + "engines": { + "vscode": "^1.30.0" + }, + "categories": [ + "Programming Languages" + ], + "homepage": "https://github.com/rentzsch/mogenerator", + "contributes": { + "languages": [{ + "id": "mogenerator-template", + "aliases": ["Mogenerator template", "mogenerator-template"], + "extensions": [".motemplate"], + "configuration": "./language-configuration.json" + }], + "grammars": [{ + "language": "mogenerator-template", + "scopeName": "source.motemplate", + "path": "./syntaxes/mogenerator-template.tmLanguage.json" + }] + } +} \ No newline at end of file diff --git a/resources/mogenerator-template-vscode/syntaxes/mogenerator-template.tmLanguage.json b/resources/mogenerator-template-vscode/syntaxes/mogenerator-template.tmLanguage.json new file mode 100644 index 00000000..b662d897 --- /dev/null +++ b/resources/mogenerator-template-vscode/syntaxes/mogenerator-template.tmLanguage.json @@ -0,0 +1,47 @@ +{ + "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json", + "name": "Mogenerator template", + "patterns": [ + { + "include": "#comment" + }, + { + "include": "#keywords" + } + ], + "repository": { + "keywords": { + "name": "keyword.other.mogenerator-template", + "begin": "<\\$\\s*", + "end": "\\$>", + "patterns": [{ + "name": "keyword.control.mogenerator-template", + "match": "(if|else|elseif|endif|foreach|endforeach|break|continue|date)" + }] + }, + "strings": { + "name": "string.quoted.double.mogenerator-template", + "begin": "\"", + "end": "\"", + "patterns": [ + { + "name": "constant.character.escape.mogenerator-template", + "match": "\\\\." + } + ] + }, + "comment": { + "name": "comment.block.motemplate", + "begin": "<\\$comment", + "end": "\\$>", + "patterns": [ + { + "name": "constant.character.escape.mogenerator-template", + "match": "\\\\." + } + ], + "contentName": "constant.character.escape.mogenerator-template" + } + }, + "scopeName": "source.motemplate" +} \ No newline at end of file diff --git a/resources/mogenerator-template-vscode/vsc-extension-quickstart.md b/resources/mogenerator-template-vscode/vsc-extension-quickstart.md new file mode 100644 index 00000000..bc422363 --- /dev/null +++ b/resources/mogenerator-template-vscode/vsc-extension-quickstart.md @@ -0,0 +1,27 @@ +# 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/mogenerator-template.tmLanguage.json` - 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 `/.vscode/extensions` folder and restart Code. +* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.