Next.js添加next-sitemap配置后构建启动失败求助

问题详情 #

为实现SEO优化，在next.config.js中添加了如下next-sitemap配置：

// next.config.js
const withSitemap = require('next-sitemap');

module.exports = withSitemap({
  changefreq: 'weekly', 
  priority: 0.9,
  generateRobotsTxt: true, 
});

执行next build命令时触发以下错误：

> Build error occurred
Error: Cannot find module '/root/node_modules/next-sitemap/dist/cjs/index.js'
    at createEsmNotFoundErr (node:internal/modules/cjs/loader:1094:15)
    at finalizeEsmResolution (node:internal/modules/cjs/loader:1087:15)
    at resolveExports (node:internal/modules/cjs/loader:571:14)
    at Module._findPath (node:internal/modules/cjs/loader:645:31)
    at Module._resolveFilename (node:internal/modules/cjs/loader:1058:27)
    at /root/node_modules/next/dist/server/require-hook.js:113:36
    at Module._load (node:internal/modules/cjs/loader:925:27)
    at Module.require (node:internal/modules/cjs/loader:1139:19)
    at require (node:internal/modules/helpers:121:18)
    at Object.<anonymous> (/root/next.config.js:1:21) {
  code: 'MODULE_NOT_FOUND',
  path: '/root/node_modules/next-sitemap/package.json'
}

已尝试卸载重装node_modules，问题仍未解决。

可行解决方法 #

• 匹配版本兼容性：next-sitemap与Next.js版本存在兼容要求，比如Next.js 13+需搭配next-sitemap@4.x及以上版本，旧版Next.js对应低版本依赖。先查看项目中Next.js版本，再安装对应版本：

  # 示例：安装适配Next.js 12的稳定版本
  npm install next-sitemap@3.1.42 --save-dev
  

• 确认依赖安装状态：检查package.json是否包含next-sitemap依赖，若没有则手动安装开发依赖：

  npm install next-sitemap --save-dev
  

• 调整导入方式：新版next-sitemap默认使用ES模块，若项目采用CommonJS规范，需调整导入代码或使用兼容版本。ES模块方式示例：

  // next.config.js
  import withSitemap from 'next-sitemap';
  
  export default withSitemap({
    changefreq: 'weekly', 
    priority: 0.9,
    generateRobotsTxt: true, 
  });
  

  同时需在package.json中添加"type": "module"。
• 清理所有缓存：除删除node_modules，还需清理npm缓存和Next.js构建缓存：

  npm cache clean --force
  rm -rf .next
  npm install
  

• 检查目录权限：错误路径指向/root/node_modules，可能存在权限问题。确保当前用户对该目录有读写权限，或切换非root用户执行构建操作。

内容的提问来源于stack exchange，提问作者nayatrov