Skip to content

docs: [return-await] make the rule no longer an extension of ESLint no-return-await #10421

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Dec 31, 2024
Merged

docs: [return-await] make the rule no longer an extension of ESLint no-return-await #10421

merged 4 commits into from
Dec 31, 2024

Conversation

kirkwaiblinger
Copy link
Member

PR Checklist

Overview

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @kirkwaiblinger!

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.

@netlify Netlify
Copy link

netlify bot commented Nov 29, 2024 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 456eef1
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/67734ecdc9d70a0008ab2191
😎 Deploy Preview https://deploy-preview-10421--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 93 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (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 your Netlify site configuration.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Nov 29, 2024 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 456eef1.

Command Status Duration Result
nx test eslint-plugin --coverage=false ✅ Succeeded 7m 17s View ↗
nx test eslint-plugin ✅ Succeeded 5m 58s View ↗
nx test typescript-eslint --coverage=false ✅ Succeeded 14s View ↗
nx test visitor-keys --coverage=false ✅ Succeeded <1s View ↗
nx run types:build ✅ Succeeded <1s View ↗
nx test type-utils --coverage=false ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude website --... ✅ Succeeded 29s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded <1s View ↗
Additional runs (24) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2024-12-31 02:09:54 UTC

@kirkwaiblinger kirkwaiblinger changed the title chore(docs): [return-await] make the rule no longer an extension of ESLint no-return-await docs: [return-await] make the rule no longer an extension of ESLint no-return-await Nov 29, 2024
@ArnaudBarre
Copy link
Contributor

Do you plan to also update the documentation to advice on using always and remove the fact that in non error context this is only stylistic?

@kirkwaiblinger kirkwaiblinger marked this pull request as ready for review November 30, 2024 00:38
JoshuaKGoldberg
JoshuaKGoldberg requested changes Dec 2, 2024
View reviewed changes
Copy link
Member

@JoshuaKGoldberg 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 phrasing all looks great to me! Just requesting changes on optimizing the 'above-the-fold' part of the docs.

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Dec 2, 2024
@Zamiell
Copy link
Contributor

Zamiell commented Dec 8, 2024

Do you plan to also update the documentation to advice on using always and remove the fact that in non error context this is only stylistic?

Here's the related issue for changing the default value: #10165

@codecov Codecov
Copy link

codecov bot commented Dec 31, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.90%. Comparing base (c27399b) to head (456eef1).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #10421   +/-   ##
=======================================
  Coverage   86.90%   86.90%           
=======================================
  Files         446      446           
  Lines       15506    15506           
  Branches     4518     4518           
=======================================
  Hits        13476    13476           
  Misses       1675     1675           
  Partials      355      355
Flag Coverage Δ
unittest 86.90% <ø> (ø)

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

Files with missing lines Coverage Δ
packages/eslint-plugin/src/rules/return-await.ts 97.41% <ø> (ø)

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Dec 31, 2024
JoshuaKGoldberg
JoshuaKGoldberg approved these changes Dec 31, 2024
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Yay, happy to see this rule finally get the standalone emphasis it deserves! ❤️

@JoshuaKGoldberg JoshuaKGoldberg merged commit 4f50f64 into typescript-eslint:main Dec 31, 2024
63 checks passed
@kirkwaiblinger kirkwaiblinger deleted the return-await-standalone branch December 31, 2024 21:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ArnaudBarre ArnaudBarre ArnaudBarre left review comments

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: treat return-await as a standalone rule, not an extension
4 participants
@kirkwaiblinger @ArnaudBarre @Zamiell @JoshuaKGoldberg