fix: typescript peer dependency #10373

rtritto · 2024-11-23T02:46:41Z

PR Checklist

Addresses an existing open issue: fixes Bug: Missing peer dependencies #9224
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

typescript is a mandatory peer dependency (peerDepedency of ts-api-utils) and not optional peer dependency (it needs to be removed from peerDepedencyMeta).

Info

ts-api-utils has typescript as peer dependency:

// ts-api-utils/package.json
{
  "peerDependencies": {
    "typescript": ">=4.2.0"
  }
}

Changes

@typescript-eslint/typescript-estree uses ts-api-utils dependency that has typescript as peer dependency (see Info)
@typescript-eslint/utils uses @typescript-eslint/typescript-estree dependency that uses ts-api-utils dependency. It needs typescript peer dependency
@typescript-eslint/parser uses @typescript-eslint/typescript-estree dependency that uses ts-api-utils dependency. It needs typescript peer dependency
@typescript-eslint/type-utils uses @typescript-eslint/typescript-estree and @typescript-eslint/utils dependencies that use ts-api-utils dependency. It needs typescript peer dependency
@typescript-eslint/eslint-plugin uses @typescript-eslint/utils dependency that uses @typescript-eslint/typescript-estree dependency that has typescript as peer dependency
typescript-eslint uses @typescript-eslint/parser and @typescript-eslint/utils dependencies that uses @typescript-eslint/typescript-estree dependency that has typescript as peer dependency

Issue Reproduction

Case where typescript is omitted by eslint-plugin-solid because @typescript-eslint/utils din't has typescript as mandatory peer dependency.

yarn init -y
yarn set version berry
yarn add -D eslint typescript eslint-plugin-solid

(optional) yarn explain peer-requirements and see logs

pcc27b → ✘ eslint-plugin-solid@npm:0.14.4 [3223e] doesn't provide typescript to @typescript-eslint/utils@npm:8.15.0 [e3d25] and 2 other dependencies

(detailed) yarn explain peer-requirements pcc27b and see logs

Package eslint-plugin-solid@npm:0.14.4 [3223e] is requested to provide typescript by its descendants

eslint-plugin-solid@npm:0.14.4 [3223e]
└─ @typescript-eslint/utils@npm:8.15.0 [e3d25] (via *)
   └─ @typescript-eslint/typescript-estree@npm:8.15.0 [0f560] (via *)
      └─ ts-api-utils@npm:1.3.0 [37728] (via >=4.2.0)

✘ Package eslint-plugin-solid@npm:0.14.4 [3223e] does not provide typescript.

typescript-eslint · 2024-11-23T02:46:44Z

Thanks for the PR, @rtritto!

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-23T02:46:56Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`abc7931`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/674df03ecc15b7000840288d
😎 Deploy Preview	https://deploy-preview-10373--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 (🟢 up 6 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-23T02:47:35Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit abc7931. 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 32 targets

Sent with 💌 from NxCloud.

rtritto · 2024-11-23T02:48:34Z

Related #9744

FYI @ethanwu10 @JoshuaKGoldberg @jnoordsij @bradzacher

packages/eslint-plugin/package.json

rtritto · 2024-11-24T01:39:06Z

Added reproduction

codecov · 2024-11-25T20:54:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.76%. Comparing base (2c8a75e) to head (abc7931).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10373   +/-   ##
=======================================
  Coverage   86.76%   86.76%           
=======================================
  Files         444      444           
  Lines       15311    15311           
  Branches     4457     4457           
=======================================
  Hits        13285    13285           
  Misses       1672     1672           
  Partials      354      354

Flag	Coverage Δ
unittest	`86.76% <ø> (ø)`

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

rtritto · 2024-12-02T17:37:44Z

Rebased

bradzacher

thanks for doing this and sticking with us!

AviVahl · 2024-12-09T18:53:26Z

@bradzacher could you guys please make the semver range more lenient?
we'd like to be able to upgrade to 5.8 even before the official typescript-eslint support (seeing the long warning about it)

ljharb · 2024-12-09T19:00:49Z

This PR was a breaking change (adding a peer dependency always is); see #10480.

The proper fix here was probably downgrading to a version of ts-api-utils that doesn't have the peer dep.

@developer-bandi

##### [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto 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.

bradzacher · 2024-12-09T21:29:47Z

@AviVahl the range represents what we officially support. As we have seen many times in the past the newer versions of TS could cause crashes until we release support. If you want to use a newer version of TS then you can use your package manager's flag to specify you want to ignore the peer dependency ranges.

bradzacher · 2024-12-09T21:30:32Z

Regardless - as per our contributing guide - we do not seek comments on PRs because it's not searchable from the issue search. Please file an issue if you wish to discuss further.

JoshuaKGoldberg · 2024-12-09T21:31:31Z

This PR was a breaking change (adding a peer dependency always is); see #10480.

Just noting for visibility from #10480: the PR was not a breaking change. It was a bugfix in that we weren't properly declaring the actual peer dependency range before.

bradzacher requested changes Nov 23, 2024

View reviewed changes

packages/eslint-plugin/package.json Outdated Show resolved Hide resolved

packages/eslint-plugin/package.json Show resolved Hide resolved

rtritto force-pushed the fix-typescript-peer-deps branch 2 times, most recently from d22d19b to e08bcad Compare November 23, 2024 20:59

rtritto force-pushed the fix-typescript-peer-deps branch from e08bcad to 0ae44b8 Compare November 25, 2024 20:52

fix: typescript peer dependency

abc7931

rtritto force-pushed the fix-typescript-peer-deps branch from 0ae44b8 to abc7931 Compare December 2, 2024 17:37

bradzacher approved these changes Dec 4, 2024

View reviewed changes

bradzacher merged commit 4cb2cf8 into typescript-eslint:main Dec 4, 2024
62 checks passed

rtritto deleted the fix-typescript-peer-deps branch December 4, 2024 17:06

ljharb mentioned this pull request Dec 9, 2024

🐛 Package with devDependency on typescript@^3.9.9 can't npm install with typescript@>=4.8.4 peer dependency added in v8.18 #10480

Closed

4 tasks

typescript-eslint locked and limited conversation to collaborators Dec 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: typescript peer dependency #10373

fix: typescript peer dependency #10373

rtritto commented Nov 23, 2024 •

edited

Loading

typescript-eslint bot commented Nov 23, 2024

netlify bot commented Nov 23, 2024 •

edited

Loading

nx-cloud bot commented Nov 23, 2024 •

edited

Loading

rtritto commented Nov 23, 2024

rtritto commented Nov 24, 2024

codecov bot commented Nov 25, 2024 •

edited

Loading

rtritto commented Dec 2, 2024

bradzacher left a comment

AviVahl commented Dec 9, 2024

ljharb commented Dec 9, 2024 •

edited

Loading

bradzacher commented Dec 9, 2024

bradzacher commented Dec 9, 2024

JoshuaKGoldberg commented Dec 9, 2024

fix: typescript peer dependency #10373

fix: typescript peer dependency #10373

Conversation

rtritto commented Nov 23, 2024 • edited Loading

PR Checklist

Overview

Info

Changes

Issue Reproduction

typescript-eslint bot commented Nov 23, 2024

netlify bot commented Nov 23, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

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

☁️ Nx Cloud Report

rtritto commented Nov 23, 2024

rtritto commented Nov 24, 2024

codecov bot commented Nov 25, 2024 • edited Loading

Codecov Report

rtritto commented Dec 2, 2024

bradzacher left a comment

Choose a reason for hiding this comment

AviVahl commented Dec 9, 2024

ljharb commented Dec 9, 2024 • edited Loading

bradzacher commented Dec 9, 2024

bradzacher commented Dec 9, 2024

JoshuaKGoldberg commented Dec 9, 2024

rtritto commented Nov 23, 2024 •

edited

Loading

netlify bot commented Nov 23, 2024 •

edited

Loading

nx-cloud bot commented Nov 23, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

ljharb commented Dec 9, 2024 •

edited

Loading