rumdl 0.0.91__py3-none-macosx_10_12_x86_64.whl → 0.0.93__py3-none-macosx_10_12_x86_64.whl

{rumdl-0.0.91.dist-info → rumdl-0.0.93.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.91
+Version: 0.0.93
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -48,41 +48,6 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
 
 </div>
 
-## Table of Contents
-
-- [rumdl - A high-performance Markdown linter, written in Rust](#rumdl---a-high-performance-markdown-linter-written-in-rust)
-  - [A modern Markdown linter and formatter, built for speed with Rust](#a-modern-markdown-linter-and-formatter-built-for-speed-with-rust)
-  - [Table of Contents](#table-of-contents)
-  - [Quick Start](#quick-start)
-  - [Overview](#overview)
-  - [Performance](#performance)
-  - [Installation](#installation)
-    - [Using Cargo (Rust)](#using-cargo-rust)
-    - [Using pip (Python)](#using-pip-python)
-    - [Download binary](#download-binary)
-    - [VS Code Extension](#vs-code-extension)
-  - [Usage](#usage)
-  - [Pre-commit Integration](#pre-commit-integration)
-  - [Rules](#rules)
-  - [Command-line Interface](#command-line-interface)
-    - [Commands](#commands)
-    - [Usage Examples](#usage-examples)
-  - [Configuration](#configuration)
-    - [Configuration File Example](#configuration-file-example)
-    - [Initializing Configuration](#initializing-configuration)
-    - [Configuration in pyproject.toml](#configuration-in-pyprojecttoml)
-    - [Configuration Output](#configuration-output)
-      - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
-      - [Example output](#example-output)
-    - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
-  - [Output Style](#output-style)
-    - [Output Format](#output-format)
-  - [Development](#development)
-    - [Prerequisites](#prerequisites)
-    - [Building](#building)
-    - [Testing](#testing)
-  - [License](#license)
-
 ## Quick Start
 
 ```bash
@@ -101,7 +66,11 @@ rumdl init
 
 ## Overview
 
-rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices in your Markdown files. It offers:
+rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices
+in your Markdown files. Inspired by [ruff](https://github.com/astral-sh/ruff)'s approach to Python linting,
+rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
+
+It offers:
 
 - ⚡️ **Built for speed** with Rust - significantly faster than alternatives
 - 🔍 **54 lint rules** covering common Markdown issues
@@ -113,13 +82,37 @@ rumdl is a high-performance Markdown linter and fixer that helps ensure consiste
 - 📏 **Modern CLI** with detailed error reporting
 - 🔄 **CI/CD friendly** with non-zero exit code on errors
 
-## Performance
-
-rumdl is designed for speed and efficiency:
-
-![Performance Comparison](assets/performance_overview.png)
+## Table of Contents
 
-rumdl is **4.3x faster** on average than markdownlint for typical markdown files, with performance improvements ranging from 3.4x to 5.4x depending on project size.
+- [Quick Start](#quick-start)
+- [Overview](#overview)
+- [Installation](#installation)
+  - [Using Cargo (Rust)](#using-cargo-rust)
+  - [Using pip (Python)](#using-pip-python)
+  - [Using uv](#using-uv)
+  - [Download binary](#download-binary)
+  - [VS Code Extension](#vs-code-extension)
+- [Usage](#usage)
+- [Pre-commit Integration](#pre-commit-integration)
+- [Rules](#rules)
+- [Command-line Interface](#command-line-interface)
+  - [Commands](#commands)
+  - [Usage Examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Configuration File Example](#configuration-file-example)
+  - [Initializing Configuration](#initializing-configuration)
+  - [Configuration in pyproject.toml](#configuration-in-pyproject-toml)
+  - [Configuration Output](#configuration-output)
+    - [Effective Configuration (`rumdl config`)](#effective-configuration-rumdl-config)
+    - [Example output](#example-output)
+  - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config-defaults)
+- [Output Style](#output-style)
+  - [Output Format](#output-format)
+- [Development](#development)
+  - [Prerequisites](#prerequisites)
+  - [Building](#building)
+  - [Testing](#testing)
+- [License](#license)
 
 ## Installation
 
@@ -137,6 +130,18 @@ cargo install rumdl
 pip install rumdl
 ```
 
+### Using uv
+
+For faster installation and better dependency management with [uv](https://github.com/astral-sh/uv):
+
+```bash
+# Install directly
+uv tool install rumdl
+
+# Or run without installing
+uv tool run rumdl check .
+```
+
 ### Download binary
 
 ```bash
@@ -164,6 +169,7 @@ rumdl vscode --force
 ```
 
 The extension provides:
+
 - 🔍 Real-time linting as you type
 - 💡 Quick fixes for common issues
 - 🎨 Code formatting on save
@@ -275,9 +281,11 @@ rumdl <command> [options] [file or directory...]
 Lint Markdown files and print warnings/errors (main subcommand)
 
 **Arguments:**
+
 - `[PATHS...]`: Files or directories to lint. If provided, these paths take precedence over include patterns
 
 **Options:**
+
 - `-f, --fix`: Automatically fix issues where possible
 - `-l, --list-rules`: List all available rules
 - `-d, --disable <rules>`: Disable specific rules (comma-separated)
@@ -297,6 +305,7 @@ Lint Markdown files and print warnings/errors (main subcommand)
 Create a default configuration file in the current directory
 
 **Options:**
+
 - `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
 
 #### `import <FILE> [OPTIONS]`
@@ -304,9 +313,11 @@ Create a default configuration file in the current directory
 Import and convert markdownlint configuration files to rumdl format
 
 **Arguments:**
+
 - `<FILE>`: Path to markdownlint config file (JSON/YAML)
 
 **Options:**
+
 - `-o, --output <path>`: Output file path (default: `.rumdl.toml`)
 - `--format <format>`: Output format: `toml` or `json` (default: `toml`)
 - `--dry-run`: Show converted config without writing to file
@@ -316,6 +327,7 @@ Import and convert markdownlint configuration files to rumdl format
 Show information about a rule or list all rules
 
 **Arguments:**
+
 - `[rule]`: Rule name or ID (optional). If provided, shows details for that rule. If omitted, lists all available rules
 
 #### `config [OPTIONS] [COMMAND]`
@@ -323,10 +335,12 @@ Show information about a rule or list all rules
 Show configuration or query a specific key
 
 **Options:**
+
 - `--defaults`: Show only the default configuration values
 - `--output <format>`: Output format (e.g. `toml`, `json`)
 
 **Subcommands:**
+
 - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
 - `file`: Show the absolute path of the configuration file that was loaded
 
@@ -335,6 +349,7 @@ Show configuration or query a specific key
 Start the Language Server Protocol server for editor integration
 
 **Options:**
+
 - `--port <PORT>`: TCP port to listen on (for debugging)
 - `--stdio`: Use stdio for communication (default)
 - `-v, --verbose`: Enable verbose logging
@@ -344,6 +359,7 @@ Start the Language Server Protocol server for editor integration
 Install the rumdl VS Code extension
 
 **Options:**
+
 - `--force`: Force reinstall even if already installed
 - `--status`: Show installation status without installing
 
@@ -431,6 +447,7 @@ rumdl can be configured in several ways:
 rumdl provides seamless compatibility with existing markdownlint configurations:
 
 **Automatic Discovery**: rumdl automatically detects and loads markdownlint config files:
+
 - `.markdownlint.json` / `.markdownlint.jsonc`
 - `.markdownlint.yaml` / `.markdownlint.yml`
 - `markdownlint.json` / `markdownlint.yaml`

rumdl-0.0.93.dist-info/RECORD

@@ -0,0 +1,11 @@
+python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
+python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
+python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
+rumdl-0.0.93.data/scripts/benchmark,sha256=Nc8i1KHFhqFmvpAsAKvtRk3WXDZVsWSuh5bPyaXK3F8,2431104
+rumdl-0.0.93.data/scripts/file_parallel_benchmark,sha256=1zxElJxIiPGR_GG_H1IfPA5yjdMdOJuF99laOx9w03s,2764984
+rumdl-0.0.93.data/scripts/measure_code_span_performance,sha256=mWd3gcNM-s1tP1JnQckmqvD7L7NvJd49hp14TIjJrjo,1430480
+rumdl-0.0.93.data/scripts/rumdl,sha256=B5Oy_82HnG_zaqt9ogoAHHTwF-T2lft7dFhclu9m33o,5350704
+rumdl-0.0.93.dist-info/METADATA,sha256=3xtlcLheZdTxnh1yQWYq22cTTGj2x6krcmir3S7QUWo,20034
+rumdl-0.0.93.dist-info/WHEEL,sha256=_ftC59G2lUDVh6DjVQid1lXOEswHzpmZBvGibXyRtww,103
+rumdl-0.0.93.dist-info/licenses/LICENSE,sha256=xXY7jFvuEmObzRovm2RZmB7KR1sldVYWZLtcKIqlh3E,1073
+rumdl-0.0.93.dist-info/RECORD,,

rumdl-0.0.91.dist-info/RECORD

@@ -1,11 +0,0 @@
-python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
-python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
-python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-rumdl-0.0.91.data/scripts/benchmark,sha256=hUZ9oDhnKTKgWRicUnK0OdeEiSMDlJj_YMF6x1I3rHc,2389944
-rumdl-0.0.91.data/scripts/file_parallel_benchmark,sha256=ImH1EysT5bDqCa7y7iKA-WMBxJt04CcQqfHIApxVLwg,2736184
-rumdl-0.0.91.data/scripts/measure_code_span_performance,sha256=li5sxlJqS5R0uoRxKqJbVaVjitQduFg8SgzETfWAG2g,1430480
-rumdl-0.0.91.data/scripts/rumdl,sha256=ajdJ4gdTdLztyo2iFiqiBPIYhTqrHqVtUodcegKa634,5301368
-rumdl-0.0.91.dist-info/METADATA,sha256=HXszBOYsOukm4G2M9sOi4WKSh06ISeVXQnDkmeAIiTk,20278
-rumdl-0.0.91.dist-info/WHEEL,sha256=_ftC59G2lUDVh6DjVQid1lXOEswHzpmZBvGibXyRtww,103
-rumdl-0.0.91.dist-info/licenses/LICENSE,sha256=xXY7jFvuEmObzRovm2RZmB7KR1sldVYWZLtcKIqlh3E,1073
-rumdl-0.0.91.dist-info/RECORD,,