02c4ce1acf
app dir is always "enabled", but not always exists. Rename to the proper word to describe. Found this confusion while developing other fetaures Closes NEXT-2691
113 lines
3.1 KiB
TypeScript
113 lines
3.1 KiB
TypeScript
/* eslint-env jest */
|
|
import os from 'os'
|
|
import fs from 'fs-extra'
|
|
import { join } from 'path'
|
|
import { writeAppTypeDeclarations } from 'next/dist/lib/typescript/writeAppTypeDeclarations'
|
|
|
|
const fixtureDir = join(__dirname, 'fixtures/app-declarations')
|
|
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 () => {
|
|
const eol = '\r\n'
|
|
const content =
|
|
'/// <reference types="next" />' +
|
|
eol +
|
|
(imageImportsEnabled
|
|
? '/// <reference types="next/image-types/global" />' + eol
|
|
: '') +
|
|
eol +
|
|
'// NOTE: This file should not be edited' +
|
|
eol +
|
|
'// see https://nextjs.org/docs/basic-features/typescript for more information.' +
|
|
eol
|
|
|
|
await fs.writeFile(declarationFile, content)
|
|
|
|
await writeAppTypeDeclarations({
|
|
baseDir: fixtureDir,
|
|
imageImportsEnabled,
|
|
hasPagesDir: false,
|
|
hasAppDir: false,
|
|
})
|
|
expect(await fs.readFile(declarationFile, 'utf8')).toBe(content)
|
|
})
|
|
|
|
it('should preserve LF EOL', async () => {
|
|
const eol = '\n'
|
|
const content =
|
|
'/// <reference types="next" />' +
|
|
eol +
|
|
(imageImportsEnabled
|
|
? '/// <reference types="next/image-types/global" />' + eol
|
|
: '') +
|
|
eol +
|
|
'// NOTE: This file should not be edited' +
|
|
eol +
|
|
'// see https://nextjs.org/docs/basic-features/typescript for more information.' +
|
|
eol
|
|
|
|
await fs.writeFile(declarationFile, content)
|
|
|
|
await writeAppTypeDeclarations({
|
|
baseDir: fixtureDir,
|
|
imageImportsEnabled,
|
|
hasPagesDir: false,
|
|
hasAppDir: false,
|
|
})
|
|
expect(await fs.readFile(declarationFile, 'utf8')).toBe(content)
|
|
})
|
|
|
|
it('should use OS EOL by default', async () => {
|
|
const eol = os.EOL
|
|
const content =
|
|
'/// <reference types="next" />' +
|
|
eol +
|
|
(imageImportsEnabled
|
|
? '/// <reference types="next/image-types/global" />' + eol
|
|
: '') +
|
|
eol +
|
|
'// NOTE: This file should not be edited' +
|
|
eol +
|
|
'// see https://nextjs.org/docs/basic-features/typescript for more information.' +
|
|
eol
|
|
|
|
await writeAppTypeDeclarations({
|
|
baseDir: fixtureDir,
|
|
imageImportsEnabled,
|
|
hasPagesDir: false,
|
|
hasAppDir: 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,
|
|
hasAppDir: true,
|
|
})
|
|
|
|
await expect(fs.readFile(declarationFile, 'utf8')).resolves.not.toContain(
|
|
'next/navigation-types/compat/navigation'
|
|
)
|
|
|
|
await writeAppTypeDeclarations({
|
|
baseDir: fixtureDir,
|
|
imageImportsEnabled,
|
|
hasPagesDir: true,
|
|
hasAppDir: true,
|
|
})
|
|
|
|
await expect(fs.readFile(declarationFile, 'utf8')).resolves.toContain(
|
|
'next/navigation-types/compat/navigation'
|
|
)
|
|
})
|
|
})
|