fix: updated tests, reduced impact of tsconfig updates by limiting it…

… to migration users
vercel · Feb 14, 2023 · 624f433 · 624f433
1 parent 764969d
commit 624f433
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 8 deletions.
diff --git a/packages/next/src/lib/typescript/writeAppTypeDeclarations.ts b/packages/next/src/lib/typescript/writeAppTypeDeclarations.ts
@@ -63,6 +63,7 @@ export async function writeAppTypeDeclarations({
 
   // Push the notice in.
   directives.push(
+    '',
     '// NOTE: This file should not be edited',
     '// see https://nextjs.org/docs/basic-features/typescript for more information.'
   )

diff --git a/packages/next/src/lib/typescript/writeConfigurationDefaults.ts b/packages/next/src/lib/typescript/writeConfigurationDefaults.ts
@@ -109,7 +109,8 @@ export async function writeConfigurationDefaults(
   tsConfigPath: string,
   isFirstTimeSetup: boolean,
   isAppDirEnabled: boolean,
-  distDir: string
+  distDir: string,
+  hasPagesDir: boolean
 ): Promise<void> {
   if (isFirstTimeSetup) {
     await fs.writeFile(tsConfigPath, '{}' + os.EOL)
@@ -230,6 +231,7 @@ export async function writeConfigurationDefaults(
       // If `strict` is set to `false` or `strictNullChecks` is set to `false`,
       // then set `strictNullChecks` to `true`.
       if (
+        hasPagesDir &&
         isAppDirEnabled &&
         !userTsConfig.compilerOptions.strict &&
         !('strictNullChecks' in userTsConfig.compilerOptions)

diff --git a/packages/next/src/lib/verifyTypeScriptSetup.ts b/packages/next/src/lib/verifyTypeScriptSetup.ts
@@ -124,7 +124,8 @@ export async function verifyTypeScriptSetup({
       resolvedTsConfigPath,
       intent.firstTimeSetup,
       isAppDirEnabled,
-      distDir
+      distDir,
+      hasPagesDir
     )
     // Write out the necessary `next-env.d.ts` file to correctly register
     // Next.js' types:

diff --git a/test/unit/write-app-declarations.test.ts b/test/unit/write-app-declarations.test.ts
@@ -9,6 +9,9 @@ const declarationFile = join(fixtureDir, 'next-env.d.ts')
 const imageImportsEnabled = false
 
 describe('find config', () => {
+  beforeEach(async () => {
+    await fs.ensureDir(fixtureDir)
+  })
   afterEach(() => fs.remove(declarationFile))
 
   it('should preserve CRLF EOL', async () => {
@@ -25,10 +28,14 @@ describe('find config', () => {
       '// see https://nextjs.org/docs/basic-features/typescript for more information.' +
       eol
 
-    await fs.ensureDir(fixtureDir)
     await fs.writeFile(declarationFile, content)
 
-    await writeAppTypeDeclarations(fixtureDir, imageImportsEnabled)
+    await writeAppTypeDeclarations({
+      baseDir: fixtureDir,
+      imageImportsEnabled,
+      hasPagesDir: false,
+      isAppDirEnabled: false,
+    })
     expect(await fs.readFile(declarationFile, 'utf8')).toBe(content)
   })
 
@@ -46,10 +53,14 @@ describe('find config', () => {
       '// see https://nextjs.org/docs/basic-features/typescript for more information.' +
       eol
 
-    await fs.ensureDir(fixtureDir)
     await fs.writeFile(declarationFile, content)
 
-    await writeAppTypeDeclarations(fixtureDir, imageImportsEnabled)
+    await writeAppTypeDeclarations({
+      baseDir: fixtureDir,
+      imageImportsEnabled,
+      hasPagesDir: false,
+      isAppDirEnabled: false,
+    })
     expect(await fs.readFile(declarationFile, 'utf8')).toBe(content)
   })
 
@@ -67,8 +78,36 @@ describe('find config', () => {
       '// see https://nextjs.org/docs/basic-features/typescript for more information.' +
       eol
 
-    await fs.ensureDir(fixtureDir)
-    await writeAppTypeDeclarations(fixtureDir, imageImportsEnabled)
+    await writeAppTypeDeclarations({
+      baseDir: fixtureDir,
+      imageImportsEnabled,
+      hasPagesDir: false,
+      isAppDirEnabled: false,
+    })
     expect(await fs.readFile(declarationFile, 'utf8')).toBe(content)
   })
+
+  it('should include navigation types if app directory is enabled', async () => {
+    await writeAppTypeDeclarations({
+      baseDir: fixtureDir,
+      imageImportsEnabled,
+      hasPagesDir: false,
+      isAppDirEnabled: true,
+    })
+
+    await expect(fs.readFile(declarationFile, 'utf8')).resolves.toContain(
+      'next/navigation-types/navigation'
+    )
+
+    await writeAppTypeDeclarations({
+      baseDir: fixtureDir,
+      imageImportsEnabled,
+      hasPagesDir: true,
+      isAppDirEnabled: true,
+    })
+
+    await expect(fs.readFile(declarationFile, 'utf8')).resolves.toContain(
+      'next/navigation-types/compat/navigation'
+    )
+  })
 })