rumdl 0.0.123__py3-none-musllinux_1_2_x86_64.whl → 0.0.125__py3-none-musllinux_1_2_x86_64.whl

{rumdl-0.0.123.dist-info → rumdl-0.0.125.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.123
+Version: 0.0.125
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -55,8 +55,9 @@ cargo install rumdl
 # Lint Markdown files in the current directory
 rumdl check .
 
-# Automatically fix issues
-rumdl check --fix .
+# Format files (automatically fix issues)
+rumdl fmt .
+# Alternative: rumdl check --fix .
 
 # Create a default configuration file
 rumdl init
@@ -64,7 +65,7 @@ rumdl init
 
 ## Overview
 
-rumdl is a high-performance Markdown linter and fixer that helps ensure consistency and best practices
+rumdl is a high-performance Markdown linter and formatter 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.
 
@@ -72,7 +73,7 @@ It offers:
 
 - ⚡️ **Built for speed** with Rust - significantly faster than alternatives
 - 🔍 **54 lint rules** covering common Markdown issues
-- 🛠️ **Automatic fixing** with `--fix` for most rules
+- 🛠️ **Automatic formatting** with `--fix` for files and stdin/stdout
 - 📦 **Zero dependencies** - single binary with no runtime requirements
 - 🔧 **Highly configurable** with TOML-based config files
 - 🌐 **Multiple installation options** - Rust, Python, standalone binaries
@@ -95,6 +96,8 @@ It offers:
     - [Download binary](#download-binary)
     - [VS Code Extension](#vs-code-extension)
   - [Usage](#usage)
+    - [Stdin/Stdout Formatting](#stdinstdout-formatting)
+    - [Editor Integration](#editor-integration)
   - [Pre-commit Integration](#pre-commit-integration)
   - [CI/CD Integration](#cicd-integration)
     - [GitHub Actions](#github-actions)
@@ -102,6 +105,7 @@ It offers:
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
       - [`check [PATHS...]`](#check-paths)
+      - [`fmt [PATHS...]`](#fmt-paths)
       - [`init [OPTIONS]`](#init-options)
       - [`import <FILE> [OPTIONS]`](#import-file-options)
       - [`rule [<rule>]`](#rule-rule)
@@ -213,8 +217,8 @@ rumdl check README.md
 # Lint all Markdown files in current directory and subdirectories
 rumdl check .
 
-# Automatically fix issues
-rumdl check --fix README.md
+# Format a specific file
+rumdl fmt README.md
 
 # Create a default configuration file
 rumdl init
@@ -245,6 +249,38 @@ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 rumdl check --respect-gitignore=false .
 ```
 
+### Stdin/Stdout Formatting
+
+rumdl supports formatting via stdin/stdout, making it ideal for editor integrations and CI pipelines:
+
+```bash
+# Format content from stdin and output to stdout
+cat README.md | rumdl fmt - > README_formatted.md
+# Alternative: cat README.md | rumdl fmt --stdin > README_formatted.md
+
+# Use in a pipeline
+echo "# Title   " | rumdl fmt -
+# Output: # Title
+
+# Format clipboard content (macOS example)
+pbpaste | rumdl fmt - | pbcopy
+
+# Provide filename context for better error messages (useful for editor integrations)
+cat README.md | rumdl check - --stdin-filename README.md
+```
+
+### Editor Integration
+
+For editor integration, use stdin/stdout mode with the `--quiet` flag to suppress diagnostic messages:
+
+```bash
+# Format selection in editor (example for vim)
+:'<,'>!rumdl fmt - --quiet
+
+# Format entire buffer
+:%!rumdl fmt - --quiet
+```
+
 ## Pre-commit Integration
 
 You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
@@ -337,6 +373,37 @@ Lint Markdown files and print warnings/errors (main subcommand)
 - `-o, --output <format>`: Output format: `text` (default) or `json`
 - `--stdin`: Read from stdin instead of files
 
+#### `fmt [PATHS...]`
+
+Format Markdown files (alias for `check --fix`)
+
+**Arguments:**
+
+- `[PATHS...]`: Files or directories to format. If provided, these paths take precedence over include patterns
+
+**Options:**
+
+All the same options as `check` are available (except `--fix` which is always enabled), including:
+- `--stdin`: Format content from stdin and output to stdout
+- `-d, --disable <rules>`: Disable specific rules during formatting
+- `-e, --enable <rules>`: Format using only specific rules
+- `--exclude/--include`: Control which files to format
+- `-q, --quiet`: Suppress diagnostic output
+
+**Examples:**
+
+```bash
+# Format all Markdown files in current directory
+rumdl fmt
+
+# Format specific file
+rumdl fmt README.md
+
+# Format from stdin (using dash syntax)
+cat README.md | rumdl fmt - > formatted.md
+# Alternative: cat README.md | rumdl fmt --stdin > formatted.md
+```
+
 #### `init [OPTIONS]`
 
 Create a default configuration file in the current directory
@@ -428,8 +495,9 @@ This allows scripts and CI/CD systems to distinguish between "the tool found pro
 # Lint all Markdown files in the current directory
 rumdl check .
 
-# Automatically fix issues
-rumdl check --fix .
+# Format files (automatically fix issues)
+rumdl fmt .
+# Alternative: rumdl check --fix .
 
 # Create a default configuration file
 rumdl init
@@ -484,11 +552,33 @@ rumdl version
 
 rumdl can be configured in several ways:
 
-1. Using a `.rumdl.toml` file in your project directory
+1. Using a `.rumdl.toml` file in your project directory or parent directories
 2. Using the `[tool.rumdl]` section in your project's `pyproject.toml` file (for Python projects)
 3. Using command-line arguments
 4. **Automatic markdownlint compatibility**: rumdl automatically discovers and loads existing markdownlint config files (`.markdownlint.json`, `.markdownlint.yaml`, etc.)
 
+### Configuration Discovery
+
+rumdl automatically searches for configuration files by traversing up the directory tree from the current
+working directory, similar to tools like `git`, `ruff`, and `eslint`. This means you can run rumdl from any
+subdirectory of your project and it will find the configuration file at the project root.
+
+The search follows these rules:
+- Searches upward for `.rumdl.toml`, `rumdl.toml`, or `pyproject.toml` (with `[tool.rumdl]` section)
+- Stops at the first configuration file found
+- Stops searching when it encounters a `.git` directory (project boundary)
+- Maximum traversal depth of 100 directories
+
+To disable all configuration discovery and use only built-in defaults, use the `--isolated` flag:
+
+```bash
+# Use discovered configuration (default behavior)
+rumdl check .
+
+# Ignore all configuration files
+rumdl check --isolated .
+```
+
 ### Markdownlint Migration
 
 rumdl provides seamless compatibility with existing markdownlint configurations:
@@ -660,7 +750,7 @@ README.md:24:5: [MD037] Spaces inside emphasis markers: "* incorrect *" [*]
 README.md:42:3: [MD010] Hard tabs found, use spaces instead [*]
 
 Found 3 issues in 1 file (2 files checked)
-Run with `--fix` to automatically fix issues
+Run `rumdl fmt` to automatically fix issues
 ```
 
 ### Output Format

rumdl-0.0.125.dist-info/RECORD

@@ -0,0 +1,8 @@
+python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
+python/rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
+python/rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rumdl-0.0.125.data/scripts/rumdl,sha256=SY9pWW_Q-BcXtCaGS3mhkr31rWlMSUsDRN07BsX_Mww,6190280
+rumdl-0.0.125.dist-info/METADATA,sha256=stM3UIrSmDvrTVOecVpSCC_5-pqw2Sry-JhOGVtvz24,24769
+rumdl-0.0.125.dist-info/WHEEL,sha256=ZiKCVJQyCIbXpOYnG9r5TWsf4V1VNqD20bP8-FGilBA,104
+rumdl-0.0.125.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
+rumdl-0.0.125.dist-info/RECORD,,

rumdl-0.0.123.dist-info/RECORD

@@ -1,8 +0,0 @@
-python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
-python/rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
-python/rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rumdl-0.0.123.data/scripts/rumdl,sha256=x5hj9wVOEloPPYwBs190aZ8wyIaT-MSiD2v6NmeF4hc,6181512
-rumdl-0.0.123.dist-info/METADATA,sha256=h5ZbDUprc614kdM7G-cvZ-ZqaG2_2DWYKDwB8uyP41A,21895
-rumdl-0.0.123.dist-info/WHEEL,sha256=ZiKCVJQyCIbXpOYnG9r5TWsf4V1VNqD20bP8-FGilBA,104
-rumdl-0.0.123.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
-rumdl-0.0.123.dist-info/RECORD,,