[Proposal] Updates, fixes and new features

[jenkin]

I think this project has unique features (ie. built-in globbing and direct md analysis without compilation to html) among competitors (ie. markdown-link-check) and is good enough to deserve a proper evolution path in next future.

For an internal open source project (a knowledge base written in markdown and powered by Raneto) I took the v1.0.1 (8 Jun 2021) of markdown-link-validator and made some changes to adapt it to our requirements: https://github.com/jenkin/markdown-link-validator/.

1. update all dependencies and resolve all known vulnerabilities highlighted by npm audit
2. add support to absolute local links (ie. [internal page](/path/to/page.md))
3. [-q option] add a quiet mode to report only errors if present (see issue Allow show only the errors in the report. #6)
4. [-e option] add support to optional .md extension (ie. for [internal page](./path/to/page) it searches also for [internal page](./path/to/page.md) or [internal page](./path/to/page/index.md)
5. [-o option] add support to other extension checking (ie. [local asset](./path/to/image.png) (see issue Relative Image links are reported as invalid #27)
6. ignore links in code blocks and inline code
7. add support to standalone links checking (ie. without [anchor](https...) or [anchor] https...)
8. [-c option] ignoring failing external urls based on response status codes (added to final report)
9. [--ignorePatternsFrom option] ignoring files by patterns taken from a file
10. [--noEmptyFiles option] raising error if linked files are empty

No breaking changes to the API are introduced. All existing options have the same behavior and defaults and new optional features depends on options disabled by default. Only 2), 6) and 7) are opinionated and could require some discussions. All new features have tests (but I know we can improved them further).

All changes live on feature/sparkfabrik-enhancements branch. I think all of them can met a broader interest beyond our company playbook, so I propose you to review my work and consider to accept a PR and update the npm package.

[molant]

@jenkin nice!
Do you mind opening a PR so it's easier to see the diff?

[mi-hol]

made some changes to adapt it to our requirements

the list of addl. requirements makes perfect sense!

[jenkin]

Cool! My roadmap for coming days includes two more steps:

10. Check and fix Add support to check Link labels #7
11. Add warnings (ie. shown in report in yellow, but no error code on exit) for empty md files and ignored status codes (see 8)

That would be all for the purpose of our internal project.

Please, let me know if something needs to change to merge the PR (ie. I added dist/ folder to repo to allow npm to install the package from github).

[jenkin]

@molant I finished to implement steps 10 and 11. Are you going to consider to merge my PR? If so, let's talk to finalize it! :)

[molant]

Yes, I started looking at it a few days back but job got in the way and I’m about to go on vacation for a few weeks with no laptop. It will be a bit until I have time to finalize reviewing it. Thanks for your patience 🙏

…

________________________________ From: Alessio Cimarelli ***@***.***> Sent: Friday, August 4, 2023 3:46:02 PM To: webhintio/markdown-link-validator ***@***.***> Cc: Comment ***@***.***> Subject: Re: [webhintio/markdown-link-validator] [Proposal] Updates, fixes and new features (Issue #28) @mi-hol<https://github.com/mi-hol> I finished to implement steps 10 and 11. Are you going to consider to merge my PR? If so, let's talk to finalize it! :) — Reply to this email directly, view it on GitHub<#28 (comment)> or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAEUDAVGXAH2SY2O7THF3QLXTT4JVBFKMF2HI4TJMJ2XIZLTSOBKK5TBNR2WLJDUOJ2WLJDOMFWWLO3UNBZGKYLEL5YGC4TUNFRWS4DBNZ2F6YLDORUXM2LUPGBKK5TBNR2WLJDUOJ2WLJDOMFWWLLTXMF2GG2C7MFRXI2LWNF2HTAVFOZQWY5LFUVUXG43VMWSG4YLNMWVXI2DSMVQWIX3UPFYGLLDTOVRGUZLDORPXI6LQMWWES43TOVSUG33NNVSW45FGORXXA2LDOOJIFJDUPFYGLKTSMVYG643JORXXE6NFOZQWY5LFVEYTKOJUGA4DKMRSQKSHI6LQMWSWS43TOVS2K5TBNR2WLKRRG44DOOJUGQYTGNFHORZGSZ3HMVZKMY3SMVQXIZI>. You are receiving this email because you commented on the thread. Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[jenkin]

No problem, I will be on vacation for the next two weeks, so take your time. Thanks!

[jenkin]

Hi @molant , I'm back, I hope you are well too. Let me know next steps to close this issue... 😃

[mi-hol]

It will be a bit until I have time to finalize reviewing it.

@molant hope you are doing fine. Would you be in a position to forecast the rough timeline(s) until completion?