rumdl 0.0.43__tar.gz → 0.0.46__tar.gz

{rumdl-0.0.43 → rumdl-0.0.46}/Cargo.lock

@@ -1208,7 +1208,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.43"
+version = "0.0.46"
 dependencies = [
  "anyhow",
  "assert_cmd",

{rumdl-0.0.43 → rumdl-0.0.46}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.43"
+version = "0.0.46"
 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.43 → rumdl-0.0.46}/Makefile

@@ -13,9 +13,12 @@ fmt:
 	cargo fmt
 	cargo clippy --fix --allow-dirty --allow-staged
 
+lint:
+	cargo clippy --all-targets --all-features -- -D warnings
+
 check:
-	cargo check
-	cargo clippy
+	cargo check --all-targets --all-features
+
 
 doc:
 	cargo doc --no-deps

{rumdl-0.0.43 → rumdl-0.0.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.43
+Version: 0.0.46
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -62,7 +62,8 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
-    - [Options](#options)
+    - [Options (for `check`)](#options-for-check)
+    - [Example Help Output](#example-help-output)
   - [Configuration](#configuration)
     - [Configuration File Example](#configuration-file-example)
     - [Initializing Configuration](#initializing-configuration)
@@ -82,11 +83,11 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
 # Install using Cargo
 cargo install rumdl
 
-# Check Markdown files in the current directory
-rumdl .
+# Lint Markdown files in the current directory
+rumdl check .
 
 # Automatically fix issues
-rumdl --fix .
+rumdl check --fix .
 
 # Create a default configuration file
 rumdl init
@@ -138,14 +139,14 @@ Expand-Archive -Path "rumdl.zip" -DestinationPath "$env:USERPROFILE\.rumdl"
 Getting started with rumdl is simple:
 
 ```bash
-# Check a single file
-rumdl README.md
+# Lint a single file
+rumdl check README.md
 
-# Check all Markdown files in current directory and subdirectories
-rumdl .
+# Lint all Markdown files in current directory and subdirectories
+rumdl check .
 
 # Automatically fix issues
-rumdl --fix README.md
+rumdl check --fix README.md
 
 # Create a default configuration file
 rumdl init
@@ -154,26 +155,26 @@ rumdl init
 Common usage examples:
 
 ```bash
-# Check with custom configuration
-rumdl --config my-config.toml docs/
+# Lint with custom configuration
+rumdl check --config my-config.toml docs/
 
 # Disable specific rules
-rumdl --disable MD013,MD033 README.md
+rumdl check --disable MD013,MD033 README.md
 
 # Enable only specific rules
-rumdl --enable MD001,MD003 README.md
+rumdl check --enable MD001,MD003 README.md
 
 # Exclude specific files/directories
-rumdl --exclude "node_modules,dist" .
+rumdl check --exclude "node_modules,dist" .
 
 # Include only specific files/directories
-rumdl --include "docs/*.md,README.md" .
+rumdl check --include "docs/*.md,README.md" .
 
 # Combine include and exclude patterns
-rumdl --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
+rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 
 # Ignore gitignore rules
-rumdl --no-respect-gitignore .
+rumdl check --no-respect-gitignore .
 ```
 
 ## Rules
@@ -199,18 +200,18 @@ rumdl --list-rules
 ## Command-line Interface
 
 ```bash
-rumdl [options] [file or directory...]
-rumdl <command> [options]
+rumdl <command> [options] [file or directory...]
 ```
 
 ### Commands
 
+- `check`: Lint Markdown files and print warnings/errors (main subcommand)
 - `init`: Create a default `.rumdl.toml` configuration file in the current directory
 
-### Options
+### Options (for `check`)
 
 - `-c, --config <file>`: Use custom configuration file
-- `-f, --fix`: Automatically fix issues where possible
+- `--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)
@@ -218,8 +219,31 @@ rumdl <command> [options]
 - `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
 - `--respect-gitignore`: Respect .gitignore files when scanning directories (default: true)
 - `--no-respect-gitignore`: Don't respect .gitignore files (same as --ignore-gitignore)
-- `--ignore-gitignore`: Ignore .gitignore files when scanning directories (deprecated, use --no-respect-gitignore)
 - `-v, --verbose`: Show detailed output
+- `--profile`: Show profiling information
+- `-q, --quiet`: Suppress all output except errors
+
+### Example Help Output
+
+```bash
+rumdl --help
+
+Usage: rumdl <COMMAND> [OPTIONS] [PATHS...]
+
+Commands:
+  check    Lint Markdown files and print warnings/errors
+  init     Create a default configuration file
+
+Options (for 'check' subcommand):
+  --fix                  Automatically fix fixable issues
+  --rules <RULES>        Comma-separated list of rules to enable
+  --config <FILE>        Path to configuration file
+  --format <FORMAT>      Output format (default: text)
+  --help                 Print help information
+  --version              Print version information
+
+If no command is given, 'check' is assumed (deprecated).
+```
 
 ## Configuration
 
@@ -369,23 +393,30 @@ make test
 
 ## Using rumdl with pre-commit
 
-You can use `rumdl` as a pre-commit hook in your own projects to check your Markdown files.
+You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
+
+The recommended way is to use the official pre-commit hook repository:
+
+https://github.com/rvben/rumdl-pre-commit
 
 Add the following to your `.pre-commit-config.yaml`:
 
 ```yaml
 repos:
--   repo: https://github.com/rvben/rumdl
-    rev: v0.0.43  # Use the latest release tag
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.0.45  # Use the latest release tag
     hooks:
-    -   id: rumdl-check  # Just check for issues
-    # Or use rumdl-fix to automatically fix issues:
-    # -   id: rumdl-fix
+      - id: rumdl
+        # To only check (default):
+        # args: []
+        # To automatically fix issues:
+        # args: [--fix]
 ```
 
-Then run `pre-commit install`.
+- By default, the hook will only check for issues.
+- To automatically fix issues, add `args: [--fix]` to the hook configuration.
 
-Pre-commit will automatically download and install `rumdl` using `cargo`. `rumdl` will respect any `.rumdl.toml` or `pyproject.toml` configuration file present in your repository.
+When you run `pre-commit install` or `pre-commit run`, pre-commit will automatically install `rumdl` in an isolated Python environment using pip. You do **not** need to install rumdl manually.
 
 ## License
 

{rumdl-0.0.43 → rumdl-0.0.46}/README.md

@@ -32,7 +32,8 @@
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
-    - [Options](#options)
+    - [Options (for `check`)](#options-for-check)
+    - [Example Help Output](#example-help-output)
   - [Configuration](#configuration)
     - [Configuration File Example](#configuration-file-example)
     - [Initializing Configuration](#initializing-configuration)
@@ -52,11 +53,11 @@
 # Install using Cargo
 cargo install rumdl
 
-# Check Markdown files in the current directory
-rumdl .
+# Lint Markdown files in the current directory
+rumdl check .
 
 # Automatically fix issues
-rumdl --fix .
+rumdl check --fix .
 
 # Create a default configuration file
 rumdl init
@@ -108,14 +109,14 @@ Expand-Archive -Path "rumdl.zip" -DestinationPath "$env:USERPROFILE\.rumdl"
 Getting started with rumdl is simple:
 
 ```bash
-# Check a single file
-rumdl README.md
+# Lint a single file
+rumdl check README.md
 
-# Check all Markdown files in current directory and subdirectories
-rumdl .
+# Lint all Markdown files in current directory and subdirectories
+rumdl check .
 
 # Automatically fix issues
-rumdl --fix README.md
+rumdl check --fix README.md
 
 # Create a default configuration file
 rumdl init
@@ -124,26 +125,26 @@ rumdl init
 Common usage examples:
 
 ```bash
-# Check with custom configuration
-rumdl --config my-config.toml docs/
+# Lint with custom configuration
+rumdl check --config my-config.toml docs/
 
 # Disable specific rules
-rumdl --disable MD013,MD033 README.md
+rumdl check --disable MD013,MD033 README.md
 
 # Enable only specific rules
-rumdl --enable MD001,MD003 README.md
+rumdl check --enable MD001,MD003 README.md
 
 # Exclude specific files/directories
-rumdl --exclude "node_modules,dist" .
+rumdl check --exclude "node_modules,dist" .
 
 # Include only specific files/directories
-rumdl --include "docs/*.md,README.md" .
+rumdl check --include "docs/*.md,README.md" .
 
 # Combine include and exclude patterns
-rumdl --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
+rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
 
 # Ignore gitignore rules
-rumdl --no-respect-gitignore .
+rumdl check --no-respect-gitignore .
 ```
 
 ## Rules
@@ -169,18 +170,18 @@ rumdl --list-rules
 ## Command-line Interface
 
 ```bash
-rumdl [options] [file or directory...]
-rumdl <command> [options]
+rumdl <command> [options] [file or directory...]
 ```
 
 ### Commands
 
+- `check`: Lint Markdown files and print warnings/errors (main subcommand)
 - `init`: Create a default `.rumdl.toml` configuration file in the current directory
 
-### Options
+### Options (for `check`)
 
 - `-c, --config <file>`: Use custom configuration file
-- `-f, --fix`: Automatically fix issues where possible
+- `--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)
@@ -188,8 +189,31 @@ rumdl <command> [options]
 - `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
 - `--respect-gitignore`: Respect .gitignore files when scanning directories (default: true)
 - `--no-respect-gitignore`: Don't respect .gitignore files (same as --ignore-gitignore)
-- `--ignore-gitignore`: Ignore .gitignore files when scanning directories (deprecated, use --no-respect-gitignore)
 - `-v, --verbose`: Show detailed output
+- `--profile`: Show profiling information
+- `-q, --quiet`: Suppress all output except errors
+
+### Example Help Output
+
+```bash
+rumdl --help
+
+Usage: rumdl <COMMAND> [OPTIONS] [PATHS...]
+
+Commands:
+  check    Lint Markdown files and print warnings/errors
+  init     Create a default configuration file
+
+Options (for 'check' subcommand):
+  --fix                  Automatically fix fixable issues
+  --rules <RULES>        Comma-separated list of rules to enable
+  --config <FILE>        Path to configuration file
+  --format <FORMAT>      Output format (default: text)
+  --help                 Print help information
+  --version              Print version information
+
+If no command is given, 'check' is assumed (deprecated).
+```
 
 ## Configuration
 
@@ -339,23 +363,30 @@ make test
 
 ## Using rumdl with pre-commit
 
-You can use `rumdl` as a pre-commit hook in your own projects to check your Markdown files.
+You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
+
+The recommended way is to use the official pre-commit hook repository:
+
+https://github.com/rvben/rumdl-pre-commit
 
 Add the following to your `.pre-commit-config.yaml`:
 
 ```yaml
 repos:
--   repo: https://github.com/rvben/rumdl
-    rev: v0.0.43  # Use the latest release tag
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.0.45  # Use the latest release tag
     hooks:
-    -   id: rumdl-check  # Just check for issues
-    # Or use rumdl-fix to automatically fix issues:
-    # -   id: rumdl-fix
+      - id: rumdl
+        # To only check (default):
+        # args: []
+        # To automatically fix issues:
+        # args: [--fix]
 ```
 
-Then run `pre-commit install`.
+- By default, the hook will only check for issues.
+- To automatically fix issues, add `args: [--fix]` to the hook configuration.
 
-Pre-commit will automatically download and install `rumdl` using `cargo`. `rumdl` will respect any `.rumdl.toml` or `pyproject.toml` configuration file present in your repository.
+When you run `pre-commit install` or `pre-commit run`, pre-commit will automatically install `rumdl` in an isolated Python environment using pip. You do **not** need to install rumdl manually.
 
 ## License