feat: add google analytics anonymizeIp in siteConfig

Easier privacy following vuejs#515

Author: abruere

README.md

@@ -51,7 +51,7 @@ https://vuepress.vuejs.org/
 
 * [Multi-Language Support](https://vuepress.vuejs.org/guide/i18n.html)
 * [Service Worker](https://vuepress.vuejs.org/config/#serviceworker)
-* [Google Analytics](https://vuepress.vuejs.org/config/#ga)
+* [Google Analytics, GDPR-compliant](https://vuepress.vuejs.org/config/#ga)
 
 ## Showcase
 

docs/config/README.md

@@ -74,13 +74,25 @@ Specify the output directory for `vuepress build`.
 
 ### ga
 
-- Type: `string`
+- Type: `string | { id: string, anonymizeIp: boolean }`
 - Default: `undefined`
 
-Provide the Google Analytics ID to enable integration.
+Provide the Google Analytics ID as a string to enable integration.
+
+You can also use an object to enable IP anonymization:
+
+``` js
+module.exports = {
+  // …
+  ga: {
+    id: 'UA-XXXX-X',
+    anonymizeIp: true // false by default for backwards compatibility
+  }
+}
+```
 
 ::: tip
-Please be aware of [GDPR (2018 reform of EU data protection rules)](https://ec.europa.eu/commission/priorities/justice-and-fundamental-rights/data-protection/2018-reform-eu-data-protection-rules_en) and consider setting Google Analytics to [anonymize IPs](https://support.google.com/analytics/answer/2763052?hl=en) where appropriate and/or needed.
+Consider setting Google Analytics to [anonymize IPs](https://support.google.com/analytics/answer/2763052?hl=en) using `anonymizeIp: true` setting, to protect user privacy and comply with [GDPR (2018 reform of EU data protection rules)](https://ec.europa.eu/commission/priorities/justice-and-fundamental-rights/data-protection/2018-reform-eu-data-protection-rules_en).
 :::
 
 ### serviceWorker

lib/app/clientEntry.js

@@ -1,4 +1,4 @@
-/* global BASE_URL, GA_ID, ga, SW_ENABLED, VUEPRESS_VERSION, LAST_COMMIT_HASH*/
+/* global BASE_URL, GA_ID, GA_ANONYMIZE_IP, ga, SW_ENABLED, VUEPRESS_VERSION, LAST_COMMIT_HASH*/
 
 import { createApp } from './app'
 import SWUpdateEvent from './SWUpdateEvent'
@@ -27,6 +27,10 @@ if (process.env.NODE_ENV === 'production' && GA_ID) {
   })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga')
 
   ga('create', GA_ID, 'auto')
+
+  // Improved privacy: https://support.google.com/analytics/answer/2763052
+  if (GA_ANONYMIZE_IP) ga('set', 'anonymizeIp', true)
+
   ga('send', 'pageview')
 
   router.afterEach(function (to) {

lib/webpack/createBaseConfig.js

@@ -289,11 +289,15 @@ module.exports = function createBaseConfig ({
   }
 
   // inject constants
+  const hasGaObjectConfig = typeof siteConfig.ga === 'object' && typeof siteConfig.ga.id === 'string'
   config
     .plugin('injections')
     .use(require('webpack/lib/DefinePlugin'), [{
       BASE_URL: JSON.stringify(siteConfig.base || '/'),
-      GA_ID: siteConfig.ga ? JSON.stringify(siteConfig.ga) : false,
+      GA_ID: hasGaObjectConfig
+        ? JSON.stringify(siteConfig.ga.id)
+        : (siteConfig.ga ? JSON.stringify(siteConfig.ga.id) : false),
+      GA_ANONYMIZE_IP: siteConfig.ga && siteConfig.ga.anonymizeIp === true,
       SW_ENABLED: !!siteConfig.serviceWorker,
       VUEPRESS_VERSION: JSON.stringify(require('../../package.json').version),
       LAST_COMMIT_HASH: JSON.stringify(getLastCommitHash())