rumdl 0.0.48__tar.gz → 0.0.49__tar.gz

{rumdl-0.0.48 → rumdl-0.0.49}/Cargo.lock

@@ -309,7 +309,7 @@ version = "0.1.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f9d839f2a20b0aee515dc581a6172f2321f96cab76c1a38a4c584a194955390e"
 dependencies = [
- "getrandom 0.2.15",
+ "getrandom 0.2.16",
  "once_cell",
  "tiny-keccak",
 ]
@@ -546,9 +546,9 @@ dependencies = [
 
 [[package]]
 name = "getrandom"
-version = "0.2.15"
+version = "0.2.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c4567c8db10ae91089c99af84c68c38da3ec2f087c3f82960bcdbf3656b6f4d7"
+checksum = "335ff9f135e4384c8150d6f27c6daed433577f86b4750418338c01a1a2528592"
 dependencies = [
  "cfg-if",
  "libc",
@@ -765,9 +765,9 @@ checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94"
 
 [[package]]
 name = "markdown"
-version = "1.0.0-alpha.23"
+version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9047e0a37a596d4e15411a1ffbdabe71c328908cb90a721cb9bf8dcf3434e6d2"
+checksum = "a5cab8f2cadc416a82d2e783a1946388b31654d391d1c7d92cc1f03e295b1deb"
 dependencies = [
  "unicode-id",
 ]
@@ -995,9 +995,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.24.1"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "17da310086b068fbdcefbba30aeb3721d5bb9af8db4987d6735b2183ca567229"
+checksum = "e5203598f366b11a02b13aa20cab591229ff0a89fd121a308a5df751d5fc9219"
 dependencies = [
  "cfg-if",
  "indoc",
@@ -1013,9 +1013,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.24.1"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e27165889bd793000a098bb966adc4300c312497ea25cf7a690a9f0ac5aa5fc1"
+checksum = "99636d423fa2ca130fa5acde3059308006d46f98caac629418e53f7ebb1e9999"
 dependencies = [
  "once_cell",
  "target-lexicon",
@@ -1023,9 +1023,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.24.1"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "05280526e1dbf6b420062f3ef228b78c0c54ba94e157f5cb724a609d0f2faabc"
+checksum = "78f9cf92ba9c409279bc3305b5409d90db2d2c22392d443a87df3a1adad59e33"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -1033,9 +1033,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.24.1"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c3ce5686aa4d3f63359a5100c62a127c9f15e8398e5fdeb5deef1fed5cd5f44"
+checksum = "0b999cb1a6ce21f9a6b147dcf1be9ffedf02e0043aec74dc390f3007047cecd9"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -1045,9 +1045,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.24.1"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f4cf6faa0cbfb0ed08e89beb8103ae9724eb4750e3a78084ba4017cbe94f3855"
+checksum = "822ece1c7e1012745607d5cf0bcb2874769f0f7cb34c4cde03b9358eb9ef911a"
 dependencies = [
  "heck",
  "proc-macro2",
@@ -1124,7 +1124,7 @@ version = "0.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
 dependencies = [
- "getrandom 0.2.15",
+ "getrandom 0.2.16",
 ]
 
 [[package]]
@@ -1208,7 +1208,7 @@ dependencies = [
 
 [[package]]
 name = "rumdl"
-version = "0.0.48"
+version = "0.0.49"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -1380,9 +1380,9 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
 
 [[package]]
 name = "syn"
-version = "2.0.100"
+version = "2.0.101"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b09a44accad81e1ba1cd74a32461ba89dee89095ba17b32f5d03683b1b1fc2a0"
+checksum = "8ce2b7fc941b3a24138a0a7cf8e858bfc6a992e7978a068a5c760deb0ed43caf"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1475,9 +1475,9 @@ dependencies = [
 
 [[package]]
 name = "toml"
-version = "0.8.20"
+version = "0.8.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cd87a5cdd6ffab733b2f74bc4fd7ee5fff6634124999ac278c35fc78c6120148"
+checksum = "900f6c86a685850b1bc9f6223b20125115ee3f31e01207d81655bbcc0aea9231"
 dependencies = [
  "serde",
  "serde_spanned",
@@ -1487,26 +1487,33 @@ dependencies = [
 
 [[package]]
 name = "toml_datetime"
-version = "0.6.8"
+version = "0.6.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0dd7358ecb8fc2f8d014bf86f6f638ce72ba252a2c3a2572f2a795f1d23efb41"
+checksum = "3da5db5a963e24bc68be8b17b6fa82814bb22ee8660f192bb182771d498f09a3"
 dependencies = [
  "serde",
 ]
 
 [[package]]
 name = "toml_edit"
-version = "0.22.24"
+version = "0.22.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "17b4795ff5edd201c7cd6dca065ae59972ce77d1b80fa0a84d94950ece7d1474"
+checksum = "10558ed0bd2a1562e630926a2d1f0b98c827da99fabd3fe20920a59642504485"
 dependencies = [
  "indexmap",
  "serde",
  "serde_spanned",
  "toml_datetime",
+ "toml_write",
  "winnow",
 ]
 
+[[package]]
+name = "toml_write"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "28391a4201ba7eb1984cfeb6862c0b3ea2cfe23332298967c749dddc0d6cd976"
+
 [[package]]
 name = "trim-in-place"
 version = "0.1.7"
@@ -1775,9 +1782,9 @@ checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
 
 [[package]]
 name = "winnow"
-version = "0.7.6"
+version = "0.7.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "63d3fcd9bba44b03821e7d699eeee959f3126dcc4aa8e4ae18ec617c2a5cea10"
+checksum = "6cb8234a863ea0e8cd7284fcdd4f145233eb00fee02bbdd9861aec44e6477bc5"
 dependencies = [
  "memchr",
 ]
@@ -1810,18 +1817,18 @@ checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049"
 
 [[package]]
 name = "zerocopy"
-version = "0.8.24"
+version = "0.8.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2586fea28e186957ef732a5f8b3be2da217d65c5969d4b1e17f973ebbe876879"
+checksum = "a1702d9583232ddb9174e01bb7c15a2ab8fb1bc6f227aa1233858c351a3ba0cb"
 dependencies = [
  "zerocopy-derive",
 ]
 
 [[package]]
 name = "zerocopy-derive"
-version = "0.8.24"
+version = "0.8.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a996a8f63c5c4448cd959ac1bab0aaa3306ccfd060472f85943ee0750f0169be"
+checksum = "28a6e20d751156648aa063f3800b706ee209a32c0b4d9f24be3d980b01be55ef"
 dependencies = [
  "proc-macro2",
  "quote",

{rumdl-0.0.48 → rumdl-0.0.49}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rumdl"
-version = "0.0.48"
+version = "0.0.49"
 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.48 → rumdl-0.0.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.48
+Version: 0.0.49
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -63,12 +63,14 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
-    - [Options (for `check`)](#options-for-check)
-    - [Example Help Output](#example-help-output)
+    - [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)
+      - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
   - [Output Style](#output-style)
     - [Output Format](#output-format)
   - [Development](#development)
@@ -233,43 +235,59 @@ 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
 
-### Options (for `check`)
+- `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`)
 
-- `-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)
-- `--respect-gitignore`: Respect .gitignore files when scanning directories (default: true)
-- `--no-respect-gitignore`: Don't respect .gitignore files (same as --ignore-gitignore)
-- `-v, --verbose`: Show detailed output
-- `--profile`: Show profiling information
-- `-q, --quiet`: Suppress all output except errors
+- `version`: Show version information
 
-### Example Help Output
+### Usage Examples
 
 ```bash
-rumdl --help
+# Lint all Markdown files in the current directory
+rumdl check .
+
+# Automatically fix issues
+rumdl check --fix .
+
+# Create a default configuration file
+rumdl init
+
+# Create or update a pyproject.toml file with rumdl configuration
+rumdl init --pyproject
 
-Usage: rumdl <COMMAND> [OPTIONS] [PATHS...]
+# Show information about a specific rule
+rumdl rule MD013
 
-Commands:
-  check    Lint Markdown files and print warnings/errors
-  init     Create a default configuration file
+# List all available rules
+rumdl rule
 
-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
+# Query a specific config key
+rumdl config get global.exclude
 
-If no command is given, 'check' is assumed (deprecated).
+# Show version information
+rumdl version
 ```
 
 ## Configuration
@@ -349,6 +367,51 @@ names = ["rumdl", "Markdown", "GitHub"]
 
 Both kebab-case (`line-length`, `ignore-gitignore`) and snake_case (`line_length`, `ignore_gitignore`) formats are supported for compatibility with different Python tooling conventions.
 
+### Configuration Output
+
+#### Effective Configuration (`rumdl config`)
+
+The `rumdl config` command prints the **full effective configuration** (defaults + all overrides), showing every key and its value, annotated with the source of each value. The output is colorized and the `[from ...]` annotation is globally aligned for easy scanning.
+
+**Example output:**
+
+```text
+[global]
+  enable             = []                             [from default]
+  disable            = ["MD033"]                      [from .rumdl.toml]
+  include            = ["README.md"]                  [from .rumdl.toml]
+  respect_gitignore  = true                           [from .rumdl.toml]
+
+[MD013]
+  line_length        = 200                            [from .rumdl.toml]
+  code_blocks        = true                           [from .rumdl.toml]
+  ...
+```
+- **Keys** are cyan, **values** are yellow, and the `[from ...]` annotation is colored by source:
+  - Green: CLI
+  - Blue: `.rumdl.toml`
+  - Magenta: `pyproject.toml`
+  - Yellow: default
+- The `[from ...]` column is aligned across all sections.
+
+#### Defaults Only (`rumdl config --defaults`)
+
+The `--defaults` flag prints only the default configuration as TOML, suitable for copy-paste or reference:
+
+```toml
+[global]
+enable = []
+disable = []
+exclude = []
+include = []
+respect_gitignore = true
+
+[MD013]
+line_length = 80
+code_blocks = true
+...
+```
+
 ## Output Style
 
 rumdl produces clean, colorized output similar to modern linting tools:

{rumdl-0.0.48 → rumdl-0.0.49}/README.md

@@ -33,12 +33,14 @@
   - [Rules](#rules)
   - [Command-line Interface](#command-line-interface)
     - [Commands](#commands)
-    - [Options (for `check`)](#options-for-check)
-    - [Example Help Output](#example-help-output)
+    - [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)
+      - [Defaults Only (`rumdl config --defaults`)](#defaults-only-rumdl-config---defaults)
   - [Output Style](#output-style)
     - [Output Format](#output-format)
   - [Development](#development)
@@ -203,43 +205,59 @@ 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
 
-### Options (for `check`)
+- `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`)
 
-- `-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)
-- `--respect-gitignore`: Respect .gitignore files when scanning directories (default: true)
-- `--no-respect-gitignore`: Don't respect .gitignore files (same as --ignore-gitignore)
-- `-v, --verbose`: Show detailed output
-- `--profile`: Show profiling information
-- `-q, --quiet`: Suppress all output except errors
+- `version`: Show version information
 
-### Example Help Output
+### Usage Examples
 
 ```bash
-rumdl --help
+# Lint all Markdown files in the current directory
+rumdl check .
+
+# Automatically fix issues
+rumdl check --fix .
+
+# Create a default configuration file
+rumdl init
+
+# Create or update a pyproject.toml file with rumdl configuration
+rumdl init --pyproject
 
-Usage: rumdl <COMMAND> [OPTIONS] [PATHS...]
+# Show information about a specific rule
+rumdl rule MD013
 
-Commands:
-  check    Lint Markdown files and print warnings/errors
-  init     Create a default configuration file
+# List all available rules
+rumdl rule
 
-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
+# Query a specific config key
+rumdl config get global.exclude
 
-If no command is given, 'check' is assumed (deprecated).
+# Show version information
+rumdl version
 ```
 
 ## Configuration
@@ -319,6 +337,51 @@ names = ["rumdl", "Markdown", "GitHub"]
 
 Both kebab-case (`line-length`, `ignore-gitignore`) and snake_case (`line_length`, `ignore_gitignore`) formats are supported for compatibility with different Python tooling conventions.
 
+### Configuration Output
+
+#### Effective Configuration (`rumdl config`)
+
+The `rumdl config` command prints the **full effective configuration** (defaults + all overrides), showing every key and its value, annotated with the source of each value. The output is colorized and the `[from ...]` annotation is globally aligned for easy scanning.
+
+**Example output:**
+
+```text
+[global]
+  enable             = []                             [from default]
+  disable            = ["MD033"]                      [from .rumdl.toml]
+  include            = ["README.md"]                  [from .rumdl.toml]
+  respect_gitignore  = true                           [from .rumdl.toml]
+
+[MD013]
+  line_length        = 200                            [from .rumdl.toml]
+  code_blocks        = true                           [from .rumdl.toml]
+  ...
+```
+- **Keys** are cyan, **values** are yellow, and the `[from ...]` annotation is colored by source:
+  - Green: CLI
+  - Blue: `.rumdl.toml`
+  - Magenta: `pyproject.toml`
+  - Yellow: default
+- The `[from ...]` column is aligned across all sections.
+
+#### Defaults Only (`rumdl config --defaults`)
+
+The `--defaults` flag prints only the default configuration as TOML, suitable for copy-paste or reference:
+
+```toml
+[global]
+enable = []
+disable = []
+exclude = []
+include = []
+respect_gitignore = true
+
+[MD013]
+line_length = 80
+code_blocks = true
+...
+```
+
 ## Output Style
 
 rumdl produces clean, colorized output similar to modern linting tools: