feat(linter): add new link checker - lychee

[DariuszPorowski]

Fixes #2672

Proposed Changes

1. added new descriptor with lychee
2. added test fixtures for lychee
3. output files from build.sh
4. added https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/swift.ico
5. baseline lychee config for ML
6. updated outdated links

Readiness Checklist

Author/Contributor

• Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
• If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

• Label as breaking if this is a large fundamental change
• Label as either automation, bug, documentation, enhancement, infrastructure, or performance

[bdovaz]

@DariuszPorowski thanks for the contribution.

I have a doubt, and that is why you have created a new descriptor (lychee.megalinter-descriptor.yml)? If it is possible, we should fit it in an existing file.

What I don't know is how to categorize it, Maybe repository?

cc @nvuillam

[nvuillam]

@DariuszPorowski thanks a lot for the PR that looks great :)

I'm aligned with @bdovaz , descriptors are for languages or "file types", and lychee isn't one

For the case where the name linter can be used in several descriptors, it's not very pretty but... we define the linter in both descriptors, like for v8r which is in json and yml

Maybe you could define LYCHEE in md, rst and html descriptors ?

[DariuszPorowski]

@bdovaz @nvuillam I struggle with the same case, but cannot figured out the good place 😅 because lychee is not only limited MDs files, and try to avoid code duplication to copy-paste linter descriptor across multiple descriptors. thoughts about the final approach?

[echoix]

I have to agree with @DariuszPorowski on this, that copy-pasting isn't ideal. Does the copy-paste linter trigger on this? It would ideally need a comment on the "main" entry to also update the other entries. I didn't know about the v8r duplication, and I don't see a note in the descriptor there to update. Comparing both of the v8r entries, there are the test_folder and examples that are different, plus a different config file name for the yaml entry.

And if the installation instructions are exactly the same, at least it won't be duplicated in the dockerfiles.

However @nvuillam, what would the docs be like if a linter was defined multiple times, in different descriptors? Would we see that the linter is only activated with like, json files for v8r, when we would see another page saying that v8r is activated on yml? I like that when it is duplicated, there are separate configuration variables though, like YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN and JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN

[DariuszPorowski]

@bdovaz repository (actually that was my initial idea) has lint_all_files: true at the root and it does not apply for this case.

@nvuillam if even i duplicate the code for md, rst and html what about the rest of the supported cases for lychee? actually, in my scenarios I use it as we with yml, txt and json :D and lychee supports even more formats - do not know it has any limitation (as long as file is kina of text)?

[nvuillam]

Linters matching N descriptors is a topic for a while in MegaLinter... ( see prettier ! )

I see 3 options:

• CROSSLANG descriptor, where prettier would also go
• LINKS descriptor
• copy-paste in different matching descriptors

The topic is a little bit tricky, because descriptors are not just for "organizing linters", they are also used to create the group of linters performed by a single parallel core (linters that can format/fix files can not run simultaneously, and must be run before the linters of the same descriptors that do not update files)

@bdovaz @Kurt-von-Laven @echoix @DariuszPorowski your opinion ?

[nvuillam]

See code here about linter groups and sorting by speed ->

megalinter/megalinter/MegaLinter.py

Line 287 in 773fa24

linter_groups = []

[nvuillam]

@DariuszPorowski thanks for the great analysis :)

• https://stylelint.io/user-guide/integrations/other#analysis-platform-engines

  • they seems to have removed this part of the doc, so if we don't find it anywhere

• https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/security.ico & https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/swift.ico

  • we need new icons :D

[DariuszPorowski]

@nvuillam @echoix ok, I think it's done :D

[nvuillam]

Great PR, great new linter, and great cleaning of broken links, many many thanks @DariuszPorowski 😍

[nvuillam]

CLASSY ! :)

[DariuszPorowski]

@nvuillam probably it will require minor adjustments overtime for MegaLinter itself, because it's an early-stage baseline config

• lychee config: https://github.com/oxsecurity/megalinter/blob/main/.github/linters/lychee.toml
• lychee ignore: https://github.com/oxsecurity/megalinter/blob/main/.lycheeignore

CC:
@mre / @mre-trv JFYI, your tool is now bundled into MegaLinter :)

[nvuillam]

@DariuszPorowski maybe also a default config , we usually provide an simple/opiniotated one in TEMPLATES folder, that is called when no config file is found in the repo :)

[nvuillam]

@nvuillam probably it will require minor adjustments overtime for MegaLinter itself, because it's an early-stage baseline config

• lychee config: https://github.com/oxsecurity/megalinter/blob/main/.github/linters/lychee.toml
• lychee ignore: https://github.com/oxsecurity/megalinter/blob/main/.lycheeignore

CC: @mre / @mre-trv JFYI, your tool is now bundled into MegaLinter :)

@mre I didn't see you're analysis-tools.dev creator, thanks for lychee but also thanks again for analysis-tools.dev, that brings traffic to MegaLinter :)

[DariuszPorowski]

@nvuillam what I did wrong? 😅https://github.com/oxsecurity/megalinter/actions/runs/5271203168/jobs/9531767119#step:9:1658

[nvuillam]

@DariuszPorowski probably Github repo security because you are not code owner but updated a Github Workflow ^^

And that's good :)

I'll check if it works better once I update the file myself

[mre]

@mre I didn't see you're analysis-tools.dev creator, thanks for lychee but also thanks again for analysis-tools.dev, that brings traffic to MegaLinter :)

@nvuillam, we sort of went full circle with this. 😆
@DariuszPorowski thanks for your efforts!

High-fives all around.

[nvuillam]

@DariuszPorowski seems better after my new commit :)

@mre nothing can compete with passionate open-sourcerers 🧙‍♂️