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