README.en.md

Scuttle - A Structurizr LSP & more

👀 ¡Pilas!

Pa' leer esto en español, haga clic aquí.

  █████████                       █████     █████    ████
 ███░░░░░███                     ░░███     ░░███    ░░███
░███    ░░░   ██████  █████ ████ ███████   ███████   ░███   ██████
░░█████████  ███░░███░░███ ░███ ░░░███░   ░░░███░    ░███  ███░░███
 ░░░░░░░░███░███ ░░░  ░███ ░███   ░███      ░███     ░███ ░███████
 ███    ░███░███  ███ ░███ ░███   ░███ ███  ░███ ███ ░███ ░███░░░
░░█████████ ░░██████  ░░████████  ░░█████   ░░█████  █████░░██████
 ░░░░░░░░░   ░░░░░░    ░░░░░░░░    ░░░░░     ░░░░░  ░░░░░  ░░░░░░
                                                              _
 __,      ,   -/- ,_        __  -/-      ,_   .      ,_      //  ,   ,_
(_/(_   _/_)__/__/ (__(_/__(_,__/__(_/__/ (__/__/)__/ (_   _(/__/_)__/_)_
                                                 _/_                /
                                                (/                 /
 __,   ,__,   __/      ,____,   _,_ ,_   _
(_/(__/ / (__(_/(_   _/ / / (__(_/_/ (__(/_ ...

Scuttle is a batteries-included Structurizr DSL LSP server implementation along with a Tree-sitter definitions that closely follow the Structurizr DSL specification. The main goal of this project is to have the best development environment for authoring and maintaining Structurizr DSL files.

This project is a monorepo housing all the necessary code for a development environment for developing diagrams and documentation with Structurizr DSL.

Install the LSP

📝 Note

More to come soon...

Running the LSP within Visual Studio Code (VSCode)

Running the LSP within Neovim

Running as the LSP in your terminal with the stand-alone binary

Install the Tree-sitter grammar

📝 Note

More to come soon...

Running the grammar within Visual Studio Code (VSCode)

Running the grammar within Neovim

Documentation

The documentation for this project uses Structurizr Lite for the development and maintenance of the documentation of this project. The automation using Just and the files inside of the docs/ directory can be used to stand-up your own documentation using Structurizr Lite.

Contributing

📝 Note

More to come soon...