Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 2.21 KB

vsc-extension-quickstart.md

File metadata and controls

68 lines (47 loc) · 2.21 KB

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/gem5-slicc.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.

  • json -> yaml

npx js-yaml syntaxes/gem5-slicc.tmLanguage.json > syntaxes/gem5-slicc.tmLanguage.yaml
  • yaml -> json
npx js-yaml syntaxes/gem5-slicc.tmLanguage.yaml > syntaxes/gem5-slicc.tmLanguage.json

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.

Build the extension

npm install
npm run compile

Generate Packge

Installation Make sure you have Node.js installed. Then run:

npm install -g @vscode/vsce

Usage You can use vsce to easily package and publish your extensions:

vsce package

# output -> myExtension.vsix generated

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

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.