Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

fix: add missing peer dependencies#9744

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.

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

Already on GitHub?Sign in to your account

Merged
bradzacher merged 1 commit intotypescript-eslint:mainfromethanwu10:main
Nov 16, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletionspackages/type-utils/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,9 @@
"debug": "^4.3.4",
"ts-api-utils": "^1.3.0"
},
"peerDependencies": {
"eslint": "^8.57.0 || ^9.0.0"
},
"devDependencies": {
"@jest/types": "29.6.3",
"@typescript-eslint/parser": "8.0.1",
Expand Down
3 changes: 3 additions & 0 deletionspackages/typescript-eslint/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,9 @@
"@typescript-eslint/parser": "8.0.1",
"@typescript-eslint/utils": "8.0.1"
},
"peerDependencies": {
"eslint": "^8.57.0 || ^9.0.0"
},
"devDependencies": {
"@jest/types": "29.6.3",
"downlevel-dts": "*",
Expand Down
5 changes: 5 additions & 0 deletionspackages/utils/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,11 @@
"rimraf": "*",
"typescript": "*"
},
"peerDependenciesMeta": {
"typescript": {

Choose a reason for hiding this comment

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

[Question] Shouldn't this also be listed inpeerDependencies? Even if listing it inpeerDependenciesMeta implicitly adds it there, it feels odd to me to make that implicit.

Copy link
ContributorAuthor

@ethanwu10ethanwu10Nov 10, 2024
edited
Loading

Choose a reason for hiding this comment

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

I just copied this fromtype-utils (which is where the missing dep for typescript comes from), which also does not list it as an explicit peerdep

"peerDependenciesMeta": {
"typescript": {
"optional":true
}
},

Choose a reason for hiding this comment

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

Ha, nice, so this might be an existing issue in that package then? My vote is to fix in both packages.

Choose a reason for hiding this comment

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

Just came here to say that appearently at least both Yarn and pnpm have opted in the past to have "peerDependenciesMeta withoutpeerDependencies" imply a peer dependency on*. This was done due to some (legacy?) npm behavior regarding peer dependencies, making package authors hesistant to list them. Seepnpm/pnpm#2128.

But it's probably a better practice to explicitly list them; and given the age of the referenced issue probably safe enough as well.

JoshuaKGoldberg and ethanwu10 reacted with thumbs up emoji
Copy link
Member

@bradzacherbradzacherNov 12, 2024
edited
Loading

Choose a reason for hiding this comment

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

The reason we usedpeerDependenciesMeta withoutpeerDependencies was because there were versions of npm that did not supportpeerDependenciesMeta. This meant that when we used an explicitpeerDependencies then users would be spammed with warnings saying they didn't have TS installed. This was a problem as some big packages included our plugins by default but only used them if the user opted in to TS which caused non-TS users to get spammed with missing peer dep errors.

A this point we could probably also include the explicitpeerDependencies on TS but also there's no harm in not including it and having it inferred to ensure that nobody gets spammed with logs.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Do you know ifnpm also shares this behavior ofpeerDependenciesMeta implyingpeerDependencies? From a cursory search of the npm sources it seems to me like it doesn't:https://github.com/npm/cli/blob/75a3f1228865f426d8790be27f1258e501f2c450/workspaces/arborist/lib/node.js#L859-L871

Anyways, what do we think of merging this PR first and moving the discussion about whether or not to list an explicit peerdep to a different issue? We don't need to block fixing users' warnings on figuring out the proper manifest declarations 😅

Choose a reason for hiding this comment

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

I'm 👍 on that. If nobody else weighs in with a contrary opinion by our weekly release midday Monday EST then we can just merge as-is.

Now that you mention it, I do like the idea of having one release just addingpeerDependenciesMeta, then a subsequent release addingpeerDependencies on top. Just in case there's some bizarre edge case bug with the latter.

bradzacher and ethanwu10 reacted with thumbs up emoji
"optional": true
}
},
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/typescript-eslint"
Expand Down
7 changes: 7 additions & 0 deletionsyarn.lock
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5797,6 +5797,8 @@ __metadata:
rimraf: "*"
ts-api-utils: ^1.3.0
typescript: "*"
peerDependencies:
eslint: ^8.57.0 || ^9.0.0
peerDependenciesMeta:
typescript:
optional: true
Expand DownExpand Up@@ -5986,6 +5988,9 @@ __metadata:
typescript: "*"
peerDependencies:
eslint: ^8.57.0 || ^9.0.0
peerDependenciesMeta:
typescript:
optional: true
languageName: unknown
linkType: soft

Expand DownExpand Up@@ -19469,6 +19474,8 @@ __metadata:
prettier: ^3.2.5
rimraf: "*"
typescript: "*"
peerDependencies:
eslint: ^8.57.0 || ^9.0.0
peerDependenciesMeta:
typescript:
optional: true
Expand Down
Loading

[8]ページ先頭

©2009-2025 Movatter.jp