Commit graph

82 commits

Author SHA1 Message Date
Matthias Endler
fe5cea1de3 Add doc-comment tests 2021-02-18 11:14:00 +01:00
Matthias Endler
16cd67331a Add simple, standalone client
Adds a new function `lychee::check()`, which removes
a lot of boilerplate for simple cases. Adjusted the code,
tests, and documentation.
The downside is that `check` now returns a Result, so
we have to use `?` to get to the response. That's because
we have to account for the case where the given string is
not a valid URI.
2021-02-18 01:32:48 +01:00
Matthias Endler
737f6d3c3b Update help message 2021-02-17 13:54:41 +01:00
Matthias Endler
54e1d3e078 Simplify tests 2021-02-16 00:35:59 +01:00
Matthias
0b148bf5e6
Exclude e-mails from being checked (#137)
This can be useful in CI environments where SMTP is not allowed.
2021-02-10 11:58:04 +01:00
Paweł Romanowski
4d5b98978c
Mention GitHub Action in README.md (#135)
Also mention GitHub token in TROUBLESHOOTING.md
2021-02-08 12:18:50 +01:00
Matthias
8cc6d59587
Be more explicit about license in docs 2021-02-02 14:32:19 +01:00
Matthias
a50c04fffe
Add hint about separating inputs from options with -- (fixes #113) (#119) 2021-01-17 17:01:06 +01:00
Matthias Endler
e1faccf330 Update version 2021-01-09 02:06:05 +01:00
Matthias
d93662dc22
Use lychee namespace in lib examples and link to docs 2021-01-08 10:52:10 +01:00
Matthias Endler
419492f366 Mention recursion support 2021-01-07 00:42:39 +01:00
Matthias Endler
f0fa7eb73f Add JSON output feature 2021-01-07 00:37:42 +01:00
Paweł Romanowski
3d6f65820e
Test that cli parameters / usage are in sync in README.md (#95)
This makes it impossible to have diverged --help and README.md
2021-01-04 22:26:43 +01:00
Matthias
35509984ba
Formatting 2020-12-15 19:17:26 +01:00
Matthias
01f70bdc0a
Mention lychee itself as a user 2020-12-15 00:46:42 +01:00
Matthias
25e15500a7
Fix link 2020-12-15 00:43:45 +01:00
Matthias
497971a4a2
Remove duplicate entry in comparison table 2020-12-15 00:42:54 +01:00
Matthias
12f6c62f92
Add new lychee users 2020-12-14 11:38:10 +01:00
Matthias
60eb3ce31b
Mention binary releases in README.md 2020-12-12 00:28:56 +01:00
anarcat
a332582c65
linkchecker supports HTML files (#67)
* linkchecker supports HTML files

Not sure if that's an omission or of I missed something, but I believe that checking local `.html` files works in linkchecker.

* linkchecker also supports Markdown files

... with the `markdowncheck` plugin.
2020-12-05 21:34:34 +01:00
Paweł Romanowski
0167502d8d
Update GitHub token info, add my repo as user (#66) 2020-12-04 22:42:10 +01:00
Matthias
b7ab4abb0d
Make lychee usable as a library #13 (#46)
This splits up the code into a `lib` and a `bin`
to make the runtime usable from other crates.

Co-authored-by: Paweł Romanowski <pawroman@pawroman.dev>
2020-12-04 10:44:31 +01:00
Matthias
b6dbf038d0
fix typo 2020-12-03 15:09:44 +01:00
Matthias
096b372bee
Mention official Docker image 2020-12-03 00:05:31 +01:00
Paweł Romanowski
1f787613d4
Add support for reading from stdin and make input handling more robust (closes #26)
* Adds a `skip_missing` flag
* Adds an `Input` enum to handle different types of inputs
2020-12-02 23:28:37 +01:00
Paweł Romanowski
e197012e7a
Update troubleshooting guide, add .editorconfig (#60) 2020-12-02 23:07:52 +01:00
Matthias
37f2621d85
Add contributing guidelines and create missing issues 2020-12-01 01:19:41 +01:00
Matthias
d2e349cb29
Add link to troubleshooting guide 2020-12-01 00:32:37 +01:00
Matthias
883f638857
Revamp documentation 2020-11-25 10:22:03 +01:00
Matthias
8025a2eedb
Formatting 2020-11-23 13:10:32 +01:00
Matthias
1474ae802b
Update README.md 2020-11-09 12:12:57 +01:00
Matthias
a7673562d7
Fix formatting 2020-11-09 11:49:32 +01:00
Matthias
22c70cd85c
Use different icons for feature comparison (#32)
Taken from https://github.com/getzola/zola
2020-11-09 11:46:45 +01:00
Matthias
f7a1fcdf70
Update README.md 2020-11-06 00:22:14 +01:00
Paweł Romanowski
326683f4eb
Make GITHUB_TOKEN optional (#22)
* Make GITHUB_TOKEN optional

This also makes the token possible to pass in from CLI args.

* Add missing test fixture file

* Normalize exit codes and GitHub checking behavior

The exit code is now defined as 1 for unexpected or config errors,
and 2 for link check failures.

GitHub checking behavior has been tweaked to generate errors if
a GitHub-specific check cannot be performed because of a missing
token.

* Remove short flag for github token
2020-10-26 23:31:31 +01:00
Matthias
ac79314c03
Mention support for basic auth by @FabianBG 2020-10-26 09:25:00 +01:00
Matthias
f0e4c3adc1
Add support for include patterns (#23)
In one or more `include` arguments are specified, only check the URLs that match the patterns.
In case `exclude` arguments are also
specified, make an exception from the
excluded URLs if they also match the
`include` patterns.
2020-10-25 13:41:06 +01:00
Matthias
6463372799
Mention support for relative urls 2020-10-21 13:03:55 +02:00
Matthias
45bc8d1a96
Format unknown fields 2020-10-21 12:46:24 +02:00
Matthias Endler
39f1ab5083 ordering 2020-10-21 12:44:12 +02:00
Matthias
351067e7a3
Update config file support 2020-10-21 12:41:53 +02:00
Matthias Endler
6663f23707 Add little joke 2020-10-21 00:29:47 +02:00
Matthias
38ff97a2e5
Extend comparison table 2020-10-21 00:21:11 +02:00
Matthias
bbb7971e83
Update README.md 2020-10-20 23:13:45 +02:00
Matthias
93a2e93999
Formatting 2020-10-20 12:19:33 +02:00
Matthias
114a36866f
Formatting 2020-10-20 12:18:28 +02:00
Matthias
6c8c7c57e1
Add comparison table and recording of demo run (#17) 2020-10-20 10:40:45 +02:00
Matthias
ee895551c4
Update README.md 2020-10-19 00:09:53 +02:00
Matthias Endler
ebaabe5abf Merge master 2020-10-18 00:16:42 +02:00
Matthias Endler
ccbe7cbcb1 Update docs 2020-10-18 00:15:11 +02:00