feat(gatsby-page-utils): extract logic for watching a directory from gatsby-page-creator so can reuse for custom page creation

[frinyvonnick]

Description

It extract logic from gatsby-plugin-page-creator to help creating pages:

• ignorePath
• validatePath
• createPath
• watchDirectory

Related Issues

Closes #13606

[KyleAMathews]

Can you add to the description some sample code showing how someone would use this in their gatsby-node.js?

[pieh]

Should gatsby-plugin-page-creator make use of those extracted utilities to not duplicate code?

[KyleAMathews]

Yeah, what @pieh said. That should be part of this PR.

[frinyvonnick]

Sure I'll add it as soon as I figure out how to extract watching directory functionnality. I have difficulties to know to limit of things to extract. What function signature did you have in mind @KyleAMathews ?

Maybe someone could help on this part by pairing ?

[frinyvonnick]

Maybe someone from @gatsbyjs/core could answer my question about function signature of the watching directory functionnality ? 😄

[freiksenet]

@frinyvonnick Sorry for dropping the ball here!

The API could look something like that:

watchDirectory(
  path: String;
  glob: String;
  onNewFile: (newPath) => void;
  onRemovedFile: (removedPath) => void;
): Promise<undefined>

It should track which files were already created and which were not.

[frinyvonnick]

Thank you @freiksenet, I'll go with it 👌!

[frinyvonnick]

@KyleAMathews I added some documentation and an example in the README.md. Is this good for you ? Should I add documentation somewhere else ?

@freiksenet I implemented the signature you suggested. Seems good to you ?

@gatsbyjs/core can't figure out how to make e2e passes ? Could someone help me on this subject ?

[wardpeet]

mmh let me look into this properly

[wardpeet]

Fingers crossed 🤞.

gatsby-dev didn't copy the plugin as it was a name mismatch between package.json & foldername. Also the watchDirectory export wasn't a default export but I changed all exports to commonjs (require) to be consistent.

[frinyvonnick]

Yeah it works 🎉 thanks for your help @wardpeet! Sorry for the typo 😕

[muescha]

just my suggestions and nitpicks

[frinyvonnick]

Thank you for your review @muescha 👍

[wardpeet]

Yeah it works 🎉 thanks for your help @wardpeet! Sorry for the typo 😕

No need to say sorry, it happens to the best of us 😉

Thanks for doing this!

[frinyvonnick]

@wardpeet this is ready to be merged, no ? 😄

[wardpeet]

Oh yeah definitely, the code looks great.