rumdl 0.0.46__py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl → 0.0.48__py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.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.
|
Binary file
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: rumdl
|
|
3
|
-
Version: 0.0.
|
|
3
|
+
Version: 0.0.48
|
|
4
4
|
Classifier: Development Status :: 4 - Beta
|
|
5
5
|
Classifier: Environment :: Console
|
|
6
6
|
Classifier: Intended Audience :: Developers
|
|
@@ -59,6 +59,7 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
|
|
|
59
59
|
- [Using pip (Python)](#using-pip-python)
|
|
60
60
|
- [Download binary](#download-binary)
|
|
61
61
|
- [Usage](#usage)
|
|
62
|
+
- [Pre-commit Integration](#pre-commit-integration)
|
|
62
63
|
- [Rules](#rules)
|
|
63
64
|
- [Command-line Interface](#command-line-interface)
|
|
64
65
|
- [Commands](#commands)
|
|
@@ -74,7 +75,6 @@ Project-URL: Repository, https://github.com/rvben/rumdl.git
|
|
|
74
75
|
- [Prerequisites](#prerequisites)
|
|
75
76
|
- [Building](#building)
|
|
76
77
|
- [Testing](#testing)
|
|
77
|
-
- [Using rumdl with pre-commit](#using-rumdl-with-pre-commit)
|
|
78
78
|
- [License](#license)
|
|
79
79
|
|
|
80
80
|
## Quick Start
|
|
@@ -177,6 +177,33 @@ rumdl check --include "docs/**/*.md" --exclude "docs/temp,docs/drafts" .
|
|
|
177
177
|
rumdl check --no-respect-gitignore .
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
+
## Pre-commit Integration
|
|
181
|
+
|
|
182
|
+
You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
|
|
183
|
+
|
|
184
|
+
The recommended way is to use the official pre-commit hook repository:
|
|
185
|
+
|
|
186
|
+
[rumdl-pre-commit repository](https://github.com/rvben/rumdl-pre-commit)
|
|
187
|
+
|
|
188
|
+
Add the following to your `.pre-commit-config.yaml`:
|
|
189
|
+
|
|
190
|
+
```yaml
|
|
191
|
+
repos:
|
|
192
|
+
- repo: https://github.com/rvben/rumdl-pre-commit
|
|
193
|
+
rev: v0.0.45 # Use the latest release tag
|
|
194
|
+
hooks:
|
|
195
|
+
- id: rumdl
|
|
196
|
+
# To only check (default):
|
|
197
|
+
# args: []
|
|
198
|
+
# To automatically fix issues:
|
|
199
|
+
# args: [--fix]
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
- By default, the hook will only check for issues.
|
|
203
|
+
- To automatically fix issues, add `args: [--fix]` to the hook configuration.
|
|
204
|
+
|
|
205
|
+
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.
|
|
206
|
+
|
|
180
207
|
## Rules
|
|
181
208
|
|
|
182
209
|
rumdl implements over 50 lint rules for Markdown files. Here are some key rule categories:
|
|
@@ -391,33 +418,6 @@ make build
|
|
|
391
418
|
make test
|
|
392
419
|
```
|
|
393
420
|
|
|
394
|
-
## Using rumdl with pre-commit
|
|
395
|
-
|
|
396
|
-
You can use `rumdl` as a pre-commit hook to check and fix your Markdown files.
|
|
397
|
-
|
|
398
|
-
The recommended way is to use the official pre-commit hook repository:
|
|
399
|
-
|
|
400
|
-
https://github.com/rvben/rumdl-pre-commit
|
|
401
|
-
|
|
402
|
-
Add the following to your `.pre-commit-config.yaml`:
|
|
403
|
-
|
|
404
|
-
```yaml
|
|
405
|
-
repos:
|
|
406
|
-
- repo: https://github.com/rvben/rumdl-pre-commit
|
|
407
|
-
rev: v0.0.45 # Use the latest release tag
|
|
408
|
-
hooks:
|
|
409
|
-
- id: rumdl
|
|
410
|
-
# To only check (default):
|
|
411
|
-
# args: []
|
|
412
|
-
# To automatically fix issues:
|
|
413
|
-
# args: [--fix]
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
- By default, the hook will only check for issues.
|
|
417
|
-
- To automatically fix issues, add `args: [--fix]` to the hook configuration.
|
|
418
|
-
|
|
419
|
-
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.
|
|
420
|
-
|
|
421
421
|
## License
|
|
422
422
|
|
|
423
423
|
rumdl is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
rumdl-0.0.48.dist-info/METADATA,sha256=Vhs5bN4jkDpP87p73k5Gl0xj0X2neFyf3bPfQm_7-8E,13189
|
|
2
|
+
rumdl-0.0.48.dist-info/WHEEL,sha256=51wrJzNa3JMMGHaPe1sLM9VZUn2xONntEjhUwRqgxpg,128
|
|
3
|
+
python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
|
|
4
|
+
python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
|
|
5
|
+
python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
|
|
6
|
+
rumdl-0.0.48.data/scripts/rumdl,sha256=_YdKtfib_Ih1tdYzJbZnDVi7BXgMG_a8Jd09arniraA,4984808
|
|
7
|
+
rumdl-0.0.48.dist-info/RECORD,,
|
rumdl-0.0.46.dist-info/RECORD
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
rumdl-0.0.46.dist-info/METADATA,sha256=inXL6dAzWE9m6K6_iM2tl6ssCqRriJb-Gcq00bXxDGA,13173
|
|
2
|
-
rumdl-0.0.46.dist-info/WHEEL,sha256=51wrJzNa3JMMGHaPe1sLM9VZUn2xONntEjhUwRqgxpg,128
|
|
3
|
-
python/rumdl/__main__.py,sha256=DQ-es4rlJ-iiHUeoTruvZzp-YV6rGShOWZYN4zBx_Iw,1903
|
|
4
|
-
python/rumdl/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
|
|
5
|
-
python/rumdl/__init__.py,sha256=En6tBgSj-MMeUcBAV7HlMjfstzY6npWxZtsRa30hIj0,90
|
|
6
|
-
rumdl-0.0.46.data/scripts/rumdl,sha256=_dbJoQuplwS3Y86dQkvJKQuXOq-tq5Rx5A_lJ2k596A,4772944
|
|
7
|
-
rumdl-0.0.46.dist-info/RECORD,,
|
|
File without changes
|