Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions apps/framework-docs-v2/content/moosestack/language-server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Language Server (LSP)
description: IDE intelligence for ClickHouse SQL in Moose TypeScript projects
order: 5
---

import { Callout } from "@/components/mdx";

# Language Server for Moose Development

The MooseStack Language Server provides real-time ClickHouse SQL intelligence for `sql` tagged template literals in TypeScript Moose projects. It gives you syntax validation, auto-completions, hover documentation, and code formatting as you write SQL in your editor.

<Callout type="warning">
Experimental: TypeScript only.
</Callout>

## Features

- **Error diagnostics** - Instant feedback on SQL syntax errors
- **Auto-complete** - ClickHouse functions, keywords, data types, table engines, and more
- **Hover documentation** - Syntax help and examples for ClickHouse functions
- **Code actions** - Format SQL directly from your editor

### Error Diagnostics

![Error diagnostics for SQL syntax errors](/lsp-error-diagnostics.png)

### Auto-complete

![Autocomplete suggestions for ClickHouse functions](/lsp-autocomplete.png)

### Hover Documentation

![Hover documentation for ClickHouse functions](/lsp-hover-docs.png)

## Installation

For VS Code and Cursor, search for "MooseStack LSP" in the Extensions panel and click Install.

For other installation methods visit the [GitHub repo](https://github.com/514-labs/moosestack-lsp).

## Learn More

For setup instructions for other editors, configuration options, and troubleshooting, see the [MooseStack LSP repository](https://github.com/514-labs/moosestack-lsp).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/framework-docs-v2/public/lsp-hover-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions apps/framework-docs-v2/src/config/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,13 @@ const moosestackNavigationConfig: NavigationConfig = [
icon: IconStars,
languages: ["typescript", "python"],
},
{
type: "page",
slug: "moosestack/language-server",
title: "Language Server",
icon: IconFileCode,
languages: ["typescript"],
},
{
type: "page",
slug: "moosestack/data-modeling",
Expand Down
Loading