surrealql README

October 5, 2022 · View on GitHub

All Contributors

Features

Syntax higlighting (WIP)

In files with extensions .suql, .srql, .surql, .surealql, .surreal and in TS/JS-Files useing tagged-template-literals with tag suql, srql, surql, surealql, surreal you get syntax highlighting!

Also you can add a comment /* surrealql */ before your template-literal (NOTE: This is a syntax not recomended as formaters / linters could break it!).

For example

const query = surql`
  SELECT * FROM t
`

will have highlighting!

The idea is that libs can define there own handler of that tag. If you are a lib autor of an other langage and there is a similar concept feel free to contact me!

Missing features

  1. idiom - for example messages.* messages.*.createdAt ->is_friend_of->person, ...
  2. some statement pattern can be added
  3. some pattern can be detected that are non valid.
  4. maybe better datetime support
  5. change some naming internaly

Language config

Define comments, brackets, autoClosingPairs, surroundingPairs and folding for surrealql.

Snippets (WIP)

List of usefull snippets (currently a single one). Feel free to create PR / issues to add / request snippets.

Language server (WIP)

Integration with language server! (No support yet as the LSP is not written yet)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Sebastian Krüger
Sebastian Krüger
💻 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!