Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(utils): add RuleTester API for top-level dependency constraints #5896

Merged
merged 5 commits into from Oct 31, 2022

Conversation

bradzacher
Copy link
Member

Overview

As I continued working on #5573, I realised that there are some plugin rules that won't ever work on old versions of TS.
For example consistent-type-imports hard requires at least TS 4.1 as that was the first version where the required syntax was added.

This PR adds a new API to the rule tester that allows you to list a set of dependency constraints for all tests in the rule tester constructor. If the constraints don't pass then absolutely no tests are run.

@bradzacher bradzacher added the enhancement New feature or request label Oct 27, 2022
@nx-cloud
Copy link

nx-cloud bot commented Oct 27, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 48c1196. 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, @bradzacher!

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
Copy link

netlify bot commented Oct 27, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 48c1196
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/635fad57b6a5b700083e118c
😎 Deploy Preview https://deploy-preview-5896--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 27, 2022

Codecov Report

Merging #5896 (48c1196) into main (1f14c03) will decrease coverage by 0.03%.
The diff coverage is 64.70%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5896      +/-   ##
==========================================
- Coverage   91.35%   91.32%   -0.04%     
==========================================
  Files         365      365              
  Lines       12199    12212      +13     
  Branches     3560     3564       +4     
==========================================
+ Hits        11144    11152       +8     
- Misses        749      752       +3     
- Partials      306      308       +2     
Flag Coverage Δ
unittest 91.32% <64.70%> (-0.04%) ⬇️

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

Impacted Files Coverage Δ
packages/utils/src/ts-eslint/RuleTester.ts 100.00% <ø> (ø)
...s/utils/src/eslint-utils/rule-tester/RuleTester.ts 85.54% <64.70%> (-4.46%) ⬇️

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.

Awesome, looks good to me! Just a few non-blocking suggestions, along with an error message typo fix.

packages/utils/src/eslint-utils/rule-tester/RuleTester.ts Outdated Show resolved Hide resolved
packages/utils/src/eslint-utils/rule-tester/RuleTester.ts Outdated Show resolved Hide resolved
packages/utils/src/eslint-utils/rule-tester/RuleTester.ts Outdated Show resolved Hide resolved
packages/utils/src/ts-eslint/RuleTester.ts Outdated Show resolved Hide resolved
Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>
@bradzacher bradzacher merged commit 0520d53 into main Oct 31, 2022
@bradzacher bradzacher deleted the top-level-dependency-constraints-for-tests branch October 31, 2022 12:03
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants