rumdl 0.0.48__py3-none-macosx_11_0_arm64.whl → 0.0.51__py3-none-macosx_11_0_arm64.whl

{rumdl-0.0.48.dist-info → rumdl-0.0.51.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rumdl
-Version: 0.0.48
+Version: 0.0.51
 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.51.dist-info/RECORD

@@ -0,0 +1,7 @@
+rumdl-0.0.51.dist-info/METADATA,sha256=rq6kXABQC8uhz1fbcOiU3UWdDgy1onqbUCKauK_dS-A,15097
+rumdl-0.0.51.dist-info/WHEEL,sha256=BIHewG3xDASNrCQSw936TG4pT5uL1AnxgJ7f_yNgUy0,101
+python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
+python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
+python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
+rumdl-0.0.51.data/scripts/rumdl,sha256=MGcr4igCvfennK_B9ql7o7m0ZBVX_XWAfVh7IuXsL5w,4756176
+rumdl-0.0.51.dist-info/RECORD,,

rumdl-0.0.48.dist-info/RECORD

@@ -1,7 +0,0 @@
-rumdl-0.0.48.dist-info/METADATA,sha256=Vhs5bN4jkDpP87p73k5Gl0xj0X2neFyf3bPfQm_7-8E,13189
-rumdl-0.0.48.dist-info/WHEEL,sha256=BIHewG3xDASNrCQSw936TG4pT5uL1AnxgJ7f_yNgUy0,101
-python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
-python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
-rumdl-0.0.48.data/scripts/rumdl,sha256=V6BrPlgMk2mh58DpDIryqTYSNW5r81AEfwP0EtfDdgg,4723712
-rumdl-0.0.48.dist-info/RECORD,,