Raw output option

[T145]

Instead of #268, have a raw option to generate output that doesn't include emoji and the process indicator. This will help the results be piped into other programs like jq that people can then use to transform into JSON on their own. It could look like:

./lychee README.md --raw -v

[lebensterben]

This is a good point.
Rust programmers are used to UTF compatibility but in reality other components in the toolchain may not be UTF compatible.

Meanwhile, if you can tell lychee to output results in JSON format. That's friendlier for jq.

[mre]

This should work in master now to get raw output:

./lychee README.md --format=raw --no-progress -v

The NO_COLOR environment variable is also respected.
See #599 for details.

[mre]

Gonna close this as resolved. Feel free to reopen if it doesn't work as expected.

[alexanderbazhenoff]

Just wanna know how to enable colors in GitLab CI console? No info in README.

[mre]

Sorry for the late reply.
You can try to set the NO_COLOR=1 environment variable, so

export NO_COLOR=1
lychee ...

or

NO_COLOR=1 lychee ...

[alexanderbazhenoff]

Sorry for the late reply. You can try to set the NO_COLOR=1 environment variable, so

No problem, but I meant enable colors :) Anyway neither NO_COLOR=0 (and NO_COLOR=false), nor NO_COLOR=1 (and NO_COLOR=true) got color changes in my GitLab CI, it's stll b/w. Using lychee-v0.14.3-aarch64-unknown-linux-gnu.tar.gz:

  script:
    - NO_COLOR=0 lychee -n .

Any ideas?

[mre]

@alexanderbazhenoff, I took a stab at it here: #1398
If you want, you can try it out by installing the version from that branch. I'd appreciate some feedback.

[alexanderbazhenoff]

@alexanderbazhenoff, I took a stab at it here: #1398 If you want, you can try it out by installing the version from that branch. I'd appreciate some feedback.

Sorry for long reply.

I have placed a new binary alongside with an old, but named them as lychee2. So, -n --mode emoji worked as described behind, defaults still no color:

Runing the same defaults locally via console is nice and colored anyway:

No additional env variables set like COLOR/NO_COLOR in GitLab CI, just raw command run:

script:
  - lychee2 .

What I did wrong in my CI? Or what debug info from me is required?

[mre]

I think the issue is on my end. Need to make more changes in the pull request. Apologies for the noise.

[adoyle-h]

I think it should be always trim colors for output file. NO_COLOR=1 is a redundant option. Who need the terminal color codes included in file?

[alexanderbazhenoff]

I think it should be always trim colors for output file. NO_COLOR=1 is a redundant option. Who need the terminal color codes included in file?

In this way COLORS=1 will be apprectiated :)
In practice, colors/emojis have become more readable in GitLab or other CI platforms output. Not everyone wants to aggregate CI logs outside of GitLab, but b/w as defaults is also ok.

[mre]

With #1398 being merged, I think we can close this.

To recap, the main request for a raw output option has been implemented with --format=raw --no-progress.

There's an ongoing discussion about color output in CI environments, particularly GitLab CI:
The NO_COLOR environment variable doesn't seem to be working as expected over there?
Maybe it's already been resolved by now, either on the GitLab side or on lychee's side after merging #1398?
Either way, if someone finds the time, please investigate why NO_COLOR isn't working as expected in GitLab CI and create a new issue if needed.

[mre]

I've also documented the output modes on the documentation website here.