Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
devjiwonchoi committed Feb 15, 2025
1 parent 22d18d3 commit 38a5abb
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 30 deletions.
8 changes: 0 additions & 8 deletions packages/next/src/server/config-schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -231,14 +231,6 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
.object({
appIsrStatus: z.boolean().optional(),
buildActivity: z.boolean().optional(),
buildActivityPosition: z
.union([
z.literal('bottom-left'),
z.literal('bottom-right'),
z.literal('top-left'),
z.literal('top-right'),
])
.optional(),
position: z
.union([
z.literal('bottom-left'),
Expand Down
16 changes: 9 additions & 7 deletions packages/next/src/server/config-shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -837,11 +837,17 @@ export interface NextConfig extends Record<string, any> {

/** Configure indicators in development environment */
devIndicators?: {
/**
* @deprecated The dev tools indicator has it enabled by default.
* */
appIsrStatus?: boolean

/**
* Show "building..."" indicator in development
* @deprecated The dev tools indicator has it enabled by default.
*/
buildActivity?: boolean

/**
* Position of "building..." indicator in browser
* @deprecated Renamed as `position`.
Expand All @@ -852,13 +858,10 @@ export interface NextConfig extends Record<string, any> {
| 'top-right'
| 'top-left'

/** Position of "building..." indicator in browser */
position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'

/**
* @deprecated The dev tools indicator has it enabled by default.
* Position of "building..." indicator in browser
* */
appIsrStatus?: boolean
position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'
}

/**
Expand Down Expand Up @@ -1104,8 +1107,7 @@ export const defaultConfig: NextConfig = {
compress: true,
images: imageConfigDefault,
devIndicators: {
buildActivityPosition: 'bottom-right',
position: 'bottom-right',
position: 'bottom-left',
},
onDemandEntries: {
maxInactiveAge: 60 * 1000,
Expand Down
31 changes: 16 additions & 15 deletions packages/next/src/server/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ export function warnOptionHasBeenDeprecated(
nestedPropertyKey: string,
reason: string,
silent: boolean
) {
): boolean {
let hasWarned = false
if (!silent) {
let current = config
let found = true
Expand All @@ -69,9 +70,11 @@ export function warnOptionHasBeenDeprecated(
}
}
if (found) {
Log.warn(reason)
Log.warnOnce(reason)
hasWarned = true
}
}
return hasWarned
}

export function warnOptionHasBeenMovedOutOfExperimental(
Expand Down Expand Up @@ -111,7 +114,7 @@ export function warnOptionHasBeenRenamed(
) {
if (config[oldKey]) {
if (!silent) {
Log.warn(
Log.warnOnce(
`\`${oldKey}\` has been renamed to \`${newKey}\`. ` +
`Please update your ${configFileName} file accordingly.`
)
Expand Down Expand Up @@ -505,22 +508,20 @@ function assignDefaults(
silent
)

warnOptionHasBeenRenamed(
const hasWarnedBuildActivityPosition = warnOptionHasBeenDeprecated(
result,
'devIndicators.buildActivityPosition',
'devIndicators.position',
configFileName,
`\`devIndicators.buildActivityPosition\` has been renamed to \`devIndicators.position\`. Please update your ${configFileName} file accordingly.`,
silent
)

if (result.devIndicators?.buildActivityPosition) {
if (result.devIndicators.position) {
Log.warn(
`\`devIndicators.buildActivityPosition\` is conflicting with \`devIndicators.position\`. \`devIndicators.position\` will take precedence.`
)
} else {
result.devIndicators.position = result.devIndicators.buildActivityPosition
}
if (
hasWarnedBuildActivityPosition &&
result.devIndicators?.buildActivityPosition &&
result.devIndicators.buildActivityPosition !== result.devIndicators.position
) {
Log.warnOnce(
`The \`devIndicators\` option \`buildActivityPosition\` ("${result.devIndicators.buildActivityPosition}") conflicts with \`position\` ("${result.devIndicators.position}"). Using \`buildActivityPosition\` for backwardscompatibility.`
)
}

warnOptionHasBeenMovedOutOfExperimental(
Expand Down

0 comments on commit 38a5abb

Please sign in to comment.