rumdl 0.0.143__py3-none-win_amd64.whl → 0.0.170__py3-none-win_amd64.whl

rumdl/__init__.py

@@ -0,0 +1,11 @@
+"""
+rumdl: An extremely fast Markdown linter written in Rust.
+"""
+
+try:
+    from importlib.metadata import version
+    __version__ = version("rumdl")
+except ImportError:
+    # Python < 3.8
+    from importlib_metadata import version
+    __version__ = version("rumdl")

{rumdl-0.0.143.dist-info → rumdl-0.0.170.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.143
+Version: 0.0.170
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -33,7 +33,7 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
 
 ![rumdl Logo](https://raw.githubusercontent.com/rvben/rumdl/main/assets/logo.png)
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/build.yml?branch=main)](https://github.com/rvben/rumdl/actions)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/rvben/rumdl/release.yml?branch=main)](https://github.com/rvben/rumdl/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Crates.io](https://img.shields.io/crates/v/rumdl)](https://crates.io/crates/rumdl)
 [![PyPI](https://img.shields.io/pypi/v/rumdl)](https://pypi.org/project/rumdl/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rvben/rumdl)](https://github.com/rvben/rumdl/releases/latest) [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl)](https://github.com/rvben/rumdl/stargazers)
 
@@ -77,6 +77,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)
@@ -95,6 +103,7 @@ It offers:
     - [Stdin/Stdout Formatting](#stdinstdout-formatting)
     - [Editor Integration](#editor-integration)
   - [Pre-commit Integration](#pre-commit-integration)
+    - [Excluding Files in Pre-commit](#excluding-files-in-pre-commit)
   - [CI/CD Integration](#cicd-integration)
     - [GitHub Actions](#github-actions)
   - [Rules](#rules)
@@ -114,8 +123,10 @@ It offers:
     - [Usage Examples](#usage-examples)
   - [Configuration](#configuration)
     - [Configuration Discovery](#configuration-discovery)
+    - [Editor Support (JSON Schema)](#editor-support-json-schema)
     - [Global Configuration](#global-configuration)
     - [Markdownlint Migration](#markdownlint-migration)
+    - [Inline Configuration](#inline-configuration)
     - [Configuration File Example](#configuration-file-example)
     - [Initializing Configuration](#initializing-configuration)
     - [Configuration in pyproject.toml](#configuration-in-pyprojecttoml)
@@ -131,6 +142,7 @@ It offers:
     - [Prerequisites](#prerequisites)
     - [Building](#building)
     - [Testing](#testing)
+    - [JSON Schema Generation](#json-schema-generation)
   - [License](#license)
 
 ## Installation
@@ -168,6 +180,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
@@ -357,8 +382,8 @@ This produces annotations that GitHub automatically displays in the PR's "Files
 
 rumdl implements 54 lint rules for Markdown files. Here are some key rule categories:
 
-|  Category | Description | Example Rules |
-|-----------|-------------|---------------|
+| Category | Description | Example Rules |
+| -----------|-------------|--------------- |
 | **Headings** | Proper heading structure and formatting | MD001, MD002, MD003 |
 | **Lists** | Consistent list formatting and structure | MD004, MD005, MD007 |
 | **Whitespace** | Proper spacing and line length | MD009, MD010, MD012 |
@@ -619,6 +644,27 @@ rumdl check .
 rumdl check --isolated .
 ```
 
+### Editor Support (JSON Schema)
+
+rumdl provides a JSON Schema for `.rumdl.toml` configuration files, enabling autocomplete, validation, and inline documentation in supported editors like VS Code, IntelliJ IDEA, and others.
+
+The schema is available at `https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json`.
+
+**VS Code Setup:**
+
+1. Install the "Even Better TOML" extension
+2. The schema will be automatically associated with `.rumdl.toml` and `rumdl.toml` files once submitted to SchemaStore
+
+**Manual Schema Association:**
+
+Add this to your `.rumdl.toml` file (in a comment, as TOML doesn't support `$schema`):
+
+```toml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json
+```
+
+This enables IntelliSense, validation, and hover documentation for all configuration options.
+
 ### Global Configuration
 
 When no project configuration is found, rumdl will check for a user-level configuration file in your platform's standard config directory:
@@ -701,6 +747,12 @@ respect-gitignore = true
 # Disable specific rules
 disabled-rules = ["MD013", "MD033"]
 
+# Disable specific rules for specific files
+[per-file-ignores]
+"README.md" = ["MD033"]  # Allow HTML in README
+"SUMMARY.md" = ["MD025"]  # Allow multiple H1 in table of contents
+"docs/api/**/*.md" = ["MD013", "MD041"]  # Relax rules for generated docs
+
 # Configure individual rules
 [MD007]
 indent = 2
@@ -912,6 +964,25 @@ make build
 make test
 ```
 
+### JSON Schema Generation
+
+If you modify the configuration structures in `src/config.rs`, regenerate the JSON schema:
+
+```bash
+# Generate/update the schema
+make schema
+# Or: rumdl schema generate
+
+# Check if schema is up-to-date (useful in CI)
+make check-schema
+# Or: rumdl schema check
+
+# Print schema to stdout
+rumdl schema print
+```
+
+The schema is automatically generated from the Rust types using `schemars` and should be kept in sync with the configuration structures.
+
 ## License
 
 rumdl is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

rumdl-0.0.170.dist-info/RECORD

@@ -0,0 +1,8 @@
+rumdl-0.0.170.data/scripts/rumdl.exe,sha256=RoEii_q5ekRPJaKRHD8EDZF-AS966-d-t9sWBS60wMU,7233536
+rumdl-0.0.170.dist-info/METADATA,sha256=5yN_DeIkz3btZgoYzMVF2a_cWdLAzuS2H1lBDHc2I0M,31385
+rumdl-0.0.170.dist-info/WHEEL,sha256=BV3ZP699xxmMelj8d6UzKLQSx3JdzqHyifn4bQk5AR8,93
+rumdl-0.0.170.dist-info/licenses/LICENSE,sha256=DbLW8usrvOQqqbNIe3jV76cZ-6LlxbDHy_K_ElIm5ws,1100
+rumdl/__init__.py,sha256=ltWsZOHffd9FQVdbJ0_Wb2x1NwKp2W2GYzPx06MMu6g,278
+rumdl/__main__.py,sha256=RxsYpDd-aeZy4s0ziGvSMq3n39kPYPfFgHeNd9dAapM,1936
+rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rumdl-0.0.170.dist-info/RECORD,,

{rumdl-0.0.143.dist-info → rumdl-0.0.170.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.4)
+Generator: maturin (1.9.6)
 Root-Is-Purelib: false
 Tag: py3-none-win_amd64

python/rumdl/__init__.py

@@ -1,5 +0,0 @@
-"""
-rumdl: An extremely fast Markdown linter written in Rust.
-"""
-
-__version__ = "0.0.12"

rumdl-0.0.143.dist-info/RECORD

@@ -1,8 +0,0 @@
-python/rumdl/__init__.py,sha256=oHcESVopbLsh5hnNa4Z1iLIS-Bi9ai_Bzc5mLuibiUY,95
-python/rumdl/__main__.py,sha256=RxsYpDd-aeZy4s0ziGvSMq3n39kPYPfFgHeNd9dAapM,1936
-python/rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rumdl-0.0.143.data/scripts/rumdl.exe,sha256=wo-1QcReiZPKMOTjYTdThnURqpToUi9iH6DZPorCRCk,7052800
-rumdl-0.0.143.dist-info/METADATA,sha256=audkGVb_n5i_J5bQ85RZsSLpbV_cnku4XVhwU8I5Vbc,28836
-rumdl-0.0.143.dist-info/WHEEL,sha256=ubF6pSMXfesltAnfP_hEAu2k7YT3fHJXHWEIY1cdTgY,93
-rumdl-0.0.143.dist-info/licenses/LICENSE,sha256=DbLW8usrvOQqqbNIe3jV76cZ-6LlxbDHy_K_ElIm5ws,1100
-rumdl-0.0.143.dist-info/RECORD,,