Prompt for ignoreURLParametersMatching in workbox wizard

[jeffposnick]

For background, see https://stackoverflow.com/questions/66229902/

We can add a question to workbox wizard that checks to see if the developer has a web app manifest with a start_url that uses a query parameter, like homescreen=true or something else other than utm_ or fbclid, and if so, sets up the ignoreURLParametersMatching parameter for them.

[ognjenjevremovic]

Hey @jeffposnick 👋

I have been developing a PWA lately for my personal website and found workbox to be super useful! (Thanks GoogleChrome dev team for such an amazing tool 🥳 ).

I wanted to contribute to the project and saw this issue open and labeled as a good first issue.
Since I didn't make any PR to workbox previously, I find this issue to be very welcoming to first time contributors to the project.
Can you confirm that issue is still open (with no work being done) and is up for grabs? 🙂

If so, can you please provide more info on where one could start in order to successfully implement this?

Many thanks! 🎉

[jeffposnick]

Thanks for the kind words, and the offer to help! It would be appreciated.

The code for workbox-cli is in TypeScript, so it would help if you're comfortable with that. Otherwise, we can provide some guidance during a PR review.

There are three pieces of the codebase you'd have to modify:

• A new question under that would live in this directory. You can use any of the existing questions as a guide. The question's return value should be an array of RegExp objects, and the default value should be [/^utm_/, /^fbclid$/], to match the current inferred default.

• ask-questions.ts, which is the list of questions asked during the wizard process. You'd want to run the new "question" code here, save the result to a local variable, and set config.ignoreURLParametersMatching based on the answer to the question.

• Modify the existing ask-questions.js and add a new test for your question in the test suite. After making those changes, ensure that npx gulp test_node passes.

Let me know if that all sounds reasonable, and please do reach out if anything doesn't work as expected!

[ognjenjevremovic]

Thank you so much for a prompt response and for the detailed instructions regarding this issue.
I'll be sure to take a closer look and hopefully report back with the PR in the upcoming days 🙂 .

I'll be sure to write back if something is unclear or I need a further guidance.