Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.97 KB
Raw

Contributing

Developing

First Run

  1. npm install - Install all dependencies
  2. Launch Extension configuration (hit F5)

Inner Loop

  1. Make edits to syntaxes/kusto.tmLanguage.yml
  2. Verify changes are valid by running npm run convert. This will convert the kusto.tmLanguage.yml into a JSON file. You can also:
    • Run the "Convert yaml theme to json" task. This just runs the convert script.
    • Launch the Extension configuration (hit F5). This runs the "Convert yaml theme to json" task.

Relevant Documentation/Useful Links

Testing

Isolated testing of the grammar is available with snapshot tests, via PanAeon/vscode-tmgrammar-test. Read more here.

  • Run snapshot tests: npm run test.
  • Update snapshots: npm run test:update-snapshots

Manually-taken visual snapshots of how the syntax highlighting looks with certain themes are in test/snapshots/**/theme-screenshots. Filenames indicate the test file and theme used.

  • [Kuskus] Kusto (Dark)
  • Monokai
  • Dark+ (default dark)
  • Light+ (default light)
  • Base16 Default Dark

Please update the visual snapshots when making tmLanguage changes. To take new snapshots, run the "All (Extension Pack)" target (see root launch.json), enable a particular Theme, and use the CodeSnap extension to take the screenshot.