none-shall-pass
| Crates.io | none-shall-pass |
| lib.rs | none-shall-pass |
| version | 0.2.3 |
| created_at | 2023-10-31 18:13:20.483263+00 |
| updated_at | 2024-05-20 23:54:55.547568+00 |
| description | Artifact for GitHub Action to validate hyperlinks in all markdown files |
| homepage | https://github.com/thevickypedia/none-shall-pass-rustic |
| repository | https://github.com/thevickypedia/none-shall-pass-rustic |
| max_upload_size | |
| id | 1020188 |
| size | 8,193,369 |
Vignesh Rao (dormant-user)
documentation
https://thevickypedia.github.io/none-shall-pass
README
none-shall-pass-rustic
Artifact for none-shall-pass
Summary
none-shall-pass-rusticis an application written in Rust.- Validates hyperlinks in markdown files.
- Accepts inputs provided as command-line arguments.
- Extracts hyperlinks from Markdown content, validates them concurrently using multithreading, and logs the validation results.
- Differentiates between local Markdown files and Wiki pages within the repository, expanding its validation scope.
- Usage via GitHub actions can be found in GitHub Marketplace
Description
- Clones the GitHub wiki pages
- Looks up all the
*.mdfiles - Scans for hyperlinks using regex (
inline,footnote, andanchored) - Ignores failure when the URL is a
localhost/127.0.0.1/0.0.0.0
Arguments
- --debug - Enables debug level logging
- --owner - Owner/organization of the repository
- --repo - Name of the repository
- --exclude - Exclude URLs (as comma separated list) to have known failures
Crate
https://crates.io/crates/none-shall-pass
Docs
https://docs.rs/crate/none-shall-pass
Linting
Requirement
rustup component add clippy
Usage
cargo clippy --no-deps --fix --allow-dirty
License & copyright
© Vignesh Rao
Licensed under the MIT License