https://github.com/japhib/pico8-ls

PICO-8 Language Server
https://github.com/japhib/pico8-ls

Last synced: 6 days ago
JSON representation

PICO-8 Language Server

• Host: GitHub
• URL: https://github.com/japhib/pico8-ls
• Owner: japhib
• License: mit
• Created: 2022-01-21T18:27:44.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T02:34:54.000Z (12 days ago)
• Last Synced: 2024-10-27T03:24:42.200Z (12 days ago)
• Language: TypeScript
• Size: 16.5 MB
• Stars: 70
• Watchers: 3
• Forks: 9
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-PICO-8 - pico8-ls - PICO-8 Language Server, providing full language support for the PICO-8 dialect of Lua. (Uncategorized / Uncategorized)

README

        
# PICO-8 Language Server

[![VS Marketplace installs](https://badgen.net/vs-marketplace/i/PollywogGames.pico8-ls?label=VS%20Marketplace%20installs)](https://marketplace.visualstudio.com/items?itemName=PollywogGames.pico8-ls)

[![VS Marketplace downloads](https://badgen.net/vs-marketplace/d/PollywogGames.pico8-ls?label=VS%20Marketplace%20downloads)](https://marketplace.visualstudio.com/items?itemName=PollywogGames.pico8-ls)

Full language support for the [PICO-8](https://www.lexaloffle.com/pico-8.php)

dialect of Lua. 

The goal is to have all the features you'd expect in a full-fledged language

server, such as [the one for Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua),

but specifically tailored for a frictionless PICO-8 experience.

## Feature highlights

View docs on hover, then auto-complete and signature help:

![docs gif](https://github.com/japhib/pico8-ls/blob/master/img/docs.gif?raw=true)

Full support for `#include` statements:

![include gif](https://github.com/japhib/pico8-ls/blob/master/img/includes.gif?raw=true)

## Features

- Syntax highlighting

- Syntax errors

- Warnings on undefined variable usage

- Find symbol in document

- Go to definition

- Find references

- Hover support & signature help for built-in functions

- Auto-completion

- Support for `#include`ing other files

- Snippets for common idioms (functions, loops, etc) as well as pico-8 symbols (`p8-jelpi` -> 🐱, `p8-x-key` -> ❎, etc)

- Code formatting

## Support for other platforms

This extension uses the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/),

so while it's mainly made for VSCode, it could also be used for other editors

such as NeoVim, Atom, etc.

I don't have any experience setting up language extensions for platforms other than VSCode, so currently

looking for help with that. See tips and support thread on the issue for various editors:

- [Neovim](https://github.com/japhib/pico8-ls/issues/34)

- [Sublime Text](https://github.com/japhib/pico8-ls/issues/44)

## Changelog

[Changelog has been moved to a separate file.](https://github.com/japhib/pico8-ls/blob/master/CHANGELOG.md)

## Development

Please follow the official [Language Server Extension Guide](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide)

to understand how to develop VS Code language server extension.

## Credits

PICO-8 Lua parser based on https://github.com/fstirlitz/luaparse (heavily updated & ported to Typescript by @japhib)

[PICO-8](https://www.lexaloffle.com/pico-8.php) by Lexaloffle Games