forked from typescript-eslint/typescript-eslint
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test(type-utils): add basic tests for isTypeReadonly (typescript-esli…
…nt#4416) * fix(type-utils): make isTypeReadonly's options param optional fix typescript-eslint#4410 * test(type-utils): add basic tests for isTypeReadonly
- Loading branch information
1 parent
5f43b3c
commit 872d020
Showing
1 changed file
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
import * as ts from 'typescript'; | ||
import { TSESTree } from '@typescript-eslint/experimental-utils'; | ||
import { parseForESLint } from '@typescript-eslint/parser'; | ||
import { | ||
isTypeReadonly, | ||
type ReadonlynessOptions, | ||
} from '../src/isTypeReadonly'; | ||
import path from 'path'; | ||
|
||
describe('isTypeReadonly', () => { | ||
const rootDir = path.join(__dirname, 'fixtures'); | ||
|
||
describe('TSTypeAliasDeclaration ', () => { | ||
function getType(code: string): { | ||
type: ts.Type; | ||
checker: ts.TypeChecker; | ||
} { | ||
const { ast, services } = parseForESLint(code, { | ||
project: './tsconfig.json', | ||
filePath: path.join(rootDir, 'file.ts'), | ||
tsconfigRootDir: rootDir, | ||
}); | ||
const checker = services.program.getTypeChecker(); | ||
const esTreeNodeToTSNodeMap = services.esTreeNodeToTSNodeMap; | ||
|
||
const declaration = ast.body[0] as TSESTree.TSTypeAliasDeclaration; | ||
return { | ||
type: checker.getTypeAtLocation( | ||
esTreeNodeToTSNodeMap.get(declaration.id), | ||
), | ||
checker, | ||
}; | ||
} | ||
|
||
function runTestForAliasDeclaration( | ||
code: string, | ||
options: ReadonlynessOptions | undefined, | ||
expected: boolean, | ||
): void { | ||
const { type, checker } = getType(code); | ||
|
||
const result = isTypeReadonly(checker, type, options); | ||
expect(result).toBe(expected); | ||
} | ||
|
||
describe('default options', () => { | ||
const options = undefined; | ||
|
||
function runTestIsReadonly(code: string): void { | ||
runTestForAliasDeclaration(code, options, true); | ||
} | ||
|
||
function runTestIsNotReadonly(code: string): void { | ||
runTestForAliasDeclaration(code, options, false); | ||
} | ||
|
||
describe('basics', () => { | ||
describe('is readonly', () => { | ||
const runTests = runTestIsReadonly; | ||
|
||
// Record. | ||
it.each([ | ||
['type Test = { readonly bar: string; };'], | ||
['type Test = Readonly<{ bar: string; }>;'], | ||
])('handles fully readonly records', runTests); | ||
|
||
// Array. | ||
it.each([ | ||
['type Test = Readonly<readonly string[]>;'], | ||
['type Test = Readonly<ReadonlyArray<string>>;'], | ||
])('handles fully readonly arrays', runTests); | ||
|
||
// Array - special case. | ||
// Note: Methods are mutable but arrays are treated special; hence no failure. | ||
it.each([ | ||
['type Test = readonly string[];'], | ||
['type Test = ReadonlyArray<string>;'], | ||
])('treats readonly arrays as fully readonly', runTests); | ||
|
||
// Set and Map. | ||
it.each([ | ||
['type Test = Readonly<ReadonlySet<string>>;'], | ||
['type Test = Readonly<ReadonlyMap<string, string>>;'], | ||
])('handles fully readonly sets and maps', runTests); | ||
}); | ||
|
||
describe('is not readonly', () => { | ||
const runTests = runTestIsNotReadonly; | ||
|
||
// Record. | ||
it.each([ | ||
['type Test = { foo: string; };'], | ||
['type Test = { foo: string; readonly bar: number; };'], | ||
])('handles non fully readonly records', runTests); | ||
|
||
// Array. | ||
it.each([['type Test = string[]'], ['type Test = Array<string>']])( | ||
'handles non fully readonly arrays', | ||
runTests, | ||
); | ||
|
||
// Set and Map. | ||
// Note: Methods are mutable for ReadonlySet and ReadonlyMet; hence failure. | ||
it.each([ | ||
['type Test = Set<string>;'], | ||
['type Test = Map<string, string>;'], | ||
['type Test = ReadonlySet<string>;'], | ||
['type Test = ReadonlyMap<string, string>;'], | ||
])('handles non fully readonly sets and maps', runTests); | ||
}); | ||
}); | ||
}); | ||
|
||
describe('treatMethodsAsReadonly', () => { | ||
const options: ReadonlynessOptions = { | ||
treatMethodsAsReadonly: true, | ||
}; | ||
|
||
function runTestIsReadonly(code: string): void { | ||
runTestForAliasDeclaration(code, options, true); | ||
} | ||
|
||
// function runTestIsNotReadonly(code: string): void { | ||
// runTestForAliasDeclaration(code, options, false); | ||
// } | ||
|
||
describe('is readonly', () => { | ||
const runTests = runTestIsReadonly; | ||
|
||
// Set and Map. | ||
it.each([ | ||
['type Test = ReadonlySet<string>;'], | ||
['type Test = ReadonlyMap<string, string>;'], | ||
])('handles non fully readonly sets and maps', runTests); | ||
}); | ||
}); | ||
}); | ||
}); |