NNext.js 中文网 GitHub

turbopack.ignoreIssue

从 CLI 输出和错误遮罩中抑制特定的 Turbopack 错误和警告。

turbopack.ignoreIssue 选项允许你过滤掉特定的 Turbopack 错误和警告,使其不出现在 CLI 输出或错误遮罩中。这对于抑制不影响应用的已知警告很有用,例如有意未解析的可选依赖。

此选项仅在使用 Turbopack(next dev --turbopack)时可用。

用法#

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/vendor/**',
      },
    ],
  },
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/vendor/**',
      },
    ],
  },
}

module.exports = nextConfig

选项#

ignoreIssue 数组中的每条规则都是一个具有以下字段的对象:

字段类型必需描述
path`string \RegExp`是
title`string \RegExp`否
description`string \RegExp`否

当某个问题与规则中的 path以及所有其他指定字段匹配时,该问题将被抑制。如果仅提供 path,则来自匹配文件的任何问题都会被抑制。

小知识: 问题的标题和描述可能会在 Turbopack 版本之间发生变化。path 字段通常比较稳定,但不能保证对所有问题类型都保持一致。可能的话,优先使用更具体的 path 模式,而不是 title 或 description 匹配。

path#

匹配问题来源文件路径的glob 模式(为字符串时)或正则表达式。

next.config.js
module.exports = {
  turbopack: {
    ignoreIssue: [
      // Glob 模式:抑制来自 vendor/ 下任何文件的问题
      { path: '**/vendor/**' },
      // 正则表达式:抑制来自匹配某个模式的文件的问题
      { path: /node_modules\/legacy-lib/ },
    ],
  },
}

title#

与问题标题匹配的精确字符串匹配(为字符串时)或正则表达式。

next.config.js
module.exports = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/src/**',
        title: 'Module not found',
      },
    ],
  },
}

description#

与问题描述匹配的精确字符串匹配(为字符串时)或正则表达式。

next.config.js
module.exports = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/src/**',
        description: /Cannot find module 'optional-dep'/,
      },
    ],
  },
}

示例#

抑制可选依赖的警告#

如果你的代码在可选的 require() 调用周围使用 try/catch,Turbopack 可能会报告"Module not found"警告。你可以抑制它:

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/lib/optional-feature/**',
        title: 'Module not found',
      },
    ],
  },
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  turbopack: {
    ignoreIssue: [
      {
        path: '**/lib/optional-feature/**',
        title: 'Module not found',
      },
    ],
  },
}

module.exports = nextConfig

组合多条规则#

你可以指定多条规则来抑制不同的问题:

next.config.js
module.exports = {
  turbopack: {
    ignoreIssue: [
      { path: '**/vendor/**' },
      { path: '**/legacy/**', title: 'Module not found' },
      { path: /generated\//, description: /expected identifier/ },
    ],
  },
}

版本历史#

版本变更
v16.2.0引入 turbopack.ignoreIssue。
Next.js 中文网