Skip to content

VSCode extension providing JSON Schema support for serverless workflow specification

Notifications You must be signed in to change notification settings

serverless-workflow/workflow-schema-vscode

Repository files navigation

Serverless Workflow - VSC Extension

JSON Schema support for the CNCF Serverless Workflow Specification

Features

Code Hints

This extension provides Code Hints for JSON files in your project against the Serverless Workflow specification JSON Schema. This includes:

  • Prompting correct attribute names as you type.
  • Displaying of mismatched types or missing required properties
  • Allows use of Ctrl+Space to show available properties
  • Code completion even for enum types

Code Snippets

This extension also provides Code Snippets for the serverless workflow specification markup:

  • swn: Create a new workflow definition
  • adding more in next version

Building from source

If you do not want to get this extension from the Marketplace or would like to build and test the latest changes/updates locally follow these steps:

  1. Clone the extension git repository
git clone https://github.com/serverless-workflow/workflow-schema-vscode.git
cd workflow-schema-vscode
  1. Build and package the extension with vsce:
vsce package

To install vsce run:

npm install -g vsce
  1. vsce will create a workflow-schema-vscode-$VERSION$.vsix file which you have to install to your ide, for this run:
code --install-extension workflow-schema-vscode-$VERSION$.vsix

to uninstall the extension run:

code --uninstall-extension workflow-schema-vscode-$VERSION$.vsix

Contributing

This extension is open-source and free to use to anyone. All/any contributions are very welcome and much needed in order to make this extension much better. Best way to contribute is to create Pull Request(s) on the github project.

About

VSCode extension providing JSON Schema support for serverless workflow specification

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published