Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/teal-language/vscode-teal

Teal language support for Visual Studio Code
https://github.com/teal-language/vscode-teal

language-server snippets syntax-highlighting teal vscode

Last synced: 9 days ago
JSON representation

Teal language support for Visual Studio Code

Awesome Lists containing this project

README

        

# Teal for Visual Studio Code [![Build Status](https://img.shields.io/github/actions/workflow/status/teal-language/vscode-teal/nodejs.yml?branch=master)](https://github.com/teal-language/vscode-teal/actions/workflows/nodejs.yml)

Provides IntelliSense and syntax highlighting for [Teal](https://github.com/teal-language/tl) in Visual Studio Code.

## Requirements

Make sure that the Teal compiler (v0.12.0 or later) is available in your PATH:
```
luarocks install tl
```

## Installing

Download this extension from the [VS Code Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=pdesaulniers.vscode-teal) or the [Open VSX Registry](https://open-vsx.org/extension/pdesaulniers/vscode-teal).

## Snippets

Trigger | Name | Body
--- | --- | ---
req | Local require | local name = require("module")
loc | Local variable | local name = value
fori | ipairs loop | for k, v in ipairs(sequence) do ... end
forp | pairs loop | for k, v in pairs(table) do ... end
lrec | Local record definition | local record name ... end
grec | Global record definition | global record name ... end
lenu | Local enum definition | local enum name ... end
genu | Global enum definition | global enum name ... end

## FAQ

### 'Module not found' errors

By default, this extension runs `tl check` at the root of the workspace.

If your code resides in subdirectories (such as `src/` or `lib/`), you need to add the directories to `tlconfig.lua` at the root of the workspace:
```lua
return {
include_dir = {
"src/",
"lib/"
}
}
```

### [Error] messages at the bottom right of the screen

Make sure you are using the latest version of the `tl` compiler. If upgrading `tl` does not fix the problem, then please [create an issue](https://github.com/teal-language/vscode-teal/issues/new).

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for release notes.

## Contributors

Contributions are greatly appreciated! Feel free to fork [this repository](https://github.com/teal-language/vscode-teal) and open a pull request on GitHub.