rumdl 0.0.132__py3-none-musllinux_1_2_x86_64.whl → 0.0.135__py3-none-musllinux_1_2_x86_64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of rumdl might be problematic. Click here for more details.
- {rumdl-0.0.132.data → rumdl-0.0.135.data}/scripts/rumdl +0 -0
- {rumdl-0.0.132.dist-info → rumdl-0.0.135.dist-info}/METADATA +46 -18
- rumdl-0.0.135.dist-info/RECORD +8 -0
- rumdl-0.0.132.dist-info/RECORD +0 -8
- {rumdl-0.0.132.dist-info → rumdl-0.0.135.dist-info}/WHEEL +0 -0
- {rumdl-0.0.132.dist-info → rumdl-0.0.135.dist-info}/licenses/LICENSE +0 -0
|
Binary file
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: rumdl
|
|
3
|
-
Version: 0.0.
|
|
3
|
+
Version: 0.0.135
|
|
4
4
|
Classifier: Development Status :: 4 - Beta
|
|
5
5
|
Classifier: Environment :: Console
|
|
6
6
|
Classifier: Intended Audience :: Developers
|
|
@@ -34,11 +34,8 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
|
|
|
34
34
|

|
|
35
35
|
|
|
36
36
|
[](https://github.com/rvben/rumdl/actions)
|
|
37
|
-
[](https://opensource.org/licenses/MIT)
|
|
38
|
-
[](https://pypi.org/project/rumdl/)
|
|
40
|
-
[](https://github.com/rvben/rumdl/releases/latest)
|
|
41
|
-
[](https://github.com/rvben/rumdl/stargazers)
|
|
37
|
+
[](https://opensource.org/licenses/MIT) [](https://crates.io/crates/rumdl)
|
|
38
|
+
[](https://pypi.org/project/rumdl/) [](https://github.com/rvben/rumdl/releases/latest) [](https://github.com/rvben/rumdl/stargazers)
|
|
42
39
|
|
|
43
40
|
## A modern Markdown linter and formatter, built for speed with Rust
|
|
44
41
|
|
|
@@ -65,9 +62,8 @@ rumdl init
|
|
|
65
62
|
|
|
66
63
|
## Overview
|
|
67
64
|
|
|
68
|
-
rumdl is a high-performance Markdown linter and formatter that helps ensure consistency and best practices
|
|
69
|
-
|
|
70
|
-
rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
|
|
65
|
+
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
|
|
66
|
+
Python linting, rumdl brings similar speed and developer experience improvements to the Markdown ecosystem.
|
|
71
67
|
|
|
72
68
|
It offers:
|
|
73
69
|
|
|
@@ -206,7 +202,8 @@ The extension provides:
|
|
|
206
202
|
- 📋 Hover tooltips with rule documentation
|
|
207
203
|
- ⚡ Lightning-fast performance with zero lag
|
|
208
204
|
|
|
209
|
-
The CLI will automatically detect VS Code, Cursor, or Windsurf and install the appropriate extension. See the
|
|
205
|
+
The CLI will automatically detect VS Code, Cursor, or Windsurf and install the appropriate extension. See the
|
|
206
|
+
[VS Code extension documentation](https://github.com/rvben/rumdl/blob/main/docs/vscode-extension.md) for more details.
|
|
210
207
|
|
|
211
208
|
## Usage
|
|
212
209
|
|
|
@@ -252,6 +249,9 @@ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
|
|
|
252
249
|
|
|
253
250
|
# Don't respect gitignore files (note: --respect-gitignore defaults to true)
|
|
254
251
|
rumdl check --respect-gitignore=false .
|
|
252
|
+
|
|
253
|
+
# Force exclude patterns even for explicitly specified files (useful for pre-commit)
|
|
254
|
+
rumdl check excluded.md --force-exclude # Will respect exclude patterns in config
|
|
255
255
|
```
|
|
256
256
|
|
|
257
257
|
### Stdin/Stdout Formatting
|
|
@@ -313,6 +313,33 @@ repos:
|
|
|
313
313
|
|
|
314
314
|
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.
|
|
315
315
|
|
|
316
|
+
### Excluding Files in Pre-commit
|
|
317
|
+
|
|
318
|
+
By default, when pre-commit passes files explicitly to rumdl, the exclude patterns in your `.rumdl.toml` configuration file are ignored. This is intentional behavior - if you explicitly specify a
|
|
319
|
+
file, it gets checked.
|
|
320
|
+
|
|
321
|
+
However, for pre-commit workflows where you want to exclude certain files even when they're passed explicitly, you have two options:
|
|
322
|
+
|
|
323
|
+
1. **Use `force_exclude` in your configuration file:**
|
|
324
|
+
|
|
325
|
+
```toml
|
|
326
|
+
# .rumdl.toml
|
|
327
|
+
[global]
|
|
328
|
+
exclude = ["generated/*.md", "vendor/**"]
|
|
329
|
+
force_exclude = true # Enforce excludes even for explicitly provided files
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
2. **Use the `--force-exclude` flag in your pre-commit config:**
|
|
333
|
+
|
|
334
|
+
```yaml
|
|
335
|
+
repos:
|
|
336
|
+
- repo: https://github.com/rvben/rumdl-pre-commit
|
|
337
|
+
rev: v0.0.99
|
|
338
|
+
hooks:
|
|
339
|
+
- id: rumdl
|
|
340
|
+
args: [--force-exclude] # Respect exclude patterns from config
|
|
341
|
+
```
|
|
342
|
+
|
|
316
343
|
## CI/CD Integration
|
|
317
344
|
|
|
318
345
|
### GitHub Actions
|
|
@@ -373,6 +400,7 @@ Lint Markdown files and print warnings/errors (main subcommand)
|
|
|
373
400
|
- `--exclude <patterns>`: Exclude specific files or directories (comma-separated glob patterns)
|
|
374
401
|
- `--include <patterns>`: Include only specific files or directories (comma-separated glob patterns)
|
|
375
402
|
- `--respect-gitignore`: Respect .gitignore files when scanning directories (does not apply to explicitly provided paths)
|
|
403
|
+
- `--force-exclude`: Enforce exclude patterns even for explicitly specified files (useful for pre-commit hooks)
|
|
376
404
|
- `-v, --verbose`: Show detailed output
|
|
377
405
|
- `--profile`: Show profiling information
|
|
378
406
|
- `--statistics`: Show rule violation statistics summary
|
|
@@ -569,9 +597,8 @@ rumdl can be configured in several ways:
|
|
|
569
597
|
|
|
570
598
|
### Configuration Discovery
|
|
571
599
|
|
|
572
|
-
rumdl automatically searches for configuration files by traversing up the directory tree from the current
|
|
573
|
-
|
|
574
|
-
subdirectory of your project and it will find the configuration file at the project root.
|
|
600
|
+
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
|
|
601
|
+
run rumdl from any subdirectory of your project and it will find the configuration file at the project root.
|
|
575
602
|
|
|
576
603
|
The search follows these rules:
|
|
577
604
|
- Searches upward for `.rumdl.toml`, `rumdl.toml`, or `pyproject.toml` (with `[tool.rumdl]` section)
|
|
@@ -624,13 +651,13 @@ indent = 2
|
|
|
624
651
|
|
|
625
652
|
rumdl provides seamless compatibility with existing markdownlint configurations:
|
|
626
653
|
|
|
627
|
-
**Automatic Discovery**: rumdl automatically detects and loads markdownlint config files:
|
|
654
|
+
** Automatic Discovery**: rumdl automatically detects and loads markdownlint config files:
|
|
628
655
|
|
|
629
656
|
- `.markdownlint.json` / `.markdownlint.jsonc`
|
|
630
657
|
- `.markdownlint.yaml` / `.markdownlint.yml`
|
|
631
658
|
- `markdownlint.json` / `markdownlint.yaml`
|
|
632
659
|
|
|
633
|
-
**Explicit Import**: Convert markdownlint configs to rumdl format:
|
|
660
|
+
** Explicit Import**: Convert markdownlint configs to rumdl format:
|
|
634
661
|
|
|
635
662
|
```bash
|
|
636
663
|
# Convert to .rumdl.toml
|
|
@@ -718,8 +745,8 @@ Both kebab-case (`line-length`, `ignore-gitignore`) and snake_case (`line_length
|
|
|
718
745
|
|
|
719
746
|
#### Effective Configuration (`rumdl config`)
|
|
720
747
|
|
|
721
|
-
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.
|
|
722
|
-
|
|
748
|
+
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
|
|
749
|
+
the `[from ...]` annotation is globally aligned for easy scanning.
|
|
723
750
|
|
|
724
751
|
#### Example output
|
|
725
752
|
|
|
@@ -736,7 +763,7 @@ The output is colorized and the `[from ...]` annotation is globally aligned for
|
|
|
736
763
|
...
|
|
737
764
|
```
|
|
738
765
|
|
|
739
|
-
- **Keys** are cyan, **values** are yellow, and the `[from ...]` annotation is colored by source:
|
|
766
|
+
- ** Keys** are cyan, **values** are yellow, and the `[from ...]` annotation is colored by source:
|
|
740
767
|
- Green: CLI
|
|
741
768
|
- Blue: `.rumdl.toml`
|
|
742
769
|
- Magenta: `pyproject.toml`
|
|
@@ -754,6 +781,7 @@ disable = []
|
|
|
754
781
|
exclude = []
|
|
755
782
|
include = []
|
|
756
783
|
respect_gitignore = true
|
|
784
|
+
force_exclude = false # Set to true to exclude files even when explicitly specified
|
|
757
785
|
|
|
758
786
|
[MD013]
|
|
759
787
|
line_length = 80
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
|
|
2
|
+
python/rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
|
|
3
|
+
python/rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
rumdl-0.0.135.data/scripts/rumdl,sha256=D9Iwrm2nP2xiZRcw6aFXu07tbfEWps9UUDSw-vbUi_w,6318872
|
|
5
|
+
rumdl-0.0.135.dist-info/METADATA,sha256=vFj7n_0HOO0Xavr1WZ1qF5gf2XLAPdAfaR1A3sLoUQo,27307
|
|
6
|
+
rumdl-0.0.135.dist-info/WHEEL,sha256=65ETeUr_DgHPjIWfgTjvPCTyYsbLKOg286hWVS2njmw,104
|
|
7
|
+
rumdl-0.0.135.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
|
|
8
|
+
rumdl-0.0.135.dist-info/RECORD,,
|
rumdl-0.0.132.dist-info/RECORD
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
|
|
2
|
-
python/rumdl/__main__.py,sha256=6JiDzauqRloCD8LQ_edF-T_RHmoiTWLyMvHjqARL05s,1879
|
|
3
|
-
python/rumdl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
-
rumdl-0.0.132.data/scripts/rumdl,sha256=bYrsv91IUoujFEiSxP2nKQYM0xqV7C-X9RA7G5TTZ2s,6293960
|
|
5
|
-
rumdl-0.0.132.dist-info/METADATA,sha256=agG7dgrJ7Xw_vFG8rlSm0FYXNC5eVACIMAT4Hrsi4Lw,26037
|
|
6
|
-
rumdl-0.0.132.dist-info/WHEEL,sha256=65ETeUr_DgHPjIWfgTjvPCTyYsbLKOg286hWVS2njmw,104
|
|
7
|
-
rumdl-0.0.132.dist-info/licenses/LICENSE,sha256=Ux7uE0WuoLktCyy3w5lLIz3_6dc47R0qauPN30mz13M,1079
|
|
8
|
-
rumdl-0.0.132.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|