Usher Linter for VS Code

This extension provides syntax validation and intelligent autocompletion for usher YAML files. It uses a custom JSON schema to ensure your configuration files are correctly structured.

This linter is build on top of https://github.com/redhat-developer/vscode-yaml/blob/main/README.md and requires the extension https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml as dependency in order to add the additional schema for validation.

What is Usher?

Usher is a command-line orchestration tool that allows you to define and execute complex workflows through a single YAML configuration file. It provides a way to coordinate multiple command-line applications, scripts, and tasks with features like parallel execution, error handling, retries, and variable management. Think of it as a task runner that helps "usher containers to production" by streamlining deployment and automation workflows.

Learn more: https://github.com/findmypast/usher

Build & Install the Extension

1. Install VSCE with "npm i -g @vscode/vsce"
2. Compile the code 'npm run compile'
3. Create the extension 'vsce package'
4. Install the vsix file 'usher-linter-0.0.1.vsix' by navigating to the vs code extension tab and clicking the 3 dots menu.
5. Reboot VScode

Running Tests

Run npm test to execute the tests.

Releasing New Version

This repo has GitHub actions configured so you can relay on the .vsix generated as result of a release in order to upload to the Marketplace before it will get automated.

To release new version:

1. Make the changes
2. Run the npm version {patch/minor/major} -m "%s" command
3. After updating the package version, push the changes along with tags: git push origin HEAD --tags
4. Upload via https://marketplace.visualstudio.com/manage/publishers/Findmypast