622f63867a
the behavior of the `eslint.dirs` config option was changed in #26401. this pr adjusts the doc comment accordingly. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes
198 lines
4.7 KiB
TypeScript
198 lines
4.7 KiB
TypeScript
import os from 'os'
|
|
import { Header, Redirect, Rewrite } from '../lib/load-custom-routes'
|
|
import { ImageConfig, imageConfigDefault } from './image-config'
|
|
|
|
type NoOptionals<T> = {
|
|
[P in keyof T]-?: T[P]
|
|
}
|
|
|
|
export type NextConfigComplete = NoOptionals<NextConfig>
|
|
|
|
export interface I18NConfig {
|
|
defaultLocale: string
|
|
domains?: DomainLocale[]
|
|
localeDetection?: false
|
|
locales: string[]
|
|
}
|
|
|
|
export interface DomainLocale {
|
|
defaultLocale: string
|
|
domain: string
|
|
http?: true
|
|
locales?: string[]
|
|
}
|
|
|
|
export interface ESLintConfig {
|
|
/** Only run ESLint on these directories with `next lint` and `next build`. */
|
|
dirs?: string[]
|
|
/** Do not run ESLint during production builds (`next build`). */
|
|
ignoreDuringBuilds?: boolean
|
|
}
|
|
|
|
export type NextConfig = { [key: string]: any } & {
|
|
i18n?: I18NConfig | null
|
|
|
|
eslint?: ESLintConfig
|
|
|
|
headers?: () => Promise<Header[]>
|
|
rewrites?: () => Promise<
|
|
| Rewrite[]
|
|
| {
|
|
beforeFiles: Rewrite[]
|
|
afterFiles: Rewrite[]
|
|
fallback: Rewrite[]
|
|
}
|
|
>
|
|
redirects?: () => Promise<Redirect[]>
|
|
|
|
webpack5?: false
|
|
excludeDefaultMomentLocales?: boolean
|
|
|
|
trailingSlash?: boolean
|
|
env?: { [key: string]: string }
|
|
distDir?: string
|
|
cleanDistDir?: boolean
|
|
assetPrefix?: string
|
|
useFileSystemPublicRoutes?: boolean
|
|
generateBuildId?: () => string | null
|
|
generateEtags?: boolean
|
|
pageExtensions?: string[]
|
|
compress?: boolean
|
|
images?: ImageConfig
|
|
devIndicators?: {
|
|
buildActivity?: boolean
|
|
}
|
|
onDemandEntries?: {
|
|
maxInactiveAge?: number
|
|
pagesBufferLength?: number
|
|
}
|
|
amp?: {
|
|
canonicalBase?: string
|
|
}
|
|
basePath?: string
|
|
sassOptions?: { [key: string]: any }
|
|
productionBrowserSourceMaps?: boolean
|
|
optimizeFonts?: boolean
|
|
reactStrictMode?: boolean
|
|
publicRuntimeConfig?: { [key: string]: any }
|
|
serverRuntimeConfig?: { [key: string]: any }
|
|
|
|
future?: {
|
|
/**
|
|
* @deprecated this options was moved to the top level
|
|
*/
|
|
webpack5?: false
|
|
strictPostcssConfiguration?: boolean
|
|
}
|
|
experimental?: {
|
|
cpus?: number
|
|
plugins?: boolean
|
|
profiling?: boolean
|
|
isrFlushToDisk?: boolean
|
|
reactMode?: 'legacy' | 'concurrent' | 'blocking'
|
|
workerThreads?: boolean
|
|
pageEnv?: boolean
|
|
optimizeImages?: boolean
|
|
optimizeCss?: boolean
|
|
scrollRestoration?: boolean
|
|
stats?: boolean
|
|
externalDir?: boolean
|
|
conformance?: boolean
|
|
amp?: {
|
|
optimizer?: any
|
|
validator?: string
|
|
skipValidation?: boolean
|
|
}
|
|
reactRoot?: boolean
|
|
disableOptimizedLoading?: boolean
|
|
gzipSize?: boolean
|
|
craCompat?: boolean
|
|
esmExternals?: boolean | 'loose'
|
|
staticPageGenerationTimeout?: number
|
|
pageDataCollectionTimeout?: number
|
|
isrMemoryCacheSize?: number
|
|
}
|
|
}
|
|
|
|
export const defaultConfig: NextConfig = {
|
|
env: {},
|
|
webpack: null,
|
|
webpackDevMiddleware: null,
|
|
distDir: '.next',
|
|
cleanDistDir: true,
|
|
assetPrefix: '',
|
|
configOrigin: 'default',
|
|
useFileSystemPublicRoutes: true,
|
|
generateBuildId: () => null,
|
|
generateEtags: true,
|
|
pageExtensions: ['tsx', 'ts', 'jsx', 'js'],
|
|
target: 'server',
|
|
poweredByHeader: true,
|
|
compress: true,
|
|
analyticsId: process.env.VERCEL_ANALYTICS_ID || '',
|
|
images: imageConfigDefault,
|
|
devIndicators: {
|
|
buildActivity: true,
|
|
},
|
|
onDemandEntries: {
|
|
maxInactiveAge: 60 * 1000,
|
|
pagesBufferLength: 2,
|
|
},
|
|
amp: {
|
|
canonicalBase: '',
|
|
},
|
|
basePath: '',
|
|
sassOptions: {},
|
|
trailingSlash: false,
|
|
i18n: null,
|
|
productionBrowserSourceMaps: false,
|
|
optimizeFonts: true,
|
|
webpack5:
|
|
Number(process.env.NEXT_PRIVATE_TEST_WEBPACK4_MODE) > 0 ? false : undefined,
|
|
excludeDefaultMomentLocales: true,
|
|
serverRuntimeConfig: {},
|
|
publicRuntimeConfig: {},
|
|
reactStrictMode: false,
|
|
experimental: {
|
|
cpus: Math.max(
|
|
1,
|
|
(Number(process.env.CIRCLE_NODE_TOTAL) ||
|
|
(os.cpus() || { length: 1 }).length) - 1
|
|
),
|
|
plugins: false,
|
|
profiling: false,
|
|
isrFlushToDisk: true,
|
|
workerThreads: false,
|
|
pageEnv: false,
|
|
optimizeImages: false,
|
|
optimizeCss: false,
|
|
scrollRestoration: false,
|
|
stats: false,
|
|
externalDir: false,
|
|
reactRoot: Number(process.env.NEXT_PRIVATE_REACT_ROOT) > 0,
|
|
disableOptimizedLoading: false,
|
|
gzipSize: true,
|
|
craCompat: false,
|
|
esmExternals: false,
|
|
staticPageGenerationTimeout: 60,
|
|
pageDataCollectionTimeout: 60,
|
|
// default to 50MB limit
|
|
isrMemoryCacheSize: 50 * 1024 * 1024,
|
|
},
|
|
future: {
|
|
strictPostcssConfiguration: false,
|
|
},
|
|
}
|
|
|
|
export function normalizeConfig(phase: string, config: any) {
|
|
if (typeof config === 'function') {
|
|
config = config(phase, { defaultConfig })
|
|
|
|
if (typeof config.then === 'function') {
|
|
throw new Error(
|
|
'> Promise returned in next config. https://nextjs.org/docs/messages/promise-in-next-config'
|
|
)
|
|
}
|
|
}
|
|
return config
|
|
}
|