Add support for setting custom script to activate plausible

cderv · cderv · commit 4d70b70058c9 · 2025-10-09T15:32:05.000+02:00
diff --git a/src/project/types/website/website-analytics.ts b/src/project/types/website/website-analytics.ts
@@ -26,6 +26,9 @@ const kStorage = "storage";
 const kAnonymizeIp = "anonymize-ip";
 const kVersion = "version";
 
+// Plausible analytics
+export const kPlausibleAnalytics = "plausible-analytics";
+
 // Cookie consent properties
 export const kCookieConsent = "cookie-consent";
 const kCookieConsentType = "type";
@@ -77,19 +80,17 @@ ${contents}
   }
 }
 
-// Generate the script to inject into the head for Google Analytics
+// Generate the script to inject into the head for Google Analytics and/or Plausible
 export function websiteAnalyticsScriptFile(
   project: ProjectContext,
   temp: TempContext,
 ) {
-  // Find the ga tag
   const siteMeta = project.config?.[kWebsite] as Metadata;
-
-  // The google analytics metadata (either from the page or the site)
-  // Deal with page and site options
-  let gaConfig: GaConfiguration | undefined = undefined;
+  const scripts: string[] = [];
 
   if (siteMeta) {
+    // Google Analytics
+    let gaConfig: GaConfiguration | undefined = undefined;
     const siteGa = siteMeta[kGoogleAnalytics];
     if (typeof (siteGa) === "object") {
       const siteGaMeta = siteGa as Metadata;
@@ -108,16 +109,24 @@ export function websiteAnalyticsScriptFile(
     } else if (siteGa && typeof (siteGa) === "string") {
       gaConfig = googleAnalyticsConfig(project, siteGa as string);
     }
-  }
 
-  // Generate the actual GA dependencies
-  if (gaConfig) {
-    const script = analyticsScript(gaConfig);
-    if (script) {
-      return scriptFile(script, temp);
-    } else {
-      return undefined;
+    if (gaConfig) {
+      const gaScript = analyticsScript(gaConfig);
+      if (gaScript) {
+        scripts.push(gaScript);
+      }
+    }
+
+    // Plausible Analytics
+    const plausibleSnippet = siteMeta[kPlausibleAnalytics];
+    if (plausibleSnippet && typeof (plausibleSnippet) === "string") {
+      scripts.push(plausibleSnippet);
     }
+  }
+
+  // Return combined script file if we have any analytics
+  if (scripts.length > 0) {
+    return scriptFile(scripts.join("\n"), temp);
   } else {
     return undefined;
   }
diff --git a/src/resources/schema/definitions.yml b/src/resources/schema/definitions.yml
@@ -751,6 +751,23 @@
 
                       This is automatically detected based upon the `tracking-id`, but you may specify it.
         description: "Enable Google Analytics for this website"
+      plausible-analytics:
+        schema: string
+        description:
+          short: "Enable Plausible Analytics for this website by inserting scrips snippets to add in site `<head>`"
+          long: |
+            Enable Plausible Analytics for this website by pasting the script snippet from your Plausible dashboard.
+
+            Plausible is a privacy-friendly, GDPR-compliant web analytics service that does not use cookies and does not require cookie consent.
+
+            To get your script snippet:
+
+            1. Log into your Plausible account at <https://plausible.io>
+            2. Go to your site settings
+            3. Copy the JavaScript snippet provided
+            4. Paste it here
+
+            For more information, see <https://plausible.io/docs/plausible-script>
       announcement:
         anyOf:
           - string
