Commit graph

239 commits

Author SHA1 Message Date
Thomas Zahner
a8e648a2c7 Fix typo
Co-authored-by: Matthias Endler <matthias@endler.dev>
2024-12-20 10:10:23 +01:00
Thomas Zahner
4c1cc6c6aa Move section 2024-12-20 10:10:23 +01:00
Thomas Zahner
928b8bbe89 Add development section to README 2024-12-20 10:10:23 +01:00
Trask Stalnaker
6d0e94c799
Introduce --root-dir (#1576)
* windows

* Introduce --root-path

* lint

* lint

* Simplification

* Add unit tests

* Add integration test

* Sync docs

* Add missing comment to make CI happy

* Revert one of the Windows-specific changes because causing a test failure

* Support both options at the same time

* Revert a comment change that is no longer applicable

* Remove unused code

* Fix and simplification

* Integration test both at the same time

* Unit tests both at the same time

* Remove now redundant comment

* Revert windows-specific change, seems not needed after recent changes

* Use Collector::default()

* extract method and unit tests

* clippy

* clippy: &Option<A> -> Option<&A>

* Remove outdated comment

* Rename --root-path to --root-dir

* Restrict --root-dir to absolute paths for now

* Move root dir check
2024-12-13 14:36:33 +01:00
Matthias Ngeo
6c1d56914a
Add Forui to README.md's users section (#1551) 2024-11-06 17:38:56 +01:00
Thomas Zahner
1f2df5dc1e
Add interesting projects who use lychee (#1537)
* Add interesting projects who use lychee

* List Gradle as user in README.md
2024-10-22 00:00:07 +02:00
Thomas Zahner
3a2533f8f5
Add OWASP Threat Dragon to users 2024-10-18 16:28:34 +02:00
Damien Mathieu
f0ebac29a2
Allow excluding cache based on status code (#1403)
This introduces an option `--cache-exclude-status`, which allows specifying a range of HTTP status codes which will be ignored from the cache.

Closes #1400.
2024-10-14 02:41:56 +02:00
Matthias Endler
3d414c2bc0
Update TOC in README.md 2024-10-12 02:23:37 +02:00
Matthias Endler
e2814acaa4
fix: Remove tokio console subscriber (#1524)
The console subscriber is the source of quite a few papercuts like
https://github.com/lycheeverse/lychee/issues/1513.

Since we don't use it at the moment, I decided to remove it.
2024-10-12 02:19:31 +02:00
Matthias Endler
18d486d782
Extend documentation on excluding links 2024-10-08 15:50:04 +02:00
Johannes Schindelin
af7226ef2e
README: The Git home page and Git Credential Manager use lychee (#1519)
As of almost two weeks ago, Git's home page at https://git-scm.com/ was
switched to a static website that uses lychee to verify links (already
catching a broken one: https://github.com/gitgitgadget/git/pull/1812).

For substantially longer, the Git Credential Manager uses lychee to
validate the links in its documentation.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
2024-10-08 11:12:19 +02:00
Sebastiaan Speck
029fa36321
README: add tldr-pages as user (#1508) 2024-09-28 14:46:10 +02:00
Thomas Zahner
6075b4c87e Skip ignored and hidden files by default 2024-09-22 19:09:35 +02:00
Thomas Zahner
ee25adbed1 Update README.md test to trim whitespaced lines & update README.md 2024-09-22 19:09:35 +02:00
Nicolas Kosinski
1c6be80510
chore(docs): mention MacPorts install in README.md (#1491) 2024-08-30 12:59:22 +02:00
Matthias Endler
3a42f2e1ce
Mention Chocolatey 2024-08-21 20:59:39 +02:00
Hugo McNally
4bb8a61545
Updated pulldown-cmark dependency and fixed maths parsing (#1473)
* Update pulldown-cmark version to 0.11.0
* Fix markdown math parsing
* Fix lints
* Disable flaky wayback test

---------

Co-authored-by: Matthias <matthias@endler.dev>
2024-08-06 15:43:34 +02:00
Alessio Biancalana
66ee7ef93c
README: add openSUSE Tumbleweed to the installation instructions (#1470) 2024-07-29 20:39:56 +02:00
Robert Hensing
4340fcbcbb
README: Add Nixpkgs to Installation (#1448)
* README: Add Nixpkgs Installation

* README: Hint that Nix starts the check
2024-06-16 20:09:08 +02:00
Matthias Endler
dedc554eda
Add response formatter; refactor stats formatter (#1398)
This adds support for formatting responses in different ways.

For now, the options are:

* `plain`: No color, basic formatting
* `color`: Color, indented formatting (default)
* `emoji`: Fancy mode with emoji icons

Fixes #546
Related to #271
2024-06-14 19:47:52 +02:00
Johannes Schindelin
8c6eee9b5f
Add a way to handle "pretty URLs", i.e. URIs without .html extension (#1422)
In many circumstances (GitHub Pages, Apache configured with MultiViews,
etc), web servers process URIs by appending the `.html` file extension
when no file is found at the path specified by the URI but a `.html`
file corresponding to that path _is_ found.

To allow Lychee to use the fast, offline method of checking such files
locally via the `file://` scheme, let's handle this scenario gracefully
by adding the `--fallback-extensions=html` option.

Note: This new option can take a list of file extensions to use; The
first one for which a corresponding file is found is then used.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
2024-06-11 16:11:24 +02:00
ehmicky
5475a4f763
Add Execa to list of users (#1435) 2024-06-06 10:51:41 +02:00
ESP-Kirill
9e031b6256
Fix typo in pre-commit config in README (#1424) 2024-05-13 19:12:56 +02:00
Johannes Schindelin
975901d470
Fix clippy errors (#1423)
* Enclose Markdown links in brackets

The current clippy version (v0.1.78) says "you should put bare URLs
between `<`/`>` or make a proper Markdown link" and refers to
https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Enclose documentation item in backticks

Clippy v0.1.78 complains about the IPv6 network mask, insisting that it
is missing backticks. So backticks it gets.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Avoid error claiming `Add(usize)` is dead code

Clippy v0.1.78 identifies this as dead code. However, further down in
the same file, there is clearly a user:

  impl Handler<Result, Result> for Add {

This might be yet another incarnation of
https://github.com/rust-lang/rust/issues/56750

Let's just mark it as intentionally dead-code, even if this is untrue,
to make clippy happy again.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

---------

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
2024-05-13 19:07:02 +02:00
Thomas Zahner
0a54079d01 Bump to version 0.15.1 2024-04-29 09:28:34 +02:00
Thomas Zahner
8451f8846b Bump to version 0.15.0 2024-04-25 09:39:43 +02:00
Orhun Parmaksız
382b53c5d0
docs: add instructions for installing on Alpine Linux (#1406) 2024-04-18 17:42:23 +02:00
Matthew Timms
eb12064fab
feat: add support for pre-commit (#1396) 2024-04-15 18:18:52 +02:00
Denis
0d5601ce9e
fix: Treat sites with 403 status codes as broken links (#1377) 2024-03-19 12:55:21 +01:00
Matthias Endler
90ed0e70b7
Bump to version; move to workspace versioning (#1372) 2024-02-05 16:50:32 +01:00
Matthias
6306883cc2 Bump version to 0.14.2 2024-01-26 15:04:09 +01:00
mre
a7c11c9c22 chore(docs): update TOC 2024-01-09 23:25:16 +00:00
Matthias
a981472eda Bump version to 0.14.1 2024-01-10 00:24:57 +01:00
Matthias Endler
2b30e001a5
Mention anchor/fragment support in docs 2024-01-07 00:22:12 +01:00
mre
bcc00441eb chore(docs): update TOC 2024-01-05 15:36:28 +00:00
Matthias
b37d255d45 fix docs after release 2024-01-05 16:36:14 +01:00
Everett Pompeii
449539f2e2
Add Bencher to Lychee users list (#1315)
Bencher uses Lychee to check links in CI. Thank you!
2023-12-04 00:38:00 +01:00
Thomas Zahner
11d8d44895
Update README.md with exit code 3 (#1281) 2023-10-27 13:28:33 +02:00
mre
36c34f271c chore(docs): update TOC 2023-09-17 19:39:13 +00:00
Techassi
1b1fd0c707
feat: Add support for ranges in the --accept option / config field (#1167)
Adds support for accept ranges discussed in #1157. This allows the user to specify custom HTTP status codes accepted during checking and thus will report as valid (not broken). The accept option only supports specifying status codes as a comma-separated list. With this PR, the option will accept a list of status code ranges formatted like this:

```toml
accept = ["100..=103", "200..=299", "403"]
```

These combinations will be supported: `..<end>`, ` ..=<end>`, `<start>..<end>` and `<start>..=<end>`.
The behavior is copied from the Rust Range like concepts:

```
    ..<end>, includes 0 to <end> (exclusive)
    ..=<end>, includes 0 to <end> (inclusive)
    <start>..<end>, includes <start> to <end> (exclusive)
    <start>..=<end>, includes <start> to <end> (inclusive)
```


- Foundation and enhancements for accept ranges, including support for comma-separated strings and integration into the CLI.
- Implementations and updates for AcceptSelector, including Default, Display, and serde defaults.
- Address and fix various errors: clippy, cargo fmt, and tests.
- Add more tests, address edge cases, and enhance error messaging, especially for TOML config parsing.
- Update dependencies.
2023-09-17 21:39:01 +02:00
mre
f5fe25a1c8 chore(docs): update TOC 2023-09-14 23:27:58 +00:00
Matthias Endler
0711112841
Mention supported schemes (#1255)
Fixes https://github.com/lycheeverse/lycheeverse.github.io/issues/7
2023-09-15 01:27:44 +02:00
Hugo McNally
8e6369377c
Introduce fragment checking for links to markdown files. (#1126)
- Implemented enhancements to include fragments in file links
- Checked links to markdown files with fragments, generating unique kebab case and heading attributes.
- Made code more idiomatic and added an integration test.
- Updated documentation.
- Fixed issues with heading attributes fragments and ensured proper handling of file errors.
2023-07-31 16:04:00 +02:00
Matthias Endler
04887ee293
Make checking email addresses optional (#1171)
E-Mail checks cause too many false-postives,
so we put them behind a flag.

* `--exclude-mail` is deprecated (to be removed in 1.0)
* `--include-mail` is the new flag

This PR also removes the obsolete tests for `--exclude-file`, which was superseded by `.lycheeignore`.

Fixes #1089
2023-07-19 19:58:38 +02:00
Techassi
f53619a455
feat: Add support for --dump-inputs (#1159)
* Add support for --dump-inputs
* Add integration tests
* Fix usage guide in README
2023-07-16 18:08:14 +02:00
mre
f1817ead5e chore(docs): update TOC 2023-07-15 14:19:16 +00:00
mre
d69be812ef chore(docs): update TOC 2023-07-15 14:18:07 +00:00
github-actions[bot]
030353537b
docs: Update TOC 2023-07-15 14:15:50 +00:00
github-actions[bot]
48e7f257b2
docs: Update TOC 2023-07-15 14:09:13 +00:00