next.config.js ajv verification: analyticsId - must NOT have additional properties

[bonesoul]

Verify canary release

• I verified that the issue exists in the latest Next.js canary release

Provide environment information

    Operating System:
      Platform: win32
      Arch: x64
      Version: Windows 10 Pro
    Binaries:
      Node: 18.4.0
      npm: N/A
      Yarn: N/A
      pnpm: N/A
    Relevant packages:
      next: 12.2.3
      eslint-config-next: 12.2.3
      react: 18.2.0
      react-dom: 18.2.0

What browser are you using? (if relevant)

chrome

How are you deploying your application? (if relevant)

next start

Describe the Bug

seems next 12.2.3 do now validates next.config.js with ajv (#38498).

As I'm using vercel analytics on my non-vercel deployments, I need to hand in the analyticsId property to next.config.js.

/**
 * @type {import('next').NextConfig}
 **/
const config = {
  trailingSlash: false, // disable trailing slashes.
  poweredByHeader: false, // disable powered by header.
  reactStrictMode: true, // set strict mode for react.
  swcMinify: true, // minify using swc/rust.
  compress: false, // let nginx handle compression.
  analyticsId: "MY_ANALYTICS_ID", // vercel analytics id.

and at the very startup next 12.2.3 now warns about the analyticsId property:

warn  - Invalid next.config.js options detected:
[
  {
    "instancePath": "",
    "schemaPath": "#/additionalProperties",
    "keyword": "additionalProperties",
    "params": {
      "additionalProperty": "analyticsId"
    },
    "message": "must NOT have additional properties"
  }
]
See more info here: https://nextjs.org/docs/messages/invalid-next-config

Expected Behavior

allow analyticsId property without a warning.

Link to reproduction

.

To Reproduce

add analyticsId from vercel to next.config.js.

[tatwater]

Getting this same error when using next-pwa! In this case, the additionalProprty it doesn't like is "pwa"

[ijjk]

Hi @tatwater, that is expected as next-pwa is passing an additional config value to Next.js which isn't a valid value so to remove this warning it would need to be corrected in that package.

[theoludwig]

Related next-pwa issue: shadowwalker/next-pwa#367

[chrisleyva]

Hi @tatwater, that is expected as next-pwa is passing an additional config value to Next.js which isn't a valid value so to remove this warning it would need to be corrected in that package.

Hello @ijjk Looking at the Next docs for setting up the MDX plugin, is pageExtensions a valid config value? How would the plug-in work now with this new ajv verification feature?

Thank you.

[ijjk]

@chrisleyva yes pageExtensions is a valid config as can be seen here

next.js/packages/next/server/config-schema.ts

Line 542 in e955850

pageExtensions: {

[amaralc]

Same issue here when using NX and exportPathMap:

warn  - Invalid next.config.js options detected:
--
[
  {
    "instancePath": "",
    "schemaPath": "#/additionalProperties",
    "keyword": "additionalProperties",
    "params": {
    "additionalProperty": "nx"
  },
  "message": "must NOT have additional properties"
  },
  {
    "instancePath": "",
    "schemaPath": "#/additionalProperties",
    "keyword": "additionalProperties",
    "params": {
      "additionalProperty": "exportPathMap"
    },
    "message": "must NOT have additional properties"
  }
]

[ijjk]

The exportPathMap warning does look like a bug, PR opened here #39171 to address that

[hafizasadabbas]

Same issue when using i18n in next.config.js

warn - Invalid next.config.js options detected:
[
{
"instancePath": "/i18n",
"schemaPath": "#/properties/i18n/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "localePath"
},
"message": "must NOT have additional properties"
},
{
"instancePath": "/i18n",
"schemaPath": "#/properties/i18n/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "localeDir"
},
"message": "must NOT have additional properties"
}
]