Skip to content

fix(utils): add missing dependency on @types/semver #5825

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 1 commit into from
Oct 14, 2022
Merged

fix(utils): add missing dependency on @types/semver #5825

merged 1 commit into from
Oct 14, 2022

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Oct 14, 2022

PR Checklist

Overview

#5750 added a dependency on semver to the @typescript-eslint/utils package. This implicitly depended on @types/semver which is provided by the top-level workspace package.json file but not @typescript-eslint/utils itself. This caused my application to break.

My application imports some types from this package:

import type { TSESLint, JSONSchema } from '@typescript-eslint/utils';

And the breakage occurred during:

While running:

> tsc

Error: node_modules/@typescript-eslint/utils/dist/eslint-utils/rule-tester/dependencyConstraints.d.ts(1,25):
error TS7016: Could not find a declaration file for module 'semver'.
'/home/runner/work/eslint-doc-generator/eslint-doc-generator/node_modules/@typescript-eslint/utils/node_modules/semver/index.js' implicitly has an 'any' type.

I have fixed the issue by adding the missing dependency.

In this PR or as a follow-up, we should also remove @types/semver from the top-level package.json which doesn't need it, and instead ensure it's defined as an explicit dependency in each package that uses it.

@nx-cloud
Copy link

nx-cloud bot commented Oct 14, 2022 •
edited
Loading

☁️ Nx Cloud Report

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

📂 See all runs for this branch

✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @bmish!

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify
Copy link

netlify bot commented Oct 14, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 5e9d356
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6348c4c1384622000825835f
😎 Deploy Preview https://deploy-preview-5825--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@codecov
Copy link

codecov bot commented Oct 14, 2022 •
edited
Loading

Codecov Report

Merging #5825 (5e9d356) into main (9ffdb05) will decrease coverage by 2.47%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5825      +/-   ##
==========================================
- Coverage   93.82%   91.34%   -2.48%     
==========================================
  Files         134      360     +226     
  Lines        1506    12010   +10504     
  Branches      226     3498    +3272     
==========================================
+ Hits         1413    10971    +9558     
- Misses         60      743     +683     
- Partials       33      296     +263
Flag Coverage Δ
unittest 91.34% <ø> (-2.48%) ⬇️

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

Impacted Files Coverage Δ
packages/utils/src/ts-eslint/ParserOptions.ts 20.00% <0.00%> (ø)
...lugin/src/rules/no-confusing-non-null-assertion.ts 82.60% <0.00%> (ø)
...-plugin/src/rules/no-unnecessary-type-assertion.ts 94.66% <0.00%> (ø)
packages/eslint-plugin/src/rules/semi.ts 92.85% <0.00%> (ø)
...ckages/eslint-plugin/src/rules/no-throw-literal.ts 97.67% <0.00%> (ø)
...nt-plugin/src/rules/lines-between-class-members.ts 92.85% <0.00%> (ø)
...kages/eslint-plugin/src/rules/init-declarations.ts 100.00% <0.00%> (ø)
packages/eslint-plugin-tslint/src/rules/config.ts 97.29% <0.00%> (ø)
.../src/rules/sort-type-union-intersection-members.ts 90.74% <0.00%> (ø)
packages/utils/src/ts-eslint/Scope.ts 80.00% <0.00%> (ø)
... and 216 more

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Oct 14, 2022
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.

LGTM, thanks!

@bradzacher bradzacher merged commit 17b8879 into typescript-eslint:main Oct 14, 2022
This was referenced Oct 24, 2022
Closed
Closed
@sync-by-unito sync-by-unito bot mentioned this pull request Nov 1, 2022
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@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.
3 participants
@bmish @JoshuaKGoldberg @bradzacher