feat: add filter function as an option to linkinator.check()
#120
Conversation
|
There were the following issues with this Pull Request
You may need to change the commit messages to comply with the repository contributing guidelines. 🤖 This comment was generated by commitlint[bot]. Please report issues here. Happy coding! |
zeke
force-pushed
the
add-filter-function-option
branch
from
bc60619
to
99c99a1
Compare
zeke
changed the title
filter function as an option to linkinator.check
zeke
changed the title
filter function as an option to linkinator.checkfilter function as an option to linkinator.check
zeke
changed the title
filter function as an option to linkinator.checkfilter function as an option to linkinator.check()
|
Some alternative is making it like in babel/webpack or other tools. Existing flag |
|
Thanks for the feedback. I've updated this PR to allow |
src/index.ts
Outdated
| @@ -16,7 +16,7 @@ export interface CheckOptions { | |||
| port?: number; | |||
| path: string; | |||
| recurse?: boolean; | |||
| linksToSkip?: string[]; | |||
| linksToSkip?: string[] | ((link: string) => boolean); | |||
There was a problem hiding this comment.
Just to be safe - can we make the function here async? I never think someone will need it, then they always end up needing it 😆
linksToSkip?: string[] | (async (link: string) => boolean);There was a problem hiding this comment.
I omitted the async because I was getting this error when I included it:
There was a problem hiding this comment.
So that's weird - is this VS Code? Alternatively, (link: string) => Promise<boolean> gets us to the same place.
There was a problem hiding this comment.
Yeah it's VS Code.
I used your Promise<boolean> suggestion here and updated the tests and docs in a146f2c
|
There were the following issues with this Pull Request
You may need to change the commit messages to comply with the repository contributing guidelines. 🤖 This comment was generated by commitlint[bot]. Please report issues here. Happy coding! |
zeke
force-pushed
the
add-filter-function-option
branch
from
f1dfd01
to
a146f2c
Compare
|
🎉 This PR is included in version 1.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This PR adds a new
filterLinksoption to thelinkinator.checkfunction. The new option is a function that can be used to determine which URLs to skip and which to keep.I'm not attached to the name of this option, nor the implementation. I'm open to alternatives ways of solving this that would expose the same level of flexibility to module users.