rumdl 0.0.79__tar.gz → 0.0.81__tar.gz

{rumdl-0.0.79 → rumdl-0.0.81}/Cargo.lock

@@ -1783,7 +1783,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.79"
+version = "0.0.81"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.79 → rumdl-0.0.81}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.79"
+version = "0.0.81"
 edition = "2021"
 description = "A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)"
 authors = ["Ruben J. Jongejan <ruben.jongejan@gmail.com>"]

{rumdl-0.0.79 → rumdl-0.0.81}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.79
+Version: 0.0.81
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -176,8 +176,8 @@ rumdl check --include "docs/*.md,README.md" .
 # Combine include and exclude patterns
 rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 
-# Ignore gitignore rules
-rumdl check --no-respect-gitignore .
+# Don't respect gitignore files (note: --respect-gitignore defaults to true)
+rumdl check --respect-gitignore=false .
 ```
 
 ## Pre-commit Integration
@@ -235,38 +235,85 @@ rumdl <command> [options] [file or directory...]
 
 ### Commands
 
-- `check`: Lint Markdown files and print warnings/errors (main subcommand)
-  - Options:
-    - `-c, --config <file>`: Use custom configuration file
-    - `--fix`: Automatically fix issues where possible
-    - `-l, --list-rules`: List all available rules
-    - `-d, --disable <rules>`: Disable specific rules (comma-separated)
-    - `-e, --enable <rules>`: Enable only specific rules (comma-separated)
-    - `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
-    - `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
-    - `--no-respect-gitignore`: Don't respect .gitignore files
-    - `-v, --verbose`: Show detailed output
-    - `--profile`: Show profiling information
-    - `-q, --quiet`: Suppress all output except errors
-
-- `init`: Create a default `.rumdl.toml` configuration file in the current directory
-  - `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
-
-- `rule [<rule>]`: Show information about a rule or list all rules
-  - If a rule name or ID is provided, shows details for that rule
-  - If no argument is given, lists all available rules
-
-- `config [--defaults]`: Show the full effective configuration (default), or only the defaults.
-  - `--defaults`: Show only the default configuration as TOML.
-  - Subcommands:
-    - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
-
-- `server`: Start the Language Server Protocol server for editor integration
-  - `--port <PORT>`: TCP port to listen on (for debugging)
-  - `--stdio`: Use stdio for communication (default)
-  - `-v, --verbose`: Enable verbose logging
-
-- `version`: Show version information
+#### `check [PATHS...]`
+
+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)
+- `-e, --enable <rules>`: Enable only specific rules (comma-separated)
+- `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
+- `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
+- `--respect-gitignore`: Respect .gitignore files when scanning directories (does not apply to explicitly provided paths)
+- `-v, --verbose`: Show detailed output
+- `--profile`: Show profiling information
+- `-q, --quiet`: Quiet mode
+- `-o, --output <format>`: Output format: `text` (default) or `json`
+- `--stdin`: Read from stdin instead of files
+
+#### `init [OPTIONS]`
+
+Create a default configuration file in the current directory
+
+**Options:**
+- `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
+
+#### `import <FILE> [OPTIONS]`
+
+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
+
+#### `rule [<rule>]`
+
+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]`
+
+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
+
+#### `server [OPTIONS]`
+
+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
+
+#### `version`
+
+Show version information
+
+### Global Options
+
+These options are available for all commands:
+
+- `--color <mode>`: Control colored output: `auto` (default), `always`, `never`
+- `--config <file>`: Path to configuration file
+- `--no-config`: Ignore all configuration files and use built-in defaults
 
 ### Usage Examples
 
@@ -283,6 +330,15 @@ rumdl init
 # Create or update a pyproject.toml file with rumdl configuration
 rumdl init --pyproject
 
+# Import a markdownlint config file
+rumdl import .markdownlint.json
+
+# Convert markdownlint config to JSON format
+rumdl import --format json .markdownlint.yaml --output rumdl-config.json
+
+# Preview conversion without writing file
+rumdl import --dry-run .markdownlint.json
+
 # Show information about a specific rule
 rumdl rule MD013
 
@@ -292,6 +348,24 @@ rumdl rule
 # Query a specific config key
 rumdl config get global.exclude
 
+# Show the path of the loaded configuration file
+rumdl config file
+
+# Show configuration as JSON instead of the default format
+rumdl config --output json
+
+# Lint content from stdin
+echo "# My Heading" | rumdl check --stdin
+
+# Get JSON output for integration with other tools
+rumdl check --output json README.md
+
+# Disable colors in output
+rumdl check --color never README.md
+
+# Use built-in defaults, ignoring all config files
+rumdl check --no-config README.md
+
 # Show version information
 rumdl version
 ```
@@ -303,6 +377,30 @@ rumdl can be configured in several ways:
 1. Using a `.rumdl.toml` file in your project directory
 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.)
+
+### Markdownlint Migration
+
+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`
+
+**Explicit Import**: Convert markdownlint configs to rumdl format:
+```bash
+# Convert to .rumdl.toml
+rumdl import .markdownlint.json
+
+# Convert to JSON format
+rumdl import --format json .markdownlint.yaml --output config.json
+
+# Preview conversion
+rumdl import --dry-run .markdownlint.json
+```
+
+For comprehensive documentation on global settings (file selection, rule enablement, etc.), see our [Global Settings Reference](docs/global-settings.md).
 
 ### Configuration File Example
 
@@ -455,10 +553,12 @@ Run with `--fix` to automatically fix issues
 
 ### Output Format
 
+#### Text Output (Default)
+
 rumdl uses a consistent output format for all issues:
 
 ```text
-{file}:{line}:{column}: [{rule*id}] {message} [{fix*indicator}]
+{file}:{line}:{column}: [{rule_id}] {message} [{fix_indicator}]
 ```
 
 The output is colorized by default:
@@ -470,6 +570,42 @@ The output is colorized by default:
 - Fixable issues are marked with `[*]` in green
 - Fixed issues are marked with `[fixed]` in green
 
+#### JSON Output
+
+For integration with other tools and automation, use `--output json`:
+
+```bash
+rumdl check --output json README.md
+```
+
+This produces structured JSON output:
+
+```json
+{
+  "summary": {
+    "total_files": 1,
+    "files_with_issues": 1,
+    "total_issues": 2,
+    "fixable_issues": 1
+  },
+  "files": [
+    {
+      "path": "README.md",
+      "issues": [
+        {
+          "line": 12,
+          "column": 1,
+          "rule": "MD022",
+          "message": "Headings should be surrounded by blank lines",
+          "fixable": true,
+          "severity": "error"
+        }
+      ]
+    }
+  ]
+}
+```
+
 ## Development
 
 ### Prerequisites

{rumdl-0.0.79 → rumdl-0.0.81}/README.md

@@ -146,8 +146,8 @@ rumdl check --include "docs/*.md,README.md" .
 # Combine include and exclude patterns
 rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 
-# Ignore gitignore rules
-rumdl check --no-respect-gitignore .
+# Don't respect gitignore files (note: --respect-gitignore defaults to true)
+rumdl check --respect-gitignore=false .
 ```
 
 ## Pre-commit Integration
@@ -205,38 +205,85 @@ rumdl <command> [options] [file or directory...]
 
 ### Commands
 
-- `check`: Lint Markdown files and print warnings/errors (main subcommand)
-  - Options:
-    - `-c, --config <file>`: Use custom configuration file
-    - `--fix`: Automatically fix issues where possible
-    - `-l, --list-rules`: List all available rules
-    - `-d, --disable <rules>`: Disable specific rules (comma-separated)
-    - `-e, --enable <rules>`: Enable only specific rules (comma-separated)
-    - `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
-    - `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
-    - `--no-respect-gitignore`: Don't respect .gitignore files
-    - `-v, --verbose`: Show detailed output
-    - `--profile`: Show profiling information
-    - `-q, --quiet`: Suppress all output except errors
-
-- `init`: Create a default `.rumdl.toml` configuration file in the current directory
-  - `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
-
-- `rule [<rule>]`: Show information about a rule or list all rules
-  - If a rule name or ID is provided, shows details for that rule
-  - If no argument is given, lists all available rules
-
-- `config [--defaults]`: Show the full effective configuration (default), or only the defaults.
-  - `--defaults`: Show only the default configuration as TOML.
-  - Subcommands:
-    - `get <key>`: Query a specific config key (e.g. `global.exclude` or `MD013.line_length`)
-
-- `server`: Start the Language Server Protocol server for editor integration
-  - `--port <PORT>`: TCP port to listen on (for debugging)
-  - `--stdio`: Use stdio for communication (default)
-  - `-v, --verbose`: Enable verbose logging
-
-- `version`: Show version information
+#### `check [PATHS...]`
+
+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)
+- `-e, --enable <rules>`: Enable only specific rules (comma-separated)
+- `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
+- `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
+- `--respect-gitignore`: Respect .gitignore files when scanning directories (does not apply to explicitly provided paths)
+- `-v, --verbose`: Show detailed output
+- `--profile`: Show profiling information
+- `-q, --quiet`: Quiet mode
+- `-o, --output <format>`: Output format: `text` (default) or `json`
+- `--stdin`: Read from stdin instead of files
+
+#### `init [OPTIONS]`
+
+Create a default configuration file in the current directory
+
+**Options:**
+- `--pyproject`: Generate configuration for `pyproject.toml` instead of `.rumdl.toml`
+
+#### `import <FILE> [OPTIONS]`
+
+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
+
+#### `rule [<rule>]`
+
+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]`
+
+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
+
+#### `server [OPTIONS]`
+
+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
+
+#### `version`
+
+Show version information
+
+### Global Options
+
+These options are available for all commands:
+
+- `--color <mode>`: Control colored output: `auto` (default), `always`, `never`
+- `--config <file>`: Path to configuration file
+- `--no-config`: Ignore all configuration files and use built-in defaults
 
 ### Usage Examples
 
@@ -253,6 +300,15 @@ rumdl init
 # Create or update a pyproject.toml file with rumdl configuration
 rumdl init --pyproject
 
+# Import a markdownlint config file
+rumdl import .markdownlint.json
+
+# Convert markdownlint config to JSON format
+rumdl import --format json .markdownlint.yaml --output rumdl-config.json
+
+# Preview conversion without writing file
+rumdl import --dry-run .markdownlint.json
+
 # Show information about a specific rule
 rumdl rule MD013
 
@@ -262,6 +318,24 @@ rumdl rule
 # Query a specific config key
 rumdl config get global.exclude
 
+# Show the path of the loaded configuration file
+rumdl config file
+
+# Show configuration as JSON instead of the default format
+rumdl config --output json
+
+# Lint content from stdin
+echo "# My Heading" | rumdl check --stdin
+
+# Get JSON output for integration with other tools
+rumdl check --output json README.md
+
+# Disable colors in output
+rumdl check --color never README.md
+
+# Use built-in defaults, ignoring all config files
+rumdl check --no-config README.md
+
 # Show version information
 rumdl version
 ```
@@ -273,6 +347,30 @@ rumdl can be configured in several ways:
 1. Using a `.rumdl.toml` file in your project directory
 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.)
+
+### Markdownlint Migration
+
+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`
+
+**Explicit Import**: Convert markdownlint configs to rumdl format:
+```bash
+# Convert to .rumdl.toml
+rumdl import .markdownlint.json
+
+# Convert to JSON format
+rumdl import --format json .markdownlint.yaml --output config.json
+
+# Preview conversion
+rumdl import --dry-run .markdownlint.json
+```
+
+For comprehensive documentation on global settings (file selection, rule enablement, etc.), see our [Global Settings Reference](docs/global-settings.md).
 
 ### Configuration File Example
 
@@ -425,10 +523,12 @@ Run with `--fix` to automatically fix issues
 
 ### Output Format
 
+#### Text Output (Default)
+
 rumdl uses a consistent output format for all issues:
 
 ```text
-{file}:{line}:{column}: [{rule*id}] {message} [{fix*indicator}]
+{file}:{line}:{column}: [{rule_id}] {message} [{fix_indicator}]
 ```
 
 The output is colorized by default:
@@ -440,6 +540,42 @@ The output is colorized by default:
 - Fixable issues are marked with `[*]` in green
 - Fixed issues are marked with `[fixed]` in green
 
+#### JSON Output
+
+For integration with other tools and automation, use `--output json`:
+
+```bash
+rumdl check --output json README.md
+```
+
+This produces structured JSON output:
+
+```json
+{
+  "summary": {
+    "total_files": 1,
+    "files_with_issues": 1,
+    "total_issues": 2,
+    "fixable_issues": 1
+  },
+  "files": [
+    {
+      "path": "README.md",
+      "issues": [
+        {
+          "line": 12,
+          "column": 1,
+          "rule": "MD022",
+          "message": "Headings should be surrounded by blank lines",
+          "fixable": true,
+          "severity": "error"
+        }
+      ]
+    }
+  ]
+}
+```
+
 ## Development
 
 ### Prerequisites

{rumdl-0.0.79 → rumdl-0.0.81}/docs/RULES.md

@@ -7,6 +7,8 @@
 rumdl implements 50+ rules for checking Markdown files. This document provides a comprehensive reference of all available rules, organized by category.
 Each rule has a brief description and a link to its detailed documentation.
 
+For information on global configuration settings (file selection, rule enablement, etc.), see the [Global Settings Reference](global-settings.md).
+
 ## Rule Categories
 
 - [Heading Rules](#heading-rules) - Rules related to heading structure and formatting