Hajime is a vscode extension for edting .sumo Sumo Logic query files
The extension provides following features:
- syntax highlighting: configured in syntaxes/sumo.tmLanguage.json
- intellisense to prompt for sumo operators, meta and keywords: src/extension.ts
- auto complete snippets: snippets.json
For info on setup see: https://code.visualstudio.com/api/get-started/your-first-extension
There is also a useful library of examples here: https://github.com/microsoft/vscode-extension-samples
To run the extension in a debug window use F5 - this opens a new window to test the extension.
then either:
- open a .sumo file
- create a new file and set type to sumo
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
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 extensionmyExtension.thing
: set toblah
to do something
Calling out known issues can help limit users opening duplicate issues against your extension.
Users appreciate release notes as you update your extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
Note: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\
on macOS orCtrl+\
on Windows and Linux) - Toggle preview (
Shift+CMD+V
on macOS orShift+Ctrl+V
on Windows and Linux) - Press
Ctrl+Space
(Windows, Linux) orCmd+Space
(macOS) to see a list of Markdown snippets
Enjoy!