rumdl 0.0.86__py3-none-manylinux_2_39_x86_64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of rumdl might be problematic. Click here for more details.

@@ -0,0 +1,5 @@
1
+ """
2
+ rumdl: An extremely fast Markdown linter written in Rust.
3
+ """
4
+
5
+ __version__ = "0.0.12"
@@ -0,0 +1,57 @@
1
+ """
2
+ Command-line interface for rumdl.
3
+ """
4
+
5
+ from __future__ import annotations
6
+
7
+ import os
8
+ import sys
9
+ import subprocess
10
+ from pathlib import Path
11
+
12
+ def find_native_binary() -> str:
13
+ """Find the native Rust binary, not the Python entry point script."""
14
+ # In development mode, use the target directory binary
15
+ project_root = Path(__file__).resolve().parent.parent.parent
16
+ target_binary = project_root / "target" / "release" / "rumdl"
17
+ if target_binary.exists() and not target_binary.is_dir():
18
+ return str(target_binary)
19
+
20
+ # For Windows, check for .exe extension
21
+ if sys.platform == "win32":
22
+ target_binary = project_root / "target" / "release" / "rumdl.exe"
23
+ if target_binary.exists() and not target_binary.is_dir():
24
+ return str(target_binary)
25
+
26
+ # If we can't find the binary, raise an error
27
+ raise FileNotFoundError(
28
+ "Could not find the native rumdl binary. "
29
+ "Please ensure it was built with 'cargo build --release'."
30
+ )
31
+
32
+ def main() -> int:
33
+ """Run the rumdl command line tool."""
34
+ try:
35
+ # Find the native binary
36
+ native_binary = find_native_binary()
37
+
38
+ # Simply forward all arguments to the Rust binary
39
+ args = [native_binary] + sys.argv[1:]
40
+
41
+ # Run the binary
42
+ if sys.platform == "win32":
43
+ completed_process = subprocess.run(args)
44
+ return completed_process.returncode
45
+ else:
46
+ # On Unix-like systems, directly execute the binary for better signal handling
47
+ os.execv(native_binary, args)
48
+ return 0 # This line will never be reached on non-Windows platforms
49
+ except FileNotFoundError as e:
50
+ print(f"Error: {e}", file=sys.stderr)
51
+ return 1
52
+ except Exception as e:
53
+ print(f"Error: {e}", file=sys.stderr)
54
+ return 1
55
+
56
+ if __name__ == "__main__":
57
+ sys.exit(main())
python/rumdl/py.typed ADDED
@@ -0,0 +1 @@
1
+
Binary file
@@ -0,0 +1,665 @@
1
+ Metadata-Version: 2.4
2
+ Name: rumdl
3
+ Version: 0.0.86
4
+ Classifier: Development Status :: 4 - Beta
5
+ Classifier: Environment :: Console
6
+ Classifier: Intended Audience :: Developers
7
+ Classifier: License :: OSI Approved :: MIT License
8
+ Classifier: Operating System :: OS Independent
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Programming Language :: Python :: 3.7
11
+ Classifier: Programming Language :: Python :: 3.8
12
+ Classifier: Programming Language :: Python :: 3.9
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Rust
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Classifier: Topic :: Software Development :: Quality Assurance
19
+ Classifier: Topic :: Text Processing :: Markup :: Markdown
20
+ Summary: A fast Markdown linter written in Rust
21
+ Keywords: markdown,linter,markdown-linter,static-analysis,documentation
22
+ Home-Page: https://github.com/rvben/rumdl
23
+ Author: Ruben J. Jongejan <ruben.jongejan@gmail.com>
24
+ Author-email: "Ruben J. Jongejan" <ruben.jongejan@gmail.com>
25
+ License: MIT
26
+ Requires-Python: >=3.7
27
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
28
+ Project-URL: Homepage, https://github.com/rvben/rumdl
29
+ Project-URL: Repository, https://github.com/rvben/rumdl.git
30
+
31
+ # rumdl - A high-performance Markdown linter, written in Rust
32
+
33
+ <div align="center">
34
+
35
+ ![rumdl Logo](https://raw.githubusercontent.com/rvben/rumdl/main/assets/logo.png)
36
+
37
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/build.yml?branch=main)](https://github.com/rvben/rumdl/actions)
38
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
39
+ [![Crates.io](https://img.shields.io/crates/v/rumdl)](https://crates.io/crates/rumdl)
40
+ [![PyPI](https://img.shields.io/pypi/v/rumdl)](https://pypi.org/project/rumdl/)
41
+ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rvben/rumdl)](https://github.com/rvben/rumdl/releases/latest)
42
+ [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl)](https://github.com/rvben/rumdl/stargazers)
43
+
44
+ ## A modern Markdown linter and formatter, built for speed with Rust
45
+
46
+ | [**Docs**](https://github.com/rvben/rumdl/blob/main/docs/RULES.md) | [**Rules**](https://github.com/rvben/rumdl/blob/main/docs/RULES.md) | [**Configuration**](#configuration) |
47
+
48
+ </div>
49
+
50
+ ## Table of Contents
51
+
52
+ - [rumdl - A high-performance Markdown linter, written in Rust](#rumdl---a-high-performance-markdown-linter-written-in-rust)
53
+ - [A modern Markdown linter and formatter, built for speed with Rust](#a-modern-markdown-linter-and-formatter-built-for-speed-with-rust)
54
+ - [Table of Contents](#table-of-contents)
55
+ - [Quick Start](#quick-start)
56
+ - [Overview](#overview)
57
+ - [Installation](#installation)
58
+ - [Using Cargo (Rust)](#using-cargo-rust)
59
+ - [Using pip (Python)](#using-pip-python)
60
+ - [Download binary](#download-binary)
61
+ - [VS Code Extension](#vs-code-extension)
62
+ - [Usage](#usage)
63
+ - [Pre-commit Integration](#pre-commit-integration)
64
+ - [Rules](#rules)
65
+ - [Command-line Interface](#command-line-interface)
66
+ - [Commands](#commands)
67
+ - [Usage Examples](#usage-examples)
68
+ - [Configuration](#configuration)
69
+ - [Configuration File Example](#configuration-file-example)
70
+ - [Initializing Configuration](#initializing-configuration)
71
+ - [Configuration in pyproject.toml](#configuration-in-pyprojecttoml)
72
+ - [Configuration Output](#configuration-output)
73
+ - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
74
+ - [Example output](#example-output)
75
+ - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
76
+ - [Output Style](#output-style)
77
+ - [Output Format](#output-format)
78
+ - [Development](#development)
79
+ - [Prerequisites](#prerequisites)
80
+ - [Building](#building)
81
+ - [Testing](#testing)
82
+ - [License](#license)
83
+
84
+ ## Quick Start
85
+
86
+ ```bash
87
+ # Install using Cargo
88
+ cargo install rumdl
89
+
90
+ # Lint Markdown files in the current directory
91
+ rumdl check .
92
+
93
+ # Automatically fix issues
94
+ rumdl check --fix .
95
+
96
+ # Create a default configuration file
97
+ rumdl init
98
+ ```
99
+
100
+ ## Overview
101
+
102
+ rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices in your Markdown files. It offers:
103
+
104
+ - ⚡️ **Built for speed** with Rust
105
+ - 🔍 **50+ lint rules** covering common Markdown issues
106
+ - 🛠️ **Automatic fixing** with `--fix` for most rules
107
+ - 📦 **Zero dependencies** - single binary with no runtime requirements
108
+ - 🔧 **Highly configurable** with TOML-based config files
109
+ - 🌐 **Multiple installation options** - Rust, Python, standalone binaries
110
+ - 🐍 **Installable via pip** for Python users
111
+ - 📏 **Modern CLI** with detailed error reporting
112
+ - 🔄 **CI/CD friendly** with non-zero exit code on errors
113
+
114
+ ## Installation
115
+
116
+ Choose the installation method that works best for you:
117
+
118
+ ### Using Cargo (Rust)
119
+
120
+ ```bash
121
+ cargo install rumdl
122
+ ```
123
+
124
+ ### Using pip (Python)
125
+
126
+ ```bash
127
+ pip install rumdl
128
+ ```
129
+
130
+ ### Download binary
131
+
132
+ ```bash
133
+ # Linux/macOS
134
+ curl -LsSf https://github.com/rvben/rumdl/releases/latest/download/rumdl-linux-x86_64.tar.gz | tar xzf - -C /usr/local/bin
135
+
136
+ # Windows PowerShell
137
+ Invoke-WebRequest -Uri "https://github.com/rvben/rumdl/releases/latest/download/rumdl-windows-x86_64.zip" -OutFile "rumdl.zip"
138
+ Expand-Archive -Path "rumdl.zip" -DestinationPath "$env:USERPROFILE\.rumdl"
139
+ ```
140
+
141
+ ### VS Code Extension
142
+
143
+ For the best development experience, install the rumdl VS Code extension directly from the command line:
144
+
145
+ ```bash
146
+ # Install the VS Code extension
147
+ rumdl vscode
148
+
149
+ # Check if the extension is installed
150
+ rumdl vscode --status
151
+
152
+ # Force reinstall the extension
153
+ rumdl vscode --force
154
+ ```
155
+
156
+ The extension provides:
157
+ - 🔍 Real-time linting as you type
158
+ - 💡 Quick fixes for common issues
159
+ - 🎨 Code formatting on save
160
+ - 📋 Hover tooltips with rule documentation
161
+ - ⚡ Lightning-fast performance with zero lag
162
+
163
+ The CLI will automatically detect VS Code, Cursor, or Windsurf and install the appropriate extension. See the [VS Code extension documentation](https://github.com/rvben/rumdl/blob/main/docs/vscode-extension.md) for more details.
164
+
165
+ ## Usage
166
+
167
+ Getting started with rumdl is simple:
168
+
169
+ ```bash
170
+ # Lint a single file
171
+ rumdl check README.md
172
+
173
+ # Lint all Markdown files in current directory and subdirectories
174
+ rumdl check .
175
+
176
+ # Automatically fix issues
177
+ rumdl check --fix README.md
178
+
179
+ # Create a default configuration file
180
+ rumdl init
181
+ ```
182
+
183
+ Common usage examples:
184
+
185
+ ```bash
186
+ # Lint with custom configuration
187
+ rumdl check --config my-config.toml docs/
188
+
189
+ # Disable specific rules
190
+ rumdl check --disable MD013,MD033 README.md
191
+
192
+ # Enable only specific rules
193
+ rumdl check --enable MD001,MD003 README.md
194
+
195
+ # Exclude specific files/directories
196
+ rumdl check --exclude "node_modules,dist" .
197
+
198
+ # Include only specific files/directories
199
+ rumdl check --include "docs/*.md,README.md" .
200
+
201
+ # Combine include and exclude patterns
202
+ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
203
+
204
+ # Don't respect gitignore files (note: --respect-gitignore defaults to true)
205
+ rumdl check --respect-gitignore=false .
206
+ ```
207
+
208
+ ## Pre-commit Integration
209
+
210
+ You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
211
+
212
+ The recommended way is to use the official pre-commit hook repository:
213
+
214
+ [rumdl-pre-commit repository](https://github.com/rvben/rumdl-pre-commit)
215
+
216
+ Add the following to your `.pre-commit-config.yaml`:
217
+
218
+ ```yaml
219
+ repos:
220
+ - repo: https://github.com/rvben/rumdl-pre-commit
221
+ rev: v0.0.45 # Use the latest release tag
222
+ hooks:
223
+ - id: rumdl
224
+ # To only check (default):
225
+ # args: []
226
+ # To automatically fix issues:
227
+ # args: [--fix]
228
+ ```
229
+
230
+ - By default, the hook will only check for issues.
231
+ - To automatically fix issues, add `args: [--fix]` to the hook configuration.
232
+
233
+ When you run `pre-commit install` or `pre-commit run`, pre-commit will automatically install `rumdl` in an isolated Python environment using pip. You do **not** need to install rumdl manually.
234
+
235
+ ## Rules
236
+
237
+ rumdl implements over 50 lint rules for Markdown files. Here are some key rule categories:
238
+
239
+ | Category | Description | Example Rules |
240
+ |-----------|-------------|---------------|
241
+ | **Headings** | Proper heading structure and formatting | MD001, MD002, MD003 |
242
+ | **Lists** | Consistent list formatting and structure | MD004, MD005, MD007 |
243
+ | **Whitespace** | Proper spacing and line length | MD009, MD010, MD012 |
244
+ | **Code** | Code block formatting and language tags | MD040, MD046, MD048 |
245
+ | **Links** | Proper link and reference formatting | MD034, MD039, MD042 |
246
+ | **Images** | Image alt text and references | MD045, MD052 |
247
+ | **Style** | Consistent style across document | MD031, MD032, MD035 |
248
+
249
+ For a complete list of rules and their descriptions, see our [documentation](https://github.com/rvben/rumdl/blob/main/docs/RULES.md) or run:
250
+
251
+ ```bash
252
+ rumdl --list-rules
253
+ ```
254
+
255
+ ## Command-line Interface
256
+
257
+ ```bash
258
+ rumdl <command> [options] [file or directory...]
259
+ ```
260
+
261
+ ### Commands
262
+
263
+ #### `check [PATHS...]`
264
+
265
+ Lint Markdown files and print warnings/errors (main subcommand)
266
+
267
+ **Arguments:**
268
+ - `[PATHS...]`: Files or directories to lint. If provided, these paths take precedence over include patterns
269
+
270
+ **Options:**
271
+ - `-f, --fix`: Automatically fix issues where possible
272
+ - `-l, --list-rules`: List all available rules
273
+ - `-d, --disable <rules>`: Disable specific rules (comma-separated)
274
+ - `-e, --enable <rules>`: Enable only specific rules (comma-separated)
275
+ - `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
276
+ - `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
277
+ - `--respect-gitignore`: Respect .gitignore files when scanning directories (does not apply to explicitly provided paths)
278
+ - `-v, --verbose`: Show detailed output
279
+ - `--profile`: Show profiling information
280
+ - `-q, --quiet`: Quiet mode
281
+ - `-o, --output <format>`: Output format: `text` (default) or `json`
282
+ - `--stdin`: Read from stdin instead of files
283
+
284
+ #### `init [OPTIONS]`
285
+
286
+ Create a default configuration file in the current directory
287
+
288
+ **Options:**
289
+ - `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
290
+
291
+ #### `import <FILE> [OPTIONS]`
292
+
293
+ Import and convert markdownlint configuration files to rumdl format
294
+
295
+ **Arguments:**
296
+ - `<FILE>`: Path to markdownlint config file (JSON/YAML)
297
+
298
+ **Options:**
299
+ - `-o, --output <path>`: Output file path (default: `.rumdl.toml`)
300
+ - `--format <format>`: Output format: `toml` or `json` (default: `toml`)
301
+ - `--dry-run`: Show converted config without writing to file
302
+
303
+ #### `rule [<rule>]`
304
+
305
+ Show information about a rule or list all rules
306
+
307
+ **Arguments:**
308
+ - `[rule]`: Rule name or ID (optional). If provided, shows details for that rule. If omitted, lists all available rules
309
+
310
+ #### `config [OPTIONS] [COMMAND]`
311
+
312
+ Show configuration or query a specific key
313
+
314
+ **Options:**
315
+ - `--defaults`: Show only the default configuration values
316
+ - `--output <format>`: Output format (e.g. `toml`, `json`)
317
+
318
+ **Subcommands:**
319
+ - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
320
+ - `file`: Show the absolute path of the configuration file that was loaded
321
+
322
+ #### `server [OPTIONS]`
323
+
324
+ Start the Language Server Protocol server for editor integration
325
+
326
+ **Options:**
327
+ - `--port <PORT>`: TCP port to listen on (for debugging)
328
+ - `--stdio`: Use stdio for communication (default)
329
+ - `-v, --verbose`: Enable verbose logging
330
+
331
+ #### `vscode [OPTIONS]`
332
+
333
+ Install the rumdl VS Code extension
334
+
335
+ **Options:**
336
+ - `--force`: Force reinstall even if already installed
337
+ - `--status`: Show installation status without installing
338
+
339
+ #### `version`
340
+
341
+ Show version information
342
+
343
+ ### Global Options
344
+
345
+ These options are available for all commands:
346
+
347
+ - `--color <mode>`: Control colored output: `auto` (default), `always`, `never`
348
+ - `--config <file>`: Path to configuration file
349
+ - `--no-config`: Ignore all configuration files and use built-in defaults
350
+
351
+ ### Usage Examples
352
+
353
+ ```bash
354
+ # Lint all Markdown files in the current directory
355
+ rumdl check .
356
+
357
+ # Automatically fix issues
358
+ rumdl check --fix .
359
+
360
+ # Create a default configuration file
361
+ rumdl init
362
+
363
+ # Create or update a pyproject.toml file with rumdl configuration
364
+ rumdl init --pyproject
365
+
366
+ # Import a markdownlint config file
367
+ rumdl import .markdownlint.json
368
+
369
+ # Convert markdownlint config to JSON format
370
+ rumdl import --format json .markdownlint.yaml --output rumdl-config.json
371
+
372
+ # Preview conversion without writing file
373
+ rumdl import --dry-run .markdownlint.json
374
+
375
+ # Show information about a specific rule
376
+ rumdl rule MD013
377
+
378
+ # List all available rules
379
+ rumdl rule
380
+
381
+ # Query a specific config key
382
+ rumdl config get global.exclude
383
+
384
+ # Show the path of the loaded configuration file
385
+ rumdl config file
386
+
387
+ # Show configuration as JSON instead of the default format
388
+ rumdl config --output json
389
+
390
+ # Lint content from stdin
391
+ echo "# My Heading" | rumdl check --stdin
392
+
393
+ # Get JSON output for integration with other tools
394
+ rumdl check --output json README.md
395
+
396
+ # Disable colors in output
397
+ rumdl check --color never README.md
398
+
399
+ # Use built-in defaults, ignoring all config files
400
+ rumdl check --no-config README.md
401
+
402
+ # Show version information
403
+ rumdl version
404
+ ```
405
+
406
+ ## Configuration
407
+
408
+ rumdl can be configured in several ways:
409
+
410
+ 1. Using a `.rumdl.toml` file in your project directory
411
+ 2. Using the `[tool.rumdl]` section in your project's `pyproject.toml` file (for Python projects)
412
+ 3. Using command-line arguments
413
+ 4. **Automatic markdownlint compatibility**: rumdl automatically discovers and loads existing markdownlint config files (`.markdownlint.json`, `.markdownlint.yaml`, etc.)
414
+
415
+ ### Markdownlint Migration
416
+
417
+ rumdl provides seamless compatibility with existing markdownlint configurations:
418
+
419
+ **Automatic Discovery**: rumdl automatically detects and loads markdownlint config files:
420
+ - `.markdownlint.json` / `.markdownlint.jsonc`
421
+ - `.markdownlint.yaml` / `.markdownlint.yml`
422
+ - `markdownlint.json` / `markdownlint.yaml`
423
+
424
+ **Explicit Import**: Convert markdownlint configs to rumdl format:
425
+
426
+ ```bash
427
+ # Convert to .rumdl.toml
428
+ rumdl import .markdownlint.json
429
+
430
+ # Convert to JSON format
431
+ rumdl import --format json .markdownlint.yaml --output config.json
432
+
433
+ # Preview conversion
434
+ rumdl import --dry-run .markdownlint.json
435
+ ```
436
+
437
+ For comprehensive documentation on global settings (file selection, rule enablement, etc.), see our [Global Settings Reference](docs/global-settings.md).
438
+
439
+ ### Configuration File Example
440
+
441
+ Here's an example `.rumdl.toml` configuration file:
442
+
443
+ ```toml
444
+ # Global settings
445
+ line-length = 100
446
+ exclude = ["node_modules", "build", "dist"]
447
+ respect-gitignore = true
448
+
449
+ # Disable specific rules
450
+ disabled-rules = ["MD013", "MD033"]
451
+
452
+ # Configure individual rules
453
+ [MD007]
454
+ indent = 2
455
+
456
+ [MD013]
457
+ line-length = 100
458
+ code-blocks = false
459
+ tables = false
460
+
461
+ [MD025]
462
+ level = 1
463
+ front-matter-title = "title"
464
+
465
+ [MD044]
466
+ names = ["rumdl", "Markdown", "GitHub"]
467
+
468
+ [MD048]
469
+ code-fence-style = "backtick"
470
+ ```
471
+
472
+ ### Initializing Configuration
473
+
474
+ To create a configuration file, use the `init` command:
475
+
476
+ ```bash
477
+ # Create a .rumdl.toml file (for any project)
478
+ rumdl init
479
+
480
+ # Create or update a pyproject.toml file with rumdl configuration (for Python projects)
481
+ rumdl init --pyproject
482
+ ```
483
+
484
+ ### Configuration in pyproject.toml
485
+
486
+ For Python projects, you can include rumdl configuration in your `pyproject.toml` file, keeping all project configuration in one place. Example:
487
+
488
+ ```toml
489
+ [tool.rumdl]
490
+ # Global options at root level
491
+ line-length = 100
492
+ disable = ["MD033"]
493
+ include = ["docs/*.md", "README.md"]
494
+ exclude = [".git", "node_modules"]
495
+ ignore-gitignore = false
496
+
497
+ # Rule-specific configuration
498
+ [tool.rumdl.MD013]
499
+ code_blocks = false
500
+ tables = false
501
+
502
+ [tool.rumdl.MD044]
503
+ names = ["rumdl", "Markdown", "GitHub"]
504
+ ```
505
+
506
+ Both kebab-case (`line-length`, `ignore-gitignore`) and snake_case (`line_length`, `ignore_gitignore`) formats are supported for compatibility with different Python tooling conventions.
507
+
508
+ ### Configuration Output
509
+
510
+ #### Effective Configuration (`rumdl config`)
511
+
512
+ The `rumdl config` command prints the **full effective configuration** (defaults + all overrides), showing every key and its value, annotated with the source of each value.
513
+ The output is colorized and the `[from ...]` annotation is globally aligned for easy scanning.
514
+
515
+ #### Example output
516
+
517
+ ```text
518
+ [global]
519
+ enable = [] [from default]
520
+ disable = ["MD033"] [from .rumdl.toml]
521
+ include = ["README.md"] [from .rumdl.toml]
522
+ respect_gitignore = true [from .rumdl.toml]
523
+
524
+ [MD013]
525
+ line_length = 200 [from .rumdl.toml]
526
+ code_blocks = true [from .rumdl.toml]
527
+ ...
528
+ ```
529
+
530
+ - **Keys** are cyan, **values** are yellow, and the `[from ...]` annotation is colored by source:
531
+ - Green: CLI
532
+ - Blue: `.rumdl.toml`
533
+ - Magenta: `pyproject.toml`
534
+ - Yellow: default
535
+ - The `[from ...]` column is aligned across all sections.
536
+
537
+ ### Defaults Only (`rumdl config --defaults`)
538
+
539
+ The `--defaults` flag prints only the default configuration as TOML, suitable for copy-paste or reference:
540
+
541
+ ```toml
542
+ [global]
543
+ enable = []
544
+ disable = []
545
+ exclude = []
546
+ include = []
547
+ respect_gitignore = true
548
+
549
+ [MD013]
550
+ line_length = 80
551
+ code_blocks = true
552
+ ...
553
+ ```
554
+
555
+ ## Output Style
556
+
557
+ rumdl produces clean, colorized output similar to modern linting tools:
558
+
559
+ ```text
560
+ README.md:12:1: [MD022] Headings should be surrounded by blank lines [*]
561
+ README.md:24:5: [MD037] Spaces inside emphasis markers: "* incorrect *" [*]
562
+ README.md:31:76: [MD013] Line length exceeds 80 characters
563
+ README.md:42:3: [MD010] Hard tabs found, use spaces instead [*]
564
+ ```
565
+
566
+ When running with `--fix`, rumdl shows which issues were fixed:
567
+
568
+ ```text
569
+ README.md:12:1: [MD022] Headings should be surrounded by blank lines [fixed]
570
+ README.md:24:5: [MD037] Spaces inside emphasis markers: "* incorrect *" [fixed]
571
+ README.md:42:3: [MD010] Hard tabs found, use spaces instead [fixed]
572
+
573
+ Fixed 3 issues in 1 file
574
+ ```
575
+
576
+ For a more detailed view, use the `--verbose` option:
577
+
578
+ ```text
579
+ ✓ No issues found in CONTRIBUTING.md
580
+ README.md:12:1: [MD022] Headings should be surrounded by blank lines [*]
581
+ README.md:24:5: [MD037] Spaces inside emphasis markers: "* incorrect *" [*]
582
+ README.md:42:3: [MD010] Hard tabs found, use spaces instead [*]
583
+
584
+ Found 3 issues in 1 file (2 files checked)
585
+ Run with `--fix` to automatically fix issues
586
+ ```
587
+
588
+ ### Output Format
589
+
590
+ #### Text Output (Default)
591
+
592
+ rumdl uses a consistent output format for all issues:
593
+
594
+ ```text
595
+ {file}:{line}:{column}: [{rule_id}] {message} [{fix_indicator}]
596
+ ```
597
+
598
+ The output is colorized by default:
599
+
600
+ - Filenames appear in blue and underlined
601
+ - Line and column numbers appear in cyan
602
+ - Rule IDs appear in yellow
603
+ - Error messages appear in white
604
+ - Fixable issues are marked with `[*]` in green
605
+ - Fixed issues are marked with `[fixed]` in green
606
+
607
+ #### JSON Output
608
+
609
+ For integration with other tools and automation, use `--output json`:
610
+
611
+ ```bash
612
+ rumdl check --output json README.md
613
+ ```
614
+
615
+ This produces structured JSON output:
616
+
617
+ ```json
618
+ {
619
+ "summary": {
620
+ "total_files": 1,
621
+ "files_with_issues": 1,
622
+ "total_issues": 2,
623
+ "fixable_issues": 1
624
+ },
625
+ "files": [
626
+ {
627
+ "path": "README.md",
628
+ "issues": [
629
+ {
630
+ "line": 12,
631
+ "column": 1,
632
+ "rule": "MD022",
633
+ "message": "Headings should be surrounded by blank lines",
634
+ "fixable": true,
635
+ "severity": "error"
636
+ }
637
+ ]
638
+ }
639
+ ]
640
+ }
641
+ ```
642
+
643
+ ## Development
644
+
645
+ ### Prerequisites
646
+
647
+ - Rust 1.70 or higher
648
+ - Make (for development commands)
649
+
650
+ ### Building
651
+
652
+ ```bash
653
+ make build
654
+ ```
655
+
656
+ ### Testing
657
+
658
+ ```bash
659
+ make test
660
+ ```
661
+
662
+ ## License
663
+
664
+ rumdl is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
665
+
@@ -0,0 +1,7 @@
1
+ python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
2
+ python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
3
+ python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
4
+ rumdl-0.0.86.data/scripts/rumdl,sha256=oYQ5-77iS5JpB2DLlPDd7FdVqgUSERJqamOceb8-Y6Q,10295984
5
+ rumdl-0.0.86.dist-info/METADATA,sha256=rLf39SdcG8Aqi5oJaJJHJ343ItFIVmAmZ_BWC9pGBJc,19772
6
+ rumdl-0.0.86.dist-info/WHEEL,sha256=ewUTWcHXqRTyVeq-lYMZtmOYOoBnaUkIR4iFYxs0Gwg,105
7
+ rumdl-0.0.86.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.8.7)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-manylinux_2_39_x86_64