test.ts

import path from 'path';
import test from 'ava';
import {verify, verifyWithFileName} from './fixtures/utils';
import tsd from '..';
import {Diagnostic} from '../lib/interfaces';

test('throw if no type definition was found', async t => {
	await t.throwsAsync(tsd({cwd: path.join(__dirname, 'fixtures/no-tsd')}), {message: 'The type definition `index.d.ts` does not exist. Create one and try again.'});
});

test('throw if no test is found', async t => {
	await t.throwsAsync(tsd({cwd: path.join(__dirname, 'fixtures/no-test')}), {message: 'The test file `index.test-d.ts` or `index.test-d.tsx` does not exist. Create one and try again.'});
});

test('return diagnostics', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/failure')});

	verify(t, diagnostics, [
		[5, 19, 'error', 'Argument of type \'number\' is not assignable to parameter of type \'string\'.']
	]);
});

test('return diagnostics from imported files as well', async t => {
	const cwd = path.join(__dirname, 'fixtures/failure-nested');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[5, 19, 'error', 'Argument of type \'number\' is not assignable to parameter of type \'string\'.', 'child.test-d.ts'],
		[6, 19, 'error', 'Argument of type \'number\' is not assignable to parameter of type \'string\'.', 'index.test-d.ts'],
	]);
});

test('fail if typings file is not part of `files` list', async t => {
	const cwd = path.join(__dirname, 'fixtures/no-files');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[3, 1, 'error', 'TypeScript type definition `index.d.ts` is not part of the `files` list.', 'package.json'],
	]);
});

test('allow specifying folders containing typings file in `files` list', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/files-folder')});

	verify(t, diagnostics, []);
});

test('allow specifying negative gitignore-style patterns in `files` list', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/files-gitignore-patterns/negative-pattern')});

	verify(t, diagnostics, [
		[3, 1, 'error', 'TypeScript type definition `index.d.ts` is not part of the `files` list.'],
	]);
});

test('allow specifying negated negative (positive) gitignore-style patterns in `files` list', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/files-gitignore-patterns/negative-pattern-negated')});

	verify(t, diagnostics, []);
});

test('allow specifying root marker (/) gitignore-style patterns in `files` list', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/files-gitignore-patterns/root-marker-pattern')});

	verify(t, diagnostics, []);
});

test('allow specifying glob patterns containing typings file in `files` list', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/files-glob')});

	verify(t, diagnostics, []);
});

test('fail if `typings` property is used instead of `types`', async t => {
	const cwd = path.join(__dirname, 'fixtures/types-property/typings');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[3, 1, 'error', 'Use property `types` instead of `typings`.', 'package.json'],
	]);
});

test('fail if tests don\'t pass in strict mode', async t => {
	const cwd = path.join(__dirname, 'fixtures/failure-strict-null-checks');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[
			4,
			19,
			'error',
			'Argument of type \'number | null\' is not assignable to parameter of type \'number\'.\n  Type \'null\' is not assignable to type \'number\'.',
			'index.test-d.ts',
		],
	]);
});

test('overridden config defaults to `strict` if `strict` is not explicitly overridden', async t => {
	const cwd = path.join(__dirname, 'fixtures/strict-null-checks-as-default-config-value');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[
			4,
			19,
			'error',
			'Argument of type \'number | null\' is not assignable to parameter of type \'number\'.\n  Type \'null\' is not assignable to type \'number\'.',
			'index.test-d.ts',
		],
	]);
});

test('fail if types are used from a lib that was not explicitly specified', async t => {
	const cwd = path.join(__dirname, 'fixtures/lib-config/failure-missing-lib');
	const diagnostics = await tsd({cwd});

	verifyWithFileName(t, cwd, diagnostics, [
		[1, 22, 'error', 'Cannot find name \'Window\'.', 'index.d.ts'],
		[4, 11, 'error', 'Cannot find name \'Window\'.', 'index.test-d.ts'],
	]);
});

test('allow specifying a lib as a triple-slash-reference', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/lib-config/lib-as-triple-slash-reference')});

	verify(t, diagnostics, []);
});

test('allow specifying a lib in package.json\'s `tsd` field', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/lib-config/lib-from-package-json')});

	verify(t, diagnostics, []);
});

test('allow specifying a lib in tsconfig.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/lib-config/lib-from-tsconfig-json')});

	verify(t, diagnostics, []);
});

test('use moduleResolution `nodenext` when module is `nodenext` in tsconfig.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/module-resolution/nodenext-from-tsconfig-json')});

	verify(t, diagnostics, []);
});

test('use moduleResolution `nodenext` when module is `nodenext` in package.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/module-resolution/nodenext-from-package-json')});

	verify(t, diagnostics, []);
});

test('use moduleResolution `node16` when module is `node16` in tsconfig.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/module-resolution/node16-from-tsconfig-json')});

	verify(t, diagnostics, []);
});

test('use moduleResolution `node16` when module is `node16` in package.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/module-resolution/node16-from-package-json')});

	verify(t, diagnostics, []);
});

test('add support for esm with esModuleInterop', async t => {
	const diagnostics = await tsd({
		cwd: path.join(__dirname, 'fixtures/esm')
	});

	verify(t, diagnostics, []);
});

test('add DOM support by default', async t => {
	const diagnostics = await tsd({
		cwd: path.join(__dirname, 'fixtures/dom')
	});

	verify(t, diagnostics, []);
});

test('a lib option in package.json overrdides a lib option in tsconfig.json', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/lib-config/lib-from-package-json-overrides-tsconfig-json')});

	verify(t, diagnostics, []);
});

test('pass in loose mode when strict mode is disabled in settings', async t => {
	const diagnostics = await tsd({
		cwd: path.join(__dirname, 'fixtures/non-strict-check-with-config')
	});

	verify(t, diagnostics, []);
});

test('return no diagnostics', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/success')});

	verify(t, diagnostics, []);
});

test('support non-barrel main', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/test-non-barrel-main')});

	verify(t, diagnostics, []);
});

test('allow omitting `types` property when `main` property is missing but main is a barrel (`index.js`) and .d.ts file matches main', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/no-explicit-types-property/without-main')});

	verify(t, diagnostics, [
		[6, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('allow omitting `types` property when `main` property is set to a barrel (`index.js`) and .d.ts file matches main', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/no-explicit-types-property/with-main-barrel')});

	verify(t, diagnostics, [
		[6, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('allow omitting `types` property when `main` property is set to non-barrel (`foo.js`) and .d.ts file matches main', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/no-explicit-types-property/with-main-other')});

	verify(t, diagnostics, [
		[6, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('support testing in sub-directories', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/test-in-subdir')});

	verify(t, diagnostics, []);
});

test('support top-level await', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/top-level-await')});

	verify(t, diagnostics, []);
});

test('support default test directory', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/test-directory/default')});

	verify(t, diagnostics, []);
});

test('support tsx in subdirectory', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/test-directory/tsx')});

	verify(t, diagnostics, []);
});

test('support setting a custom test directory', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/test-directory/custom')});

	verify(t, diagnostics, [
		[4, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('expectError for classes', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/classes')});

	verify(t, diagnostics, []);
});

test('expectError for functions', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/functions')});

	verify(t, diagnostics, [
		[5, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('expectError for generics', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/generics')});

	verify(t, diagnostics, []);
});

test('expectError should not ignore syntactical errors', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/syntax')});

	verify(t, diagnostics, [
		[4, 29, 'error', '\')\' expected.'],
		[5, 22, 'error', '\',\' expected.'],
		[4, 0, 'error', 'Expected an error, but found none.'],
		[5, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('expectError for values', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/values')});

	verify(t, diagnostics, [
		[5, 0, 'error', 'Expected an error, but found none.']
	]);
});

test('expectError for values (noImplicitAny disabled)', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/expect-error/values-disabled-no-implicit-any')});

	verify(t, diagnostics, []);
});

test('missing import', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/missing-import')});

	verify(t, diagnostics, [
		[3, 18, 'error', 'Cannot find name \'Primitive\'.']
	]);
});

test('tsx component', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/tsx/component')});

	verify(t, diagnostics, []);
});

test('tsx component type', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/tsx/component-type')});

	verify(t, diagnostics, []);
});

test('loose types', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/strict-types/loose')});

	verify(t, diagnostics, [
		[5, 0, 'error', 'Parameter type `string` is declared too wide for argument type `"cat"`.'],
		[7, 0, 'error', 'Parameter type `string | number` is declared too wide for argument type `string`.'],
		[8, 0, 'error', 'Parameter type `string | number` is declared too wide for argument type `number`.'],
		[10, 0, 'error', 'Parameter type `string | Date` is declared too wide for argument type `Date`.'],
		[11, 0, 'error', 'Parameter type `Promise<string | number>` is declared too wide for argument type `Promise<number>`.'],
		[12, 0, 'error', 'Parameter type `string | Promise<string | number>` is declared too wide for argument type `Promise<string | number>`.'],
		[14, 0, 'error', 'Parameter type `Promise<string | number>` is declared too wide for argument type `Promise<number>`.'],
		[16, 0, 'error', 'Parameter type `Observable<string | number>` is declared too wide for argument type `Observable<string>`.'],
		[20, 0, 'error', 'Parameter type `Observable<string | number> | Observable<string | number | boolean>` is declared too wide for argument type `Observable<string | number> | Observable<string>`.'],
		[28, 0, 'error', 'Parameter type `Foo<string | Foo<string | number>> | Foo<Date> | Foo<Symbol>` is declared too wide for argument type `Foo<Date> | Foo<Symbol> | Foo<string | Foo<number>>`.'],
		[32, 0, 'error', 'Parameter type `string | number` is not identical to argument type `any`.'],
		[34, 0, 'error', 'Parameter type `Observable<any> | Observable<string | number> | Observable<string | number | boolean>` is not identical to argument type `Observable<string | number> | Observable<string> | Observable<string | number | boolean>`.']
	]);
});

test('strict types', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/strict-types/strict')});

	verify(t, diagnostics, []);
});

test('typings in custom directory', async t => {
	const diagnostics = await tsd({
		cwd: path.join(__dirname, 'fixtures/typings-custom-dir'),
		typingsFile: 'utils/index.d.ts'
	});

	verify(t, diagnostics, [
		[5, 19, 'error', 'Argument of type \'number\' is not assignable to parameter of type \'string\'.']
	]);
});

test('specify test files manually', async t => {
	const diagnostics = await tsd({
		cwd: path.join(__dirname, 'fixtures/specify-test-files'),
		testFiles: [
			'unknown.test.ts'
		]
	});

	verify(t, diagnostics, [
		[5, 19, 'error', 'Argument of type \'number\' is not assignable to parameter of type \'string\'.']
	]);
});

test('fails if typings file is not found in the specified path', async t => {
	const error = await t.throwsAsync(tsd({
		cwd: path.join(__dirname, 'fixtures/typings-custom-dir'),
		typingsFile: 'unknown.d.ts'
	}));

	t.is(error.message, 'The type definition `unknown.d.ts` does not exist. Create one and try again.');
});

test('includes extended config files along with found ones', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/ts-config-extends')});

	verify(t, diagnostics, [
		[6, 64, 'error', 'Not all code paths return a value.'],
	]);
});

test('errors in libs from node_modules are not reported', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/exclude-node-modules')});

	const [nodeModuleDiagnostics, testFileDiagnostics, otherDiagnostics] = diagnostics.reduce<Diagnostic[][]>(
		([nodeModuleDiags, testFileDiags, otherDiags], diagnostic) => {
			if (/[/\\]node_modules[/\\]/.test(diagnostic.fileName)) {
				nodeModuleDiags.push(diagnostic);
			} else if (/[/\\]fixtures[/\\]exclude-node-modules[/\\]/.test(diagnostic.fileName)) {
				testFileDiags.push(diagnostic);
			} else {
				otherDiags.push(diagnostic);
			}

			return [nodeModuleDiags, testFileDiags, otherDiags];
		},
		[[], [], []]
	);

	t.deepEqual(
		nodeModuleDiagnostics.length,
		0,
		'There must be no errors from node_modules folders when standard lib is not available (option `"noLib": true`).',
	);

	t.true(
		otherDiagnostics.length > 0,
		'There must be errors from tsd lib when standard lib is not available (option `"noLib": true`).',
	);

	const alloweOtherFileFailures = [
		/[/\\]lib[/\\]index.d.ts$/,
		/[/\\]lib[/\\]interfaces.d.ts$/,
	];
	otherDiagnostics.forEach(diagnostic => {
		t.true(
			alloweOtherFileFailures.some(allowedFileRe => allowedFileRe.test(diagnostic.fileName)),
			`Found diagnostic from an unexpected file: ${diagnostic.fileName} - ${diagnostic.message}`,
		);
	});

	verify(t, testFileDiagnostics, [
		[3, 18, 'error', 'Cannot find name \'Bar\'.']
	]);
});

test('allow specifying `rootDir` option in `tsconfig.json`', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/root-dir')});

	verify(t, diagnostics, []);
});

test('prints the types of expressions passed to `printType` helper', async t => {
	const diagnostics = await tsd({cwd: path.join(__dirname, 'fixtures/print-type')});

	verify(t, diagnostics, [
		[4, 0, 'warning', 'Type for expression `aboveZero` is: `(foo: number) => number | null`'],
		[5, 0, 'warning', 'Type for expression `null` is: `null`'],
		[6, 0, 'warning', 'Type for expression `undefined` is: `undefined`'],
		[7, 0, 'warning', 'Type for expression `null as any` is: `any`'],
		[8, 0, 'warning', 'Type for expression `null as never` is: `never`'],
		[9, 0, 'warning', 'Type for expression `null as unknown` is: `unknown`'],
		[10, 0, 'warning', 'Type for expression `\'foo\'` is: `"foo"`'],
	]);
});