Public Release Tasks

[harlan-zw]

These are several items that should be completed for the public release of the module. Any contributions are more than welcome.

Tasks for the public announcement: #47

Nuxt

• Add stub for useScript to Nuxt core (docs: add third parties + scripts documentation nuxt#26854 & feat(nuxt): prompt to install nuxt/scripts on usage nuxt#27010 (comment))

Benchamarks

• See what the overhead of using registry script is - 2.09kb gzipped for fathom analytics
• Test web vitals & PSI with / without useScript - not meaningful by itself, too much variability

Documentation

Content

(some content exists on all these pages it just needs polishing)

Getting started

• Introduction
• Installation
• Tutorial: js-confetti
• Reproductions - add a stackblitz demo repo

Guides

• Script Loading
• Script Triggers
• Bundling
• Consent
• Page Events
• Global Scripts

API

• useScript
• createConsentScriptTrigger
• useElementScriptTrigger
• useAnalyticsPageEvent
• Nuxt Config
• Nuxt App Hooks
• Nuxt Hooks

Registry

(see below)

Read Me

• Better background details, more concise and informative.

Home Page

• Benchmarks

Nuxt Scripts

Tests

• Consuming module

  • Playground installing module externally working
    • Generate
    • Build
  • StackBlitz working

• e2e Trigger tests

  • onNuxtReady
  • manual
  • visibility
  • mouseover

Registry Scripts

The initial implementation for all of these scripts is complete. No new scripts should be added at this stage.

The below require proper documentation and sanity checks on implementation. There is some tree-shaking improvements to be made, see Cloudflare Web Analytics example as it's complete.

We also need to properly document which scripts can be bundled.

Analytics

• cloudflare-web-analytics
• fathom-analytics
• google-analytics
• matomo-analytics
• plausible-analytics

Content

• google-maps
• vimeo-player
• youtube-player

Marketing

• intercom
• hotjar

Payments

• lemon-squeezy
• stripe

Tracking

• meta-pixel
• google-tag-manager
• segment
• x-pixel

Util

• npm
• ❓ Drop the confetti script and replace it with just a usage example of npm

[oritwoen]

From my own observation, it makes sense to add e2e tests for Registry Scripts to the list.

Especially when it comes to analytics, they like to "go crazy". I tried to run Google Analytics and use events but it didn't work at all, hence my suggestion to add tests to the registry as well.

Maybe I was doing something wrong in general (I was using the documentation). Anyway, this is a suggestion and if I still have a problem with it after updating the packages, I will make an issue and reproduce it.

[harlan-zw]

Thank you for the feedback @oritwoen. Unfortunately to do an e2e test with the registry scripts is not fully possible for all scripts, we can support it for registry scripts that expose an API to check the data we send it.

I've setup a Google Analytics Reproduction and it seems to be working correctly.

If you can provide the code you had an issue with or a reproduction it would help.

Also please make a new issue, I'm going to close this one 🙏