Skip to content
← Back to rules

nextjs/next-script-for-ga 正确性

作用

在 Next.js 应用中实现 Google Analytics 时,强制使用 next/script 组件, 而不是使用普通的 <script> 标签。

为什么这不好?

为 Google Analytics 使用普通的 <script> 标签可能会导致若干问题:

  • 脚本可能以阻塞方式加载,影响页面性能
  • 没有 Next.js 提供的内置优化或加载策略
  • 缺少 Next.js 提供的自动资源处理

示例

以下是此规则的 错误 代码示例:

jsx
// 使用普通 script 标签加载 GA 源
<script src="https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID"></script>

// 使用内联脚本初始化 GA
<script dangerouslySetInnerHTML={{
  __html: `
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag('js', new Date());
    gtag('config', 'GA_MEASUREMENT_ID');
  `
}} />

以下是此规则的 正确 代码示例:

jsx
import Script from 'next/script'

// 使用 next/script 加载 GA 源
<Script
  src="https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID"
  strategy="lazyOnload"
/>

// 使用 next/script 初始化 GA
<Script id="google-analytics">
  {`
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag('js', new Date());
    gtag('config', 'GA_MEASUREMENT_ID');
  `}
</Script>

如何使用

To enable this rule using the config file or in the CLI, you can use:

json
{
  "plugins": ["nextjs"],
  "rules": {
    "nextjs/next-script-for-ga": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["nextjs"],
  rules: {
    "nextjs/next-script-for-ga": "error",
  },
});
bash
oxlint --deny nextjs/next-script-for-ga --nextjs-plugin

版本

此规则于 v0.2.0 中添加。

参考资料