rumdl 0.0.162__py3-none-macosx_11_0_arm64.whl → 0.0.171__py3-none-macosx_11_0_arm64.whl

{rumdl-0.0.162.dist-info → rumdl-0.0.171.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.162
+Version: 0.0.171
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -52,9 +52,11 @@ cargo install rumdl
 # Lint Markdown files in the current directory
 rumdl check .
 
-# Format files (automatically fix issues)
+# Format files (exits 0 on success, even if unfixable violations remain)
 rumdl fmt .
-# Alternative: rumdl check --fix .
+
+# Auto-fix and report unfixable violations (exits 1 if violations remain)
+rumdl check --fix .
 
 # Create a default configuration file
 rumdl init
@@ -68,7 +70,7 @@ Python linting, rumdl brings similar speed and developer experience improvements
 It offers:
 
 - ⚡️ **Built for speed** with Rust - significantly faster than alternatives
-- 🔍 **54 lint rules** covering common Markdown issues
+- 🔍 **55 lint rules** covering common Markdown issues
 - 🛠️ **Automatic formatting** with `--fix` for files and stdin/stdout
 - 📦 **Zero dependencies** - single binary with no runtime requirements
 - 🔧 **Highly configurable** with TOML-based config files
@@ -77,6 +79,14 @@ It offers:
 - 📏 **Modern CLI** with detailed error reporting
 - 🔄 **CI/CD friendly** with non-zero exit code on errors
 
+### Performance
+
+rumdl is designed for speed. Benchmarked on the [Rust Book](https://github.com/rust-lang/book) repository (478 markdown files, October 2025):
+
+![Cold start benchmark comparison](assets/benchmark.svg)
+
+With intelligent caching, subsequent runs are even faster - rumdl only re-lints files that have changed, making it ideal for watch mode and editor integration.
+
 ## Table of Contents
 
 - [rumdl - A high-performance Markdown linter, written in Rust](#rumdl---a-high-performance-markdown-linter-written-in-rust)
@@ -172,6 +182,19 @@ uv tool install rumdl
 uv tool run rumdl check .
 ```
 
+### Using Nix (macOS/Linux)
+
+```bash
+nix-channel --update
+nix-env --install --attr nixpkgs.rumdl
+```
+
+Alternatively, you can use flakes to run it without installation.
+
+```bash
+nix run --extra-experimental-features 'flakes nix-command' nixpkgs/nixpkgs-unstable#rumdl -- --version
+```
+
 ### Download binary
 
 ```bash
@@ -359,7 +382,7 @@ This produces annotations that GitHub automatically displays in the PR's "Files
 
 ## Rules
 
-rumdl implements 54 lint rules for Markdown files. Here are some key rule categories:
+rumdl implements 55 lint rules for Markdown files. Here are some key rule categories:
 
 | Category | Description | Example Rules |
 | -----------|-------------|--------------- |
@@ -414,7 +437,7 @@ Lint Markdown files and print warnings/errors (main subcommand)
 
 #### `fmt [PATHS...]`
 
-Format Markdown files (alias for `check --fix`)
+Format Markdown files and output the result. Always exits with code 0 on successful formatting, making it ideal for editor integration.
 
 **Arguments:**
 
@@ -521,13 +544,12 @@ These options are available for all commands:
 
 ### Exit Codes
 
-rumdl uses exit codes following Ruff's convention for easy CI/CD integration:
-
-- `0`: Success - no issues found
-- `1`: Linting violations found
-- `2`: Tool error (configuration error, file access error, invalid arguments, etc.)
+- `0`: Success
+- `1`: Violations found (or remain after `--fix`)
+- `2`: Tool error
 
-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).
+**Note:** `rumdl fmt` exits 0 on successful formatting (even if unfixable violations remain), making it compatible with editor integrations. `rumdl check --fix` exits 1 if violations remain, useful
+for pre-commit hooks.
 
 ### Usage Examples
 
@@ -535,9 +557,11 @@ This allows scripts and CI/CD systems to distinguish between "the tool found pro
 # Lint all Markdown files in the current directory
 rumdl check .
 
-# Format files (automatically fix issues)
+# Format files (exits 0 on success, even if unfixable violations remain)
 rumdl fmt .
-# Alternative: rumdl check --fix .
+
+# Auto-fix and report unfixable violations (exits 1 if violations remain)
+rumdl check --fix .
 
 # Preview what would be fixed without modifying files
 rumdl check --diff .
@@ -928,7 +952,7 @@ This produces structured JSON output:
 
 ### Prerequisites
 
-- Rust 1.70 or higher
+- Rust 1.91 or higher
 - Make (for development commands)
 
 ### Building

rumdl-0.0.171.dist-info/RECORD

@@ -0,0 +1,8 @@
+rumdl-0.0.171.data/scripts/rumdl,sha256=ooYwNEqhLbVullb9OtmfKUwRjX9nFgjAnO3S9ZKJNHs,5081056
+rumdl-0.0.171.dist-info/METADATA,sha256=oOZOiqyVk9aMwEcR5YIopl_o1dWM0ZKc98woySsaqK0,30614
+rumdl-0.0.171.dist-info/WHEEL,sha256=gFUeb0K5OKVu-_PxYk7JE9tGE1KIHHvhpIzf61gKVd8,101
+rumdl-0.0.171.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
+rumdl/__init__.py,sha256=Al8fdAo1nixifQiBrXvQtGY-4071FS73uJbLEBAWlYY,267
+rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
+rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rumdl-0.0.171.dist-info/RECORD,,

rumdl-0.0.162.dist-info/RECORD

@@ -1,8 +0,0 @@
-rumdl-0.0.162.data/scripts/rumdl,sha256=l3wy2sb7MRlsP72d7XVZIZUi0oXAlTyTXeMPiP0uBFs,5129616
-rumdl-0.0.162.dist-info/METADATA,sha256=RyNCUhu53-1vbnQHJkOyYOiCcfRWrKGev4TvlG2jeb0,29762
-rumdl-0.0.162.dist-info/WHEEL,sha256=gFUeb0K5OKVu-_PxYk7JE9tGE1KIHHvhpIzf61gKVd8,101
-rumdl-0.0.162.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
-rumdl/__init__.py,sha256=Al8fdAo1nixifQiBrXvQtGY-4071FS73uJbLEBAWlYY,267
-rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
-rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rumdl-0.0.162.dist-info/RECORD,,