spomky-labs / phpwa-doc Goto Github PK

At first, I thought the regex documentation was wrong, and started to fix it:

| regex | Matches the regex |

• regex: |/image/.*|
• regex: {.jp(e)?g$}i

Although slash is a common character to use to enclose a regular expression, the examples above show using other characters to avoid needing to escape the slashes in the path. So //articles/./ is the same regex as {/articles/.}. See Regular Expressions for more information. Internally, regeg: maps to new RegExp()

But then when I dug into the code, I see that the new RegExp() format doesn't need the regex to be surrounded. I think this needs to be clearer, especially since when I see something like this:

startsWith: /dashboard
regex: /articles/
regex: |/articles/(\d)+|  # is this valid?

I assume the regex will match any article (without the slashes, since to PHP programmers it will be natural to assume the slashes are necessary for the regex.

workbox.routing.registerRoute(
  new RegExp('{^/products|categories/}')

At the end of my journey down regex lane, here's my trip report:

• the code currently generates new RegExp('$regexString'), which isn't intuitive to PHP programmers and excludes the ability to use flags.
• Instead, I think it should generate the regex string itself, which is javascript, e.g. workbox.routing.registerRoute(/products|categories/, ...
• We could have another matcher, RegExp: that generates what the code currently does, and regex: that generates a javascript regex.

Regardless, the docs should be updated. I'll move my suggestion to an issue in the bundle repo.

The indentation is wrong here: https://pwa.spomky-labs.com/the-service-worker/workbox/warm-caching#page-caching

                      - 'app_articles'
                      - 'app_top_articles'
                        params:
                            display: 5

Can you add a link from the documentation back to the github page, e.g. "See an error? Fix it here..."