Add test option for additional checks

[hanneskuettner]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)
• If applicable, I’ve added docs and tests

Description of changes

Add a test option that is converted using hast-util-is-element and adds additional matching capabilities to exclude some external link elements as discussed in #3.

[wooorm]

Can you move the is = convert() bit up, so that it is called once: e.g., directly inside rehypeExternalLinks. Now it’s doing unneeded work.

I think is can be called in the node.tagName === 'a' branch? That way, if there is a test that says the element shouldn’t be converted, we don’t need to do extra work of checking protocols.

Lastly, would it be an idea to default to 'a' as a test?
That way, people could allow ['a', 'area']. Or include custom elements (weird but ok)?
Not sure if useful. What do you think?

[hanneskuettner]

Can you move the is = convert() bit up, so that it is called once: e.g., directly inside rehypeExternalLinks. Now it’s doing unneeded work.

Good point!

I think is can be called in the node.tagName === 'a' branch? That way, if there is a test that says the element shouldn’t be converted, we don’t need to do extra work of checking protocols.

Another good point, I'll also do that!

Lastly, would it be an idea to default to 'a' as a test?
That way, people could allow ['a', 'area']. Or include custom elements (weird but ok)?
Not sure if useful. What do you think?

I thought about that as well. This could maybe lead to some unexpected behavior, since the test would then have to reimplement checking for an a tag in the simple case of just wanting to exclude some domains for example.
But maybe that is okay with an additional note in the docs?
It would certainly make this plugin more powerful.

[wooorm]

The only real benefit would be that area elements are supported.

Potentially custom elements too, but then it gets weird that rel and target are applied with the same semantics as a, because custom elements probably work differently.

Perhaps area could also just be added extra here for everyone: node.tagName === 'a' || node.tagName === 'area'. Later.

I think I’m fine with the current state!

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (2fab32f) 100.00% compared to head (791bc63) 100.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #10   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          135       144    +9     
=========================================
+ Hits           135       144    +9     

Impacted Files	Coverage Δ
index.js	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[github-actions]

Hi! This was closed. Team: If this was merged, please describe when this is likely to be released. Otherwise, please add one of the no/* labels.

[wooorm]

Released in 2.1.0! Thank you!

[hanneskuettner]

Thanks for your fast handling. That was a joy!