Transforms: Shortcode: Support isMatch predicate

[mcsf]

Description

Fixes #10674

How has this been tested?

Expanded unit tests for shortcode conversion.

Types of changes

Enhancement, API.

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows the accessibility standards.
• My code has proper inline documentation.
• I've included developer documentation if appropriate.
• I've updated all React Native files affected by any refactorings/renamings in this PR. .

[ellatrix]

Could we add some integration tests as well?

[mcsf]

@ellatrix, a few of questions:

1. How would they differ from the current ones? It's not like any core blocks are using isMatch, nor that there are multiple core blocks interested in the same shortcode tag.
2. Looking at blocks-raw-handling.test.js, I notice that there are now three "areas" for testing:

• individual tests under Blocks raw handling
• the fixture-based tests under pasteHandler
• individual tests under rawHandler

Seems like we could revisit this? I personally don't really know where to start adding tests for this.

3. That readFile helper silently bails if the provided file path doesn't exist, meaning that types in pasteHandler can just silently pass even when there are missing fixtures. Case in point: caption-shortcode no longer runs. Seems like something to fix too, I don't see a reason not to throw an error if a file is missing.

[pento]

It's not like any core blocks are using isMatch, nor that there are multiple core blocks interested in the same shortcode tag.

Interestingly, this could be changed. An example off the top of my head is that the [video] shortcode in Core explicitly supports YouTube and Vimeo URLs in the src attribute. These shortcodes could be transformed into their respective core-embed block, rather than the core/video block.

[ellatrix]

1. How would they differ from the current ones? It's not like any core blocks are using isMatch, nor that there are multiple core blocks interested in the same shortcode tag.

That's true, but we could add a test block?

Seems like we could revisit this? I personally don't really know where to start adding tests for this.

Yeah, we should clean that up :) Ideally, if applicable, tests should be run for both the raw and paste handler.

That readFile helper silently bails if the provided file path doesn't exist, meaning that types in pasteHandler can just silently pass even when there are missing fixtures. Case in point: caption-shortcode no longer runs. Seems like something to fix too, I don't see a reason not to throw an error if a file is missing.

Me neither. Sounds good to throw an error.

[ellatrix]

Looks great, but would really love some integration tests for an extra layer of confidence. :)

[pento]

Thank you for getting onto this one, @mcsf!

For consistency, is it worth looking at having the shortcode transform use a transform function, too, so it matches all of the other types? It seems a bit weird to have a different pattern just for shortcodes. @ellatrix, I don't suppose you recall any additional conversations around #2874?

[ellatrix]

@pento What kind of additional conversation? I believe we use isMatch for other transforms too.

[pento]

Talking about the difference between the examples in the docs, all of the transform types provide a transform property, which is a function to create the block, except for the shortcode type, which has the attributes property, instead. I wasn't sure if this had been discussed in Slack or somewhere else, I couldn't find any relevant conversation. 🙂

[ellatrix]

I don't think so. I'm fine with revising that. The difference is that the other transform functions are provided with block attributes, in this case they would be shortcode attributes.

[mcsf]

Talking about the difference between the examples in the docs, all of the transform types provide a transform property, which is a function to create the block, except for the shortcode type, which has the attributes property, instead. I wasn't sure if this had been discussed in Slack or somewhere else, I couldn't find any relevant conversation.

I know I raised this way way back somewhere in a comment, deep in the GitHub mist.

[ellatrix]

Is this your answer to everything? :)

[mcsf]

😄