chore: docs

Author: psteinroe

README.md

@@ -26,6 +26,7 @@ The following features are implemented:
 - Syntax Error Highlighting
 - Type-checking (via `EXPLAIN` error insights)
 - Linter, inspired by [Squawk](https://squawkhq.com)
+- Formatting
 
 Our current focus is on refining and enhancing these core features while building a robust and easily accessible infrastructure. For future plans and opportunities to contribute, please check out the issues and discussions. Any contributions are welcome!
 

docs/configuration.md

@@ -22,6 +22,10 @@ A configuration file is usually placed in your project’s root folder. It is or
   },
   "plpgsqlCheck": {
     "enabled": true
+  },
+  "format": {
+    "enabled": true,
+    "keywordCase": "lower"
   }
 }
 ```

docs/features/formatting.md

@@ -0,0 +1,93 @@
+# Formatting
+
+> **Preview Feature**: The formatter is currently in preview. We'd love feedback from early adopters! Please report any issues or unexpected output at [GitHub Issues](https://github.com/supabase-community/postgres-language-server/issues).
+
+The language server provides SQL formatting that produces consistent, readable code. Built on Postgres' own parser, the formatter ensures 100% syntax compatibility with your SQL.
+
+## Configuration
+
+Configure formatting behavior in your `postgres-language-server.jsonc`:
+
+```json
+{
+  "format": {
+    "enabled": true,
+    "lineWidth": 100,
+    "indentSize": 2,
+    "indentStyle": "spaces",
+    "keywordCase": "lower",
+    "constantCase": "lower",
+    "typeCase": "lower"
+  }
+}
+```
+
+### Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `enabled` | `true` | Enable or disable the formatter |
+| `lineWidth` | `100` | Maximum line width before breaking |
+| `indentSize` | `2` | Number of spaces (or tab width) for indentation |
+| `indentStyle` | `"spaces"` | Use `"spaces"` or `"tabs"` for indentation |
+| `keywordCase` | `"lower"` | Casing for SQL keywords: `"upper"` or `"lower"` |
+| `constantCase` | `"lower"` | Casing for constants (NULL, TRUE, FALSE): `"upper"` or `"lower"` |
+| `typeCase` | `"lower"` | Casing for data types (text, int, varchar): `"upper"` or `"lower"` |
+
+### Example Output
+
+With default settings (lowercase):
+
+```sql
+create table users (
+  id serial primary key,
+  name text not null,
+  active boolean default true
+);
+
+select * from users where active = true;
+```
+
+With uppercase keywords and constants:
+
+```sql
+CREATE TABLE users (
+  id serial PRIMARY KEY,
+  name text NOT NULL,
+  active boolean DEFAULT TRUE
+);
+
+SELECT * FROM users WHERE active = TRUE;
+```
+
+## CLI Usage
+
+Format files using the CLI:
+
+```bash
+# Format and show diff
+postgres-language-server format file.sql
+
+# Format and write changes
+postgres-language-server format file.sql --write
+
+# Format entire directory
+postgres-language-server format migrations/ --write
+```
+
+## Editor Integration
+
+The formatter integrates with your editor via the Language Server Protocol. Use your editor's format document command (typically bound to a keyboard shortcut) to format SQL files.
+
+## Ignoring Files
+
+Use the `ignore` and `include` options to control which files are formatted:
+
+```json
+{
+  "format": {
+    "ignore": ["**/generated/**", "**/vendor/**"],
+    "include": ["**/*.sql"]
+  }
+}
+```

docs/index.md

@@ -17,6 +17,7 @@ The following features are available today:
 - [Syntax Diagnostics](features/syntax_diagnostics.md)
 - [Linting](features/linting.md)
 - [Type Checking](features/type_checking.md)
+- [Formatting](features/formatting.md) (Preview)
 - [PL/pgSQL Support](features/plpgsql.md)
 - [Autocompletion & Hover](features/editor_features.md)
 

mkdocs.yml

@@ -21,6 +21,7 @@ nav:
       - Linting: features/linting.md
       - Database Linting: features/database_linting.md
       - Type Checking: features/type_checking.md
+      - Formatting: features/formatting.md
       - PL/pgSQL Support: features/plpgsql.md
       - Autocompletion & Hover: features/editor_features.md
   - Guides: