crystalline
A Language Server Protocol implementation for Crystal providing code diagnostics, autocompletion, and go-to-definition.
What is crystalline?
Crystalline is a Language Server Protocol (LSP) implementation for the Crystal programming language. It provides IDE-like features such as code diagnostics, autocompletion, go-to-definition, and formatting within compatible code editors. It solves the problem of lacking robust language tooling for Crystal developers.
Crystal developers who use editors like VSCode, Vim/Neovim, or Emacs and want enhanced coding assistance like autocompletion and error checking.
Developers choose Crystalline because it is the primary open-source LSP for Crystal, offering essential language features despite the compiler's limitations. It integrates seamlessly with popular editors and is built specifically for the Crystal ecosystem.
Overview
A Language Server Protocol implementation for Crystal. 🔮
Use Cases
Best For
- Adding IDE features to Crystal projects in VSCode
- Enabling go-to-definition and hover info in Vim/Neovim for Crystal
- Integrating Crystal language support in Emacs via LSP
- Performing syntax and semantic checks on Crystal code
- Formatting Crystal source files within an editor
- Navigating large Crystal codebases with document symbols
Not Ideal For
- Projects requiring real-time, low-latency code analysis on large codebases due to slow compilation and caching
- Teams that depend on active community support and frequent feature updates because of passive maintenance
- Developers needing advanced LSP features like rename refactoring or code actions as it's limited to basic diagnostics and navigation
Pros & Cons
Pros
Provides essential tools like syntax checking, formatting, and go-to-definition, specifically designed for Crystal's compiler workflow as outlined in the features section.
Integrates seamlessly with VSCode, Vim/Neovim, and Emacs through standard LSP configurations, detailed in the usage guide for each editor.
Written in Crystal itself, ensuring accurate language semantics and deep integration with the compiler's type inference and limitations.
Offers flexible entry point and project configuration via shard.yml, adapting to monorepos and custom compilation flags, as shown in the setup instructions.
Cons
The maintainer has stated they are not actively developing new features or fixing bugs, which limits long-term reliability and support, as highlighted in the project status.
High memory usage and long compilation times for large projects, admitted in the limitations, can hinder responsiveness and editor integration.
Lacks advanced LSP capabilities like refactoring or incremental parsing, due to the constraints of the Crystal compiler and non-permissive parser.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.