fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on `as const satisfies` #10315

ronami · 2024-11-09T21:05:48Z

PR Checklist

Addresses an existing open issue: fixes Bug: [explicit-module-boundary-types] allowDirectConstAssertionInArrowFunctions should not error when also using satisfies #10231
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR resolves #10231 and adjusts both explicit-module-boundary-types and explicit-function-return-type to not fail on the following when allowDirectConstAssertionInArrowFunctions is enabled:

type Foo = {
  foo: string,
  bar: number,
};

export const a = () => ({
  foo: "FOOO",
  bar: 123,
}as const); // <-- This works as expected.

export const b = () => ({
  foo: "FOOO",
  bar: 123,
} as const satisfies Foo); // <-- This unexpectedly causes the rules to report.

typescript-eslint · 2024-11-09T21:05:51Z

Thanks for the PR, @ronami!

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 · 2024-11-09T21:06:04Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f34addc`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6738183a7e304e0008a14e26
😎 Deploy Preview	https://deploy-preview-10315--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 98 (🔴 down 1 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 · 2024-11-09T21:06:37Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f34addc. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

codecov · 2024-11-09T21:21:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.63%. Comparing base (124b65d) to head (f34addc).
Report is 26 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10315      +/-   ##
==========================================
+ Coverage   86.56%   86.63%   +0.07%     
==========================================
  Files         431      433       +2     
  Lines       15188    15208      +20     
  Branches     4418     4440      +22     
==========================================
+ Hits        13148    13176      +28     
+ Misses       1683     1675       -8     
  Partials      357      357

Flag	Coverage Δ
unittest	`86.63% <100.00%> (+0.07%)`	⬆️

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

Files with missing lines	Coverage Δ
.../eslint-plugin/src/util/explicitReturnTypeUtils.ts	`97.77% <100.00%> (+0.10%)`	⬆️

... and 31 files with indirect coverage changes

JoshuaKGoldberg

Great! Just requesting changes on the tests, not the teeny nitpick.

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

JoshuaKGoldberg

❤️‍🔥

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

@developer-bandi

##### [v8.15.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8150-2024-11-18) ##### 🚀 Features - **eslint-plugin:** \[prefer-nullish-coalescing] fix detection of `ignoreConditionalTests` involving boolean `!` operator ([#10299](typescript-eslint/typescript-eslint#10299)) - **eslint-plugin:** new rule `no-unsafe-type-assertion` ([#10051](typescript-eslint/typescript-eslint#10051)) - **eslint-plugin:** added related-getter-setter-pairs rule ([#10192](typescript-eslint/typescript-eslint#10192)) ##### 🩹 Fixes - **utils:** add defaultOptions to meta in rule ([#10339](typescript-eslint/typescript-eslint#10339)) - **eslint-plugin:** report deprecations used in default export ([#10330](typescript-eslint/typescript-eslint#10330)) - **eslint-plugin:** \[explicit-module-boundary-types] and \[explicit-function-return-type] don't report on `as const satisfies` ([#10315](typescript-eslint/typescript-eslint#10315)) - **eslint-plugin:** \[await-thenable, return-await] don't flag awaiting unconstrained type parameter as unnecessary ([#10314](typescript-eslint/typescript-eslint#10314)) - **eslint-plugin:** \[consistent-indexed-object-style] handle circular mapped types ([#10301](typescript-eslint/typescript-eslint#10301)) ##### ❤️ Thank You - Josh Goldberg ✨ - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Luis Sebastian Urrutia Fuentes [@LuisUrrutia](https://github.com/LuisUrrutia) - Phillip Huang - Ronen Amiel - Szydlak [@wszydlak](https://github.com/wszydlak) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@developer-bandi

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.14.0 | 8.15.0 | | npm | @typescript-eslint/parser | 8.14.0 | 8.15.0 | ## [v8.15.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8150-2024-11-18) ##### 🚀 Features - **eslint-plugin:** \[prefer-nullish-coalescing] fix detection of `ignoreConditionalTests` involving boolean `!` operator ([#10299](typescript-eslint/typescript-eslint#10299)) - **eslint-plugin:** new rule `no-unsafe-type-assertion` ([#10051](typescript-eslint/typescript-eslint#10051)) - **eslint-plugin:** added related-getter-setter-pairs rule ([#10192](typescript-eslint/typescript-eslint#10192)) ##### 🩹 Fixes - **utils:** add defaultOptions to meta in rule ([#10339](typescript-eslint/typescript-eslint#10339)) - **eslint-plugin:** report deprecations used in default export ([#10330](typescript-eslint/typescript-eslint#10330)) - **eslint-plugin:** \[explicit-module-boundary-types] and \[explicit-function-return-type] don't report on `as const satisfies` ([#10315](typescript-eslint/typescript-eslint#10315)) - **eslint-plugin:** \[await-thenable, return-await] don't flag awaiting unconstrained type parameter as unnecessary ([#10314](typescript-eslint/typescript-eslint#10314)) - **eslint-plugin:** \[consistent-indexed-object-style] handle circular mapped types ([#10301](typescript-eslint/typescript-eslint#10301)) ##### ❤️ Thank You - Josh Goldberg ✨ - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Luis Sebastian Urrutia Fuentes [@LuisUrrutia](https://github.com/LuisUrrutia) - Phillip Huang - Ronen Amiel - Szydlak [@wszydlak](https://github.com/wszydlak) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

ronami added 2 commits November 9, 2024 23:00

initial implementation

4921307

add tests

6075552

ronami changed the title ~~fix(eslint-plugin): [explicit-module-boundary-types/explicit-function-return-type] Don't report on as const satisfies~~ fix(eslint-plugin): [explicit-module-boundary-types/explicit-function-return-type] don't report on as const satisfies Nov 9, 2024

ronami changed the title ~~fix(eslint-plugin): [explicit-module-boundary-types/explicit-function-return-type] don't report on as const satisfies~~ fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on as const satisfies Nov 9, 2024

ronami marked this pull request as ready for review November 9, 2024 21:22

JoshuaKGoldberg requested changes Nov 10, 2024

View reviewed changes

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts Outdated Show resolved Hide resolved

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts Show resolved Hide resolved

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Nov 10, 2024

ronami and others added 3 commits November 10, 2024 22:41

Update packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts

78caf05

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

simplify tests, one test per case

492be7d

fix failing tests

dbaf9fa

ronami requested a review from JoshuaKGoldberg November 10, 2024 21:29

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Nov 10, 2024

JoshuaKGoldberg previously approved these changes Nov 10, 2024

View reviewed changes

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 Nov 10, 2024

kirkwaiblinger previously approved these changes Nov 11, 2024

View reviewed changes

packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts Outdated Show resolved Hide resolved

ronami dismissed stale reviews from kirkwaiblinger and JoshuaKGoldberg via b39e189 November 11, 2024 18:49

ronami and others added 2 commits November 11, 2024 20:49

Update packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts

b39e189

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

add tests for nested satisfies statements

6e64bee

ronami requested a review from kirkwaiblinger November 11, 2024 19:13

github-actions bot removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Nov 11, 2024

kirkwaiblinger requested changes Nov 11, 2024

View reviewed changes

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts Outdated Show resolved Hide resolved

use valid typescript code for tests

d7a9183

ronami requested a review from kirkwaiblinger November 11, 2024 19:39

kirkwaiblinger previously approved these changes Nov 11, 2024

View reviewed changes

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

bradzacher previously approved these changes Nov 16, 2024

View reviewed changes

Update explicit-function-return-type.test.ts

f34addc

bradzacher dismissed stale reviews from kirkwaiblinger and themself via f34addc November 16, 2024 03:57

bradzacher enabled auto-merge (squash) November 16, 2024 03:58

bradzacher approved these changes Nov 16, 2024

View reviewed changes

bradzacher added the bug Something isn't working label Nov 16, 2024

bradzacher disabled auto-merge November 16, 2024 04:39

bradzacher merged commit 66234d0 into typescript-eslint:main Nov 16, 2024
61 of 64 checks passed

ronami deleted the explicit-module-boundary-types-as-const-satisfies branch November 16, 2024 04:54

github-actions bot locked as resolved and limited conversation to collaborators Nov 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on `as const satisfies` #10315

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on `as const satisfies` #10315

ronami commented Nov 9, 2024 •

edited by kirkwaiblinger

Loading

typescript-eslint bot commented Nov 9, 2024

netlify bot commented Nov 9, 2024 •

edited

Loading

nx-cloud bot commented Nov 9, 2024 •

edited

Loading

codecov bot commented Nov 9, 2024 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading

JoshuaKGoldberg left a comment

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on as const satisfies #10315

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on as const satisfies #10315

Conversation

ronami commented Nov 9, 2024 • edited by kirkwaiblinger Loading

PR Checklist

Overview

typescript-eslint bot commented Nov 9, 2024

netlify bot commented Nov 9, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

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

☁️ Nx Cloud Report

codecov bot commented Nov 9, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on `as const satisfies` #10315

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on `as const satisfies` #10315

ronami commented Nov 9, 2024 •

edited by kirkwaiblinger

Loading

netlify bot commented Nov 9, 2024 •

edited

Loading

nx-cloud bot commented Nov 9, 2024 •

edited

Loading

codecov bot commented Nov 9, 2024 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading