@docusaurus/plugin-google-analytics
Version:
Global analytics (analytics.js) plugin for Docusaurus.
68 lines (67 loc) • 2.6 kB
JavaScript
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = pluginGoogleAnalytics;
exports.validateOptions = validateOptions;
exports.validateThemeConfig = validateThemeConfig;
const utils_validation_1 = require("@docusaurus/utils-validation");
function pluginGoogleAnalytics(context, options) {
if (process.env.NODE_ENV !== 'production') {
return null;
}
const { trackingID, anonymizeIP } = options;
return {
name: 'docusaurus-plugin-google-analytics',
getClientModules() {
return ['./analytics'];
},
injectHtmlTags() {
return {
headTags: [
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://www.google-analytics.com',
},
},
// https://developers.google.com/analytics/devguides/collection/analyticsjs/#alternative_async_tag
{
tagName: 'script',
innerHTML: `
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', '${trackingID}', 'auto');
${anonymizeIP ? "ga('set', 'anonymizeIp', true);\n" : ''}
ga('send', 'pageview');
`,
},
{
tagName: 'script',
attributes: {
async: true,
src: 'https://www.google-analytics.com/analytics.js',
},
},
],
};
},
};
}
const pluginOptionsSchema = utils_validation_1.Joi.object({
trackingID: utils_validation_1.Joi.string().required(),
anonymizeIP: utils_validation_1.Joi.boolean().default(false),
});
function validateOptions({ validate, options, }) {
return validate(pluginOptionsSchema, options);
}
function validateThemeConfig({ themeConfig, }) {
if ('googleAnalytics' in themeConfig) {
throw new Error('The "googleAnalytics" field in themeConfig should now be specified as option for plugin-google-analytics. More information at https://github.com/facebook/docusaurus/pull/5832.');
}
return themeConfig;
}
;