Skip to content
New issue

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

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

Already on GitHub? # to your account

Fix runtime error in writeConfigurationDefaults #76106

Merged
merged 1 commit into from
Feb 17, 2025
Merged
Changes from all commits
Commits
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
28 changes: 12 additions & 16 deletions packages/next/src/lib/typescript/writeConfigurationDefaults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ export function getRequiredConfiguration(
return res
}

const localDevTestFilesExcludeAction =
'NEXT_PRIVATE_LOCAL_DEV_TEST_FILES_EXCLUDE'

export async function writeConfigurationDefaults(
ts: typeof import('typescript'),
tsConfigPath: string,
Expand Down Expand Up @@ -328,27 +331,14 @@ export async function writeConfigurationDefaults(
}

if (hasUpdates) {
requiredActions.push(
'Local development only: Excluded test files from coverage'
)
requiredActions.push(localDevTestFilesExcludeAction)
}
}

if (suggestedActions.length < 1 && requiredActions.length < 1) {
return
}

if (process.env.NEXT_PRIVATE_LOCAL_DEV) {
// remove it from the required actions if it exists
if (
requiredActions[requiredActions.length - 1].includes(
'Local development only'
)
) {
requiredActions.pop()
}
}

await fs.writeFile(
tsConfigPath,
CommentJson.stringify(userTsConfig, null, 2) + os.EOL
Expand Down Expand Up @@ -386,14 +376,20 @@ export async function writeConfigurationDefaults(
Log.info('')
}

if (requiredActions.length) {
const requiredActionsToBeLogged = process.env.NEXT_PRIVATE_LOCAL_DEV
? requiredActions.filter(
(action) => action !== localDevTestFilesExcludeAction
)
: requiredActions

if (requiredActionsToBeLogged.length) {
Log.info(
`The following ${white('mandatory changes')} were made to your ${cyan(
'tsconfig.json'
)}:\n`
)

requiredActions.forEach((action) => Log.info(`\t- ${action}`))
requiredActionsToBeLogged.forEach((action) => Log.info(`\t- ${action}`))

Log.info('')
}
Expand Down
Loading