Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 1.59 KB
Raw

Visual Studio Code is required to use FSharp.SyntaxTest

FSharp.SyntaxTest is a lightweight extension that allows for fast testing of modifications to the syntax definiton files located in /grammars/

Open VSCode at the repository root and use either F5 or > Start Debugging to start the extension host which will open at /sample-code/

Important Notes

  • Only modifications made to the syntax files in /grammars/ will be tracked by Git
  • If you're going to add more src files to /sample-code/ remember to add the files to SampleCode.fsproj
  • You may need to close and restart the extension host before changes to the syntax definitions are accurately displayed
  • Reference the F# Language Spec for detail on the syntax grammar

Grammar format

VSCode language colorization is based on TextMate language specifications, which use the Oniguruma regular expression library by K. Kosako. A reference for Oniguruma is availaible on the TextMate manual.

Roadmap

  • Upgrade FSharp.SyntaxTest with functionality from vscode-textmate npm package for more in-depth information about which tokens are being created
  • Add Syntax Grammar for FsYacc
  • Support XML syntax highlighting in documentation /// comments?
  • Support Markdown syntax highlighting in documentation and block (* *) comments?