fix(gatsby): Allow overriding options for default instance of gatsby-plugin-page-creator

[akshayymahajan]

Description

Override the default options for gatsby-plugin-page-creator with options specified in gatsby-config.js

Related Issues

Fixes #17379

[akshayymahajan]

This is my first attempt at contributing to gatsbyjs, would really appreciate some feedback..

[karlhorky]

Hm, seems like this 1) added by themes can be shadowed test is failing:

CypressError: Timed out retrying: Expected to find element: '[data-testid="title"]', but never found it.

https://circleci.com/gh/gatsbyjs/gatsby/217604?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link

Not sure what that could be, maybe unrelated to this? Wonder if master is currently passing...

[akshayymahajan]

Yes @karlhorky. But when I try to run the same e2e test locally on my system, it passes all the tests without any issue..

[muescha]

Somehow at a first glimpse the code not do the expected...

A) it overwrites the plugin options with default. But it should be otherwise. The default with the specific

B) if there found the plugin with the same path it should not pushed a second time.

As I understand the documentation of the plugin:

a) it is by default activated (pushed to plugins)
b) if it defined manually in plugins it uses the new options (overwriting options from default one)
c) no additional push of the plugin at the end if there is a manual defined plugin with /src/pages

@wardpeet could confirm my assumptions?

[muescha]

It should not match only the last chars but the full path, because all path for this plugin are full path

[muescha]

can be also ${__dirname}/myguides/src/pages

[akshayymahajan]

Updated the condition to override the defaults only if the path matches <program.directory>/src/pages

[sidharthachatterjee]

Looks good! Thanks for picking this up @akshayymahajan 👍

[gatsbot]

Holy buckets, @akshayymahajan — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

[sidharthachatterjee]

Published in gatsby@2.15.11