chore(gatsby-source-wordpress): Correct glob pattern examples #11804
Conversation
This is picking up the discussion on the routes documentation within gatsbyjs#10871 and the according pull request gatsbyjs#10887. It adds a test for a pattern that is working both on custom hosted WordPress API paths and on API paths from sites that are hosted on wordpress.com.
| @@ -0,0 +1,17 @@ | |||
| const minimatch = require(`minimatch`) | |||
|
|
|||
| describe.only(`Glob patterns in the README`, () => { | |||
There was a problem hiding this comment.
| describe.only(`Glob patterns in the README`, () => { | |
| describe(`Glob patterns in the README`, () => { |
There was a problem hiding this comment.
Also generally, not really sure what these tests are testing. It looks like we're basically testing minimatch?
There was a problem hiding this comment.
As minimatch is used within checkRouteList I just wanted to (programmatically) show that the suggested patterns would work on both types of WordPress installations. Also as a reference point for futures issues/questions regarding the exclude/include patterns. If more examples/bugs come up, we could extend the tests.
There was a problem hiding this comment.
And thank you for spotting the .only. In other projects I used to have a pre-commit hook for this, spotting .only within tests ... ;)
I corrected it.
There was a problem hiding this comment.
@riddla cool! But generally - we want to test our own code, otherwise updating our code won't make this test fail (ever).
So we would want to actually write some assertions that validate checkRouteList and import that function, or a function that invokes it, in order to test this more effectively.
There was a problem hiding this comment.
Yeah, you're right. After all it's just about the examples in the Readme and not the checkRouteList itself. I removed the test and just added the information that it carried to the commit message. Should be sufficient for future reference, if this topic ever comes up again in some issue.
... in favor of giving just an example for future reference: * Self hosted WordPress API instances are located at `/wp/v2/`, a route example would be `/wp/v2/pages` * WordPress.com API instances are located at `/wp/v2/sites/example.wordpress.com/`, a route example would be `/pages` * The pattern `**/pages` matches both types of installations, see http://www.globtester.com/#p=eJzT0tIvSExPLQYACb4ClA%3D%3D&r=eJyzScksU0jOSSwutlXKTSxJzlCy0y8v0C8z0i9ITE8tttEHytvZYFGEJA0AIzoXRg%3D%3D&.
|
@DSchau would you mind having another look? |
DSchau
changed the title
Description
Adds a test for a route blog pattern that is working both on custom hosted WordPress API paths and on API paths from sites that are hosted on wordpress.com.
Related Issues
This is picking up the discussion on the routes documentation within #10871 and the according pull request #10887.