Save results as json

[Veraxus]

Is there a way to save linkcheck results as JSON?

[filiph]

That's not currently possible, unfortunately. What would be the exact use case? (I'm trying to gauge how the JSON should look like, if it should be streamed rather than dumped, etc.)

[Veraxus]

I'm trying to run link scans Gitlab CI and I'd like to be able to send the results to a API in a raw data format that can be used to generate custom HTML reports.

[sebastientaggart]

+1, comparing this tool to https://github.com/linkchecker/linkchecker they have several useful options. For example, using a CI we run the checker and save the XLS and HTML report output to a dated directory to content editors can review and fix the broken links.

This tool is much faster, but unfortunately without this feature we can use it in our use-case. Hoping to see this implemented!

[filiph]

Thanks, and sorry for the glacial (non-)progress on this.

What would be the safest output? CSV? TSV? JSON? XML? proto?

Alternatively, I might try and better expose an API, so people can write their own scripts and then do whatever they need with the data. That would have the advantage that the output is really only what you need, and in the format you want. Which would also make everything more efficient.

To be clear, this is already possible (linkcheck is a Dart package, first and foremost, and thus it has an API). But I might want to document it better.

[sebastientaggart]

I guess the most flexible output for most people would be JSON, however in our specific use-case I want CSV and HTML (HTML is easiest for end users to access, and CSV for reporting). If I only had JSON, I would convert it with another tool.

An API would also be fine, and maybe the most flexible, but definitely not the easiest. I did see your link to the API, reportForWriters looks like the right direction? I agree that some more documentation, or a sample use-case, would be extremely useful.

[ilovefreesw]

Any progress on export part yet?

[cavla]

+1 for the export feature. Any progress?
(CSV in my use-case)
Thanks a lot for this tool !