Skip to content

Document i18n locale limit #27542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 27, 2021
Merged

Document i18n locale limit #27542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bf10db
Document i18n locale limit
ijjk Jul 27, 2021
f8d6ace
mention limit in error doc
ijjk Jul 27, 2021
2be843b
Merge branch 'canary' into docs/i18n-limit
kodiakhq[bot] Jul 27, 2021
d108bb9
Merge branch 'canary' into docs/i18n-limit
kodiakhq[bot] Jul 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/advanced-features/i18n-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,3 +281,8 @@ export const getStaticPaths = ({ locales }) => {
}
}
```

## Limits for the i18n config

- `locales`: 100 total locales
- `domains`: 100 total locale domain items
4 changes: 2 additions & 2 deletions errors/invalid-i18n-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

#### Why This Error

In your `next.config.js` file you provided an invalid config for the `i18n` field.
In your `next.config.js` file you provided an invalid config for the `i18n` field. This could mean the limit for 100 locale items was exceeded.

#### Possible Ways to Fix It

Make sure your `i18n` field follows the allowed config shape and values:
Make sure your `i18n` field follows the allowed config shape, limits, and values:

```js
module.exports = {
Expand Down
6 changes: 6 additions & 0 deletions packages/next/server/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,12 @@ function assignDefaults(userConfig: { [key: string]: any }) {
)
}

if (i18n.locales.length > 100) {
throw new Error(
`Received ${i18n.locales.length} i18n.locales items which exceeds the max of 100, please reduce the number of items to continue.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}

const defaultLocaleType = typeof i18n.defaultLocale

if (!i18n.defaultLocale || defaultLocaleType !== 'string') {
Expand Down