Repository files navigation

This project establishes the central development and maintenance of syntax definitionfiles for the PowerShell language used by editors that leverage the XML version of theTextMate language grammar format.

Currently this syntax definition is used in the following editors and extensions:

• Visual Studio Code by Microsoft
• PowerShell Package for Sublime Text byGuillermo López-Anglada
• language-powershell for Atom byJames Sconfitto

In the future we may find a more common syntax that allows us to generate syntaxdefinitions for editors that don't leverage the TextMate format.

We are starting with the current state of the TextMate grammar that is being used inboth VS Code and Sublime Text. There are a number of existing issues with the grammarthat we need to track down and fix. Please seeissue #1for more details.

• Node.JS, >= 8.9.1
• Atom text editor (tests)

1. Runbuild.ps1 to generate the grammar.

   PS> .\build.ps1

2. The .json file will be generated in./grammars/ at the root of the project.

Requires the Atom text editor be installed.

1. Run.\build.ps1 with-Test. Which will build the grammar file and run all of the specs.

   PS> .\build.ps1 -Test

1. Usenpm to install dependencies:

   npm install

2. Run thebuild-grammar script to generate the json file.

   npm run build-grammar

3. The .json file will be generated in./grammars/ at the root of the project.

1. Build the grammar file using the above steps.

2. Use the Atom cli command for your os (atom.cmd or atom.sh) to run the tests from the root of the EditorSystax project folder.

   atom --test spec

We would love to have community contributions to this project to make PowerShell syntaxhighlighting great in as many editors as we can. Please feel free to file issues orsend pull requests if you'd like to contribute.

• Andy Jordan
• Nick James

This extension islicensed under the MIT License. Please see thethird-party notices file for details on the originalsource of the TextMate definition that we use.

Please see ourCode of Conduct before participating in this project.

For any security issues, please see ourSecurity Policy.