rumdl 0.0.62__tar.gz → 0.0.63__tar.gz

{rumdl-0.0.62 → rumdl-0.0.63}/Cargo.lock

@@ -1704,7 +1704,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.62"
+version = "0.0.63"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.62 → rumdl-0.0.63}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.62"
+version = "0.0.63"
 edition = "2021"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"
 authors = ["Ruben J. Jongejan <ruben.jongejan@gmail.com>"]

{rumdl-0.0.62 → rumdl-0.0.63}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.62
+Version: 0.0.63
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -71,6 +71,7 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
     - [Configuration Output](#configuration-output)
       - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
       - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
+  - [Editor Integration (LSP)](#editor-integration-lsp)
   - [Output Style](#output-style)
     - [Output Format](#output-format)
   - [Development](#development)
@@ -260,6 +261,11 @@ rumdl <command> [options] [file or directory...]
   - Subcommands:
     - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
 
+- `server`: Start the Language Server Protocol server for editor integration
+  - `--port <PORT>`: TCP port to listen on (for debugging)
+  - `--stdio`: Use stdio for communication (default)
+  - `-v, --verbose`: Enable verbose logging
+
 - `version`: Show version information
 
 ### Usage Examples
@@ -412,6 +418,40 @@ code_blocks = true
 ...
 ```
 
+## Editor Integration (LSP)
+
+rumdl includes a built-in Language Server Protocol (LSP) implementation for real-time markdown linting in your favorite editor. Following [Ruff's approach](https://docs.astral.sh/ruff/editors/), the LSP server is built directly into the main `rumdl` binary.
+
+### Starting the LSP Server
+
+```bash
+# Standard mode (stdio) - default
+rumdl server
+
+# Explicit stdio mode
+rumdl server --stdio
+
+# Debug mode (TCP)
+rumdl server --port 8080 --verbose
+```
+
+### Supported Editors
+
+- **VS Code**: Use the official rumdl extension (coming soon)
+- **Neovim**: Configure with nvim-lspconfig
+- **Emacs**: Use with lsp-mode
+- **Sublime Text**: Use with LSP package
+- **Any LSP-compatible editor**
+
+For detailed setup instructions, see our [LSP Setup Guide](docs/lsp-setup.md).
+
+### LSP Features
+
+- **Real-time diagnostics** - See markdown linting errors as you type
+- **Code actions** - One-click fixes for violations (where available)
+- **Configuration support** - Respects your `.rumdl.toml` configuration
+- **Performance optimized** - Built in Rust with all our performance optimizations
+
 ## Output Style
 
 rumdl produces clean, colorized output similar to modern linting tools:

{rumdl-0.0.62 → rumdl-0.0.63}/README.md

@@ -41,6 +41,7 @@
     - [Configuration Output](#configuration-output)
       - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
       - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
+  - [Editor Integration (LSP)](#editor-integration-lsp)
   - [Output Style](#output-style)
     - [Output Format](#output-format)
   - [Development](#development)
@@ -230,6 +231,11 @@ rumdl <command> [options] [file or directory...]
   - Subcommands:
     - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
 
+- `server`: Start the Language Server Protocol server for editor integration
+  - `--port <PORT>`: TCP port to listen on (for debugging)
+  - `--stdio`: Use stdio for communication (default)
+  - `-v, --verbose`: Enable verbose logging
+
 - `version`: Show version information
 
 ### Usage Examples
@@ -382,6 +388,40 @@ code_blocks = true
 ...
 ```
 
+## Editor Integration (LSP)
+
+rumdl includes a built-in Language Server Protocol (LSP) implementation for real-time markdown linting in your favorite editor. Following [Ruff's approach](https://docs.astral.sh/ruff/editors/), the LSP server is built directly into the main `rumdl` binary.
+
+### Starting the LSP Server
+
+```bash
+# Standard mode (stdio) - default
+rumdl server
+
+# Explicit stdio mode
+rumdl server --stdio
+
+# Debug mode (TCP)
+rumdl server --port 8080 --verbose
+```
+
+### Supported Editors
+
+- **VS Code**: Use the official rumdl extension (coming soon)
+- **Neovim**: Configure with nvim-lspconfig
+- **Emacs**: Use with lsp-mode
+- **Sublime Text**: Use with LSP package
+- **Any LSP-compatible editor**
+
+For detailed setup instructions, see our [LSP Setup Guide](docs/lsp-setup.md).
+
+### LSP Features
+
+- **Real-time diagnostics** - See markdown linting errors as you type
+- **Code actions** - One-click fixes for violations (where available)
+- **Configuration support** - Respects your `.rumdl.toml` configuration
+- **Performance optimized** - Built in Rust with all our performance optimizations
+
 ## Output Style
 
 rumdl produces clean, colorized output similar to modern linting tools:

{rumdl-0.0.62 → rumdl-0.0.63}/src/main.rs

@@ -141,9 +141,12 @@ enum Commands {
     },
     /// Start the Language Server Protocol server
     Server {
-        /// TCP port to listen on (for debugging, default is stdio)
+        /// TCP port to listen on (for debugging)
         #[arg(long)]
         port: Option<u16>,
+        /// Use stdio for communication (default)
+        #[arg(long)]
+        stdio: bool,
         /// Enable verbose logging
         #[arg(short, long)]
         verbose: bool,
@@ -1143,7 +1146,7 @@ build-backend = \"setuptools.build_meta\"
                     }
                 }
             }
-            Some(Commands::Server { port, verbose }) => {
+            Some(Commands::Server { port, stdio, verbose }) => {
                 // Setup logging for the LSP server
                 if *verbose {
                     env_logger::Builder::from_default_env()
@@ -1166,7 +1169,9 @@ build-backend = \"setuptools.build_meta\"
                             std::process::exit(1);
                         }
                     } else {
-                        // Standard LSP mode over stdio
+                        // Standard LSP mode over stdio (default behavior)
+                        // Note: stdio flag is for explicit documentation, behavior is the same
+                        let _ = stdio; // Suppress unused variable warning
                         if let Err(e) = rumdl::lsp::start_server().await {
                             eprintln!("Failed to start LSP server: {}", e);
                             std::process::exit(1);