vara:{[kinany]:any}// No modifiersvarb:{[kinany]?:any}// Optional modifiervarc:{readonly[kinany]:any}// Readonly modifiervard:{+readonly[kinany]?:any}// +readonly and optional modifiervare:{-readonly[kinany]:any}// -readonly modifier

Example a:`{ [k in any]: any }`

{type:"TSMappedType",constraint:{type:"TSAnyKeyword"},key:{type:"Identifier",name:"k"},nameType:null,optional:false,// Now has explicit false valuereadonly:undefined,// Now has explicit undefined valuetypeAnnotation:{type:"TSAnyKeyword"}}

Example b:`{ [k in any]?: any }`

{type:"TSMappedType",constraint:{type:"TSAnyKeyword"},key:{type:"Identifier",name:"k"},nameType:null,optional:true,// Has true value because of ? modifierreadonly:undefined,// Now has explicit undefined valuetypeAnnotation:{type:"TSAnyKeyword"}}

Example c:`{ readonly [k in any]: any }`

{type:"TSMappedType",constraint:{type:"TSAnyKeyword"},key:{type:"Identifier",name:"k"},nameType:null,optional:false,// Now has explicit false valuereadonly:true,// Has true value because of readonly modifiertypeAnnotation:{type:"TSAnyKeyword"}}

Example d:`{ +readonly [k in any]?: any }`

{type:"TSMappedType",constraint:{type:"TSAnyKeyword"},key:{type:"Identifier",name:"k"},nameType:null,optional:true,// Has true value because of ? modifierreadonly:"+",// Has "+" value because of +readonly modifiertypeAnnotation:{type:"TSAnyKeyword"}}

Example e:`{ -readonly [k in any]: any }`

{type:"TSMappedType",constraint:{type:"TSAnyKeyword"},key:{type:"Identifier",name:"k"},nameType:null,optional:false,// Now has explicit false valuereadonly:"-",// Has "-" value because of -readonly modifiertypeAnnotation:{type:"TSAnyKeyword"}}

ensure consistent TSMappedType ast shape

f133874

Copy link

Contributor

typescript-eslintbot commentedApr 17, 2025

Thanks for the PR,@dbarabashh!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlifybot commentedApr 17, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`656a3f9`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6818278fcd0dae0008550592
😎 Deploy Preview	https://deploy-preview-11086--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 1 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify site configuration.

Copy link

nx-cloudbot commentedApr 17, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commit656a3f9.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	2s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️Nx Cloud last updated this comment at2025-05-05 15:12:23 UTC

dbarabashh changed the title~~fix(typescript-estree): Inconsistent TSMappedType AST shape~~fix(typescript-estree): ensure consistent TSMappedType AST shape

Apr 17, 2025

added mote tests

b6e71eb

dbarabashh changed the title~~fix(typescript-estree): ensure consistent TSMappedType AST shape~~fix(eslint-plugin): ensure consistent TSMappedType AST shape

Apr 18, 2025

JoshuaKGoldberg reviewed

May 2, 2025

View reviewed changes

packages/typescript-estree/src/convert.ts

		readonly: node.readonlyToken
		?node.readonlyToken.kind === SyntaxKind.ReadonlyKeyword \|\|
		getTextForTokenKind(node.readonlyToken.kind)
		: undefined,

Copy link

Member

JoshuaKGoldbergMay 2, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Note thatreadonly is an enum oftrue,+ and-. So previously I proposedundefined as the default value. I guessfalse does no harm here.

Agreed that either could work, and also agreed on going withundefined. That feels to me like a more normal default when there are multiple truthy options ('+','-'). I can see whyfalse might make sense as a counterpoint totrue, but visually I think it makes less sense thanundefined.

JoshuaKGoldberg requested changes

May 2, 2025

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🙌 The source code change looks good to me, thanks! Requesting changes on going with the ast-spec tests that other types of syntax conversions are verified with too.

packages/typescript-estree/tests/lib/convert.test.ts Outdated

		@@ -449,5 +449,79 @@ describe('convert', () => {
		expect(tsMappedType.typeParameter).toBeUndefined();
		expect(Object.keys(tsMappedType)).toContain('typeParameter');
		});

		describe('TSMappedType AST shape consistency', () => {

Copy link

Member

JoshuaKGoldbergMay 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

[Testing] We normally put fixtures inpackages/ast-spec/src. Is there a reason not to here?

If not, I thinkpackages/ast-spec/src/type/TSMappedType would be the right place to add new fixtures aroundreadonly and/or optional mapped types.

JoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party label

May 2, 2025

Copy link

codecovbot commentedMay 2, 2025•
edited
Loading

Codecov Report

Attention: Patch coverage is25.00000% with6 lines in your changes missing coverage. Please review.

Project coverage is 90.84%. Comparing base(f30a20e) to head(656a3f9).
Report is 19 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/typescript-estree/src/convert.ts	25.00%	6 Missing⚠️

❌ Your patch status has failed because the patch coverage (25.00%) is below the target coverage (90.00%). You can increase the patch coverage or adjust thetarget coverage.

Additional details and impacted files

@@            Coverage Diff             @@##             main   #11086      +/-   ##==========================================+ Coverage   90.82%   90.84%   +0.01%==========================================  Files         497      497                Lines       50204    50320     +116       Branches     8274     8311      +37     ==========================================+ Hits        45600    45714     +114- Misses       4589     4591       +2  Partials       15       15

Flag	Coverage Δ
unittest	`90.84% <25.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Files with missing lines	Coverage Δ
packages/typescript-estree/src/convert.ts	`30.74% <25.00%> (ø)`

... and7 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

dbarabashh added3 commits

May 3, 2025 16:03

updated tests

8027033

fix

6c3cb87

updated

9d64c32

bradzacher requested a review fromJoshuaKGoldberg

May 5, 2025 02:22

github-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party label

May 5, 2025

bradzacher added3 commits

May 5, 2025 12:03

fix fixture folders

33112fe

split fixtures

3003d89

remove unit tests in favour of the fixture tests

e14c50f

bradzacher force-pushed thefix/ast-tsmappedtype-shape branch from3c36704 to6a655f2Compare

May 5, 2025 02:45

add optional fixtures

76f693f

bradzacher force-pushed thefix/ast-tsmappedtype-shape branch from6a655f2 to76f693fCompare

May 5, 2025 02:45

bradzacher added3 commits

May 5, 2025 12:18

add fixture for readonly optional

a49f802

oops fix fixtures

6bb0a66

fix fixtures

656a3f9

bradzacher approved these changes

May 5, 2025

View reviewed changes

Copy link

Member

bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

thanks -- just because my review time is limited I took a moment to fix up your fixtures (you had nested the folders incorrectly which meant the snapshots weren't generated -- we might wanna add an error for this...). And I added a few extra snapshots to cover some more cases.

this all LGTM!

bradzacher added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label

May 5, 2025

Copy link

ContributorAuthor

dbarabashh commentedMay 5, 2025

@bradzacher Thank you so much. I was just about to write a comment about the file structure.

and one more question, what should we do about the coverage rate?

JoshuaKGoldberg changed the title~~fix(eslint-plugin): ensure consistent TSMappedType AST shape~~fix(typescript-estree): ensure consistent TSMappedType AST shape

May 5, 2025

Copy link

Member

JoshuaKGoldberg commentedMay 5, 2025

coverage rate

#6116 strikes again! We can ignore the coverage drop in this PR.

JoshuaKGoldberg merged commit4a97721 intotypescript-eslint:main

May 5, 2025

60 of 61 checks passed

github-actionsbot locked asresolvedand limited conversation to collaborators

May 13, 2025

Labels

1 approval

>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge

3 participants

Movatterモバイル変換

Uh oh!

fix(typescript-estree): ensure consistent TSMappedType AST shape#11086

fix(typescript-estree): ensure consistent TSMappedType AST shape#11086

Conversation

dbarabashh commentedApr 17, 2025

PR Checklist

Overview

Example a:{ [k in any]: any }

Example b:{ [k in any]?: any }

Example c:{ readonly [k in any]: any }

Example d:{ +readonly [k in any]?: any }

Example e:{ -readonly [k in any]: any }

Uh oh!

typescript-eslintbot commentedApr 17, 2025

Uh oh!

netlifybot commentedApr 17, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedApr 17, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldbergMay 2, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergMay 2, 2025

Choose a reason for hiding this comment

Uh oh!

codecovbot commentedMay 2, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bradzacher left a comment

Choose a reason for hiding this comment

Uh oh!

dbarabashh commentedMay 5, 2025

Uh oh!

JoshuaKGoldberg commentedMay 5, 2025

Uh oh!

Uh oh!

Uh oh!

Example a:`{ [k in any]: any }`

Example b:`{ [k in any]?: any }`

Example c:`{ readonly [k in any]: any }`

Example d:`{ +readonly [k in any]?: any }`

Example e:`{ -readonly [k in any]: any }`

netlifybot commentedApr 17, 2025•
edited
Loading

nx-cloudbot commentedApr 17, 2025•
edited
Loading

JoshuaKGoldbergMay 2, 2025•
edited
Loading

codecovbot commentedMay 2, 2025•
edited
Loading