Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.22 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.22 KB

VS Code Extension for Torque

The Quali Torque language extension aims to ease the life of the Torque content creators by providing file validations, code completions and more.

Features

Code auto-completion

  • When designing a blueprint, you can get code suggestions based on a document schema. For example, it may help you to figure out what other properties could be added to the document.
  • When designing a grain, under the depends-on field, intellisense can provide you with a list of the available grains names.

completions

Validation

This extension runs a pretty long list of validations, including general YAML schema validations and more complex dynamic checks. Some of them include:

  • Validate that grains or inputs mentioned in expressions are defined
  • Validate that expressions are being used in the allowed places only
  • Grains depends-on validations

And more validations coming soon...

Document Links

Coming soon...

Interactive features

Coming soon...

Getting Started

NOTE: This extension works with Torque's spec_version=2. The version 1 has been deprecated. If you are still interested in working with spec 1, the latest stable version of this extension available on the Marketplace is 0.0.12

Prerequisite:

  • python>=3.6 installed on your system.
  • git installed on your system
  • Install the extension from the Marketplace.
  • VS Code may require you to reload it. Make sure you do that.
  • If VS Code can't find the python you have installed, you will need to provide its path in the popup that appears. For different opeation systems python path could be the following:
    • for windows: C:\Users\MyUser\AppData\Local\Programs\Python\Python38\Scripts\python.exe
    • for linux: /usr/local/bin/python3.8
    • for macos: /Library/Frameworks/Python.framework/Versions/3.8/bin/python3.8
  • Open any folder with a Torque blueprint repository and get an enhanced experience working on your Torque files!

The extension will be activated automatically when loading Torque's blueprint located in a blueprint repository folder, or when opening the Torque view in the activity bar.