Fixes thegetRuleDefaultOptions ininsertNewRuleReferences.ts that generates the code referenced byDocs:return-await options are misleading #11102.
In the rules table, the config group ofreturn-await is shown 'recommended' when it should be 'strict'

Screenshots

Before

After

EDIT: Fix alt-text for images

tomasossa added2 commits

May 17, 2025 23:14

docs: fix RulesTableactualRecommended

760f96c

The `getActualRecommended` function was returning 'recommended' when `docs.recommended` property was an object. This led to an incorrect value for rule return-await.

docs: fixedreturn-await misleading default options

e3d4089

Closes:typescript-eslint#11102

Copy link

Contributor

typescript-eslintbot commentedMay 18, 2025

Thanks for the PR,@tomasossa!

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 commentedMay 18, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`e3d4089`
🔍 Latest deploy log	https://app.netlify.com/projects/typescript-eslint/deploys/68295182ee3dfb000887abcf
😎 Deploy Preview	https://deploy-preview-11227--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 90 (🔴 down 9 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 project configuration.

Copy link

nx-cloudbot commentedMay 18, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commite3d4089.

Command	Status	Duration	Result
`nx test visitor-keys`	✅ Succeeded	1s	View ↗
`nx run types:build`	✅ Succeeded	1s	View ↗
`nx typecheck ast-spec`	✅ Succeeded	1s	View ↗
`nx test utils`	✅ Succeeded	2s	View ↗
`nx run-many --target=build --exclude website --...`	✅ Succeeded	3s	View ↗
`nx test typescript-eslint`	✅ Succeeded	1s	View ↗
`nx run-many --target=clean --parallel=20`	✅ Succeeded	22s	View ↗
`nx test typescript-estree`	✅ Succeeded	1s	View ↗
`Additional runs (26)`	✅ Succeeded	...	View ↗

☁️Nx Cloud last updated this comment at2025-05-18 03:26:36 UTC

JoshuaKGoldberg approved these changes

May 19, 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.

LGTM, thanks!

JoshuaKGoldberg 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 19, 2025

Labels

1 approval

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

2 participants

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: fix misleading`return-await` options and config group#11227

Are you sure you want to change the base?

docs: fix misleading`return-await` options and config group#11227

Uh oh!

Conversation

tomasossa commentedMay 18, 2025•
edited
Loading

Uh oh!

PR Checklist

Overview