search

Ellerbach / docfx-companion-tools

A suite of tools, pipelines templates to take the very best of DocFX
MIT License
66 stars 19 forks source link

Added skip option. #28

Closed smykhailov closed 12 months ago

smykhailov commented 1 year ago

It allows to define RegExp to skip validation for files or folders.

mtirionMSFT commented 1 year ago

@smykhailov I like the proposal. Currently I don't think it's the best solution to add it this way, as it might be harder to move forward. Let me explain what I mean ... :)

Good to know is that I'm currently working on a complete rewrite of this tool. It will make it more standard .NET, better architected, but more important - enhance the feature set while being backwards compatible in use. One of things I'm adding is the option to use a configuration file like docfx.json. Because of your idea, I'll be adding Include and Exclude options for folders as well using the glob pattern (https://learn.microsoft.com/en-us/dotnet/core/extensions/file-globbing). There is automatic support for includes and excluding there. This is better readable and maintainable I think then writing complex regex expressions, which isn't that easy for most of us (including me :p).

You can expect an updated version of the DocLinkChecker with this functionality in the coming weeks.

smykhailov commented 1 year ago

@mtirionMSFT oh, that's great to hear, in this case I think we can abandon my PR and I'll wait until a new rewritten version is published. Thank you.

mtirionMSFT commented 1 year ago

@smykhailov Please have a look at the branch https://github.com/Ellerbach/docfx-companion-tools/tree/doclinkchecker-upgrade with the new implementation. You would need to pull and compile of course, but you can see if it meets your needs. The DocLinkChecker README describes the new option to include a configuration file.

Ellerbach commented 1 year ago

@smykhailov feedback welcome as well ;-)

smykhailov commented 1 year ago

this is really great ad exactly what we need. Thank you @mtirionMSFT and @Ellerbach

mtirionMSFT commented 12 months ago

Solved by #32