Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
test(type-utils): add basic tests for isTypeReadonly#4416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
bradzacher merged 3 commits intotypescript-eslint:mainfromRebeccaStevens:isTypeReadonly-testsJan 17, 2022
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
3 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
138 changes: 138 additions & 0 deletionspackages/type-utils/tests/isTypeReadonly.test.ts
This file contains hidden or 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); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.