typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.8k

feat(rule-tester): allow to create empty tests#7467

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

Jump to bottom

Merged

JoshuaKGoldberg merged 3 commits intotypescript-eslint:mainfromazat-io:feat/allow-empty-tests

Sep 3, 2023

Merged

feat(rule-tester): allow to create empty tests#7467

JoshuaKGoldberg merged 3 commits intotypescript-eslint:mainfromazat-io:feat/allow-empty-tests

Sep 3, 2023

Conversation

Copy link

Contributor

azat-io commentedAug 13, 2023•
edited by JoshuaKGoldberg
Loading

PR Checklist

Addresses an existing open issue:fixesEnhancement: Add the ability to skip valid or invalid tests #7481
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

In some cases I only need to test for valid or invalid scenarios.

For example, if I want to check that a rule for the ESLint plugin works with different code stylings. Or that a rule does not apply to a certain file extension.

Example:

ruleTester.run(`${RULE_NAME}: works consistently with an empty array or an array with one element`,rule,{valid:['[].includes(person)',"['Decim'].includes(bartender)"],invalid:[],},)

This test is currently crashing with an error:Error: No test found in suite invalid

Copy link

Contributor

typescript-eslintbot commentedAug 13, 2023

Thanks for the PR,@azat-io!

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.

Copy link

netlifybot commentedAug 13, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`50adaa0`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/64f5038e23137900077a6b02
😎 Deploy Preview	https://deploy-preview-7467--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site configuration.

Copy link

nx-cloudbot commentedAug 13, 2023•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit50adaa0. 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 40 targets

Sent with 💌 fromNxCloud.

This was referencedAug 13, 2023

chore: add rule-tester commit scope#7468

Merged

feat: move to typescript-eslint v6azat-io/eslint-plugin-perfectionist#37

Merged

JoshuaKGoldberg requested changes

Aug 15, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

The code changes look nifty but let's discuss in a backing issue. The rule tester is an important part of the public API and I'm not sure we want to do this without talking it over first.

JoshuaKGoldberg added the please fill out the templatewe have the processes for good reasons 😔 label

Aug 15, 2023

Copy link

ContributorAuthor

azat-io commentedAug 15, 2023

I would like to be able to skip valid or invalid scenarios in some tests. In some cases, such examples are simply not needed.

Some simple example:

importnoLetRulefrom'../rule/no-let'ruleTester.run(`disallow to use let`,rule,{valid:[],invalid:[`let a = 1`],},)

Copy link

ContributorAuthor

azat-io commentedAug 15, 2023

Issue#7481

JoshuaKGoldberg added triageWaiting for team members to take a look and removed please fill out the templatewe have the processes for good reasons 😔 labels

Aug 28, 2023

Copy link

ContributorAuthor

azat-io commentedSep 3, 2023•
edited
Loading

@JoshuaKGoldberg Could you review this PR?

This pull request is the last step to upgrade to version 6 before the big release in our ESLint plugin:azat-io/eslint-plugin-perfectionist#32

The same PR in ESLint also was merged:eslint/eslint#17475

JoshuaKGoldberg self-requested a review

September 3, 2023 17:57

JoshuaKGoldberg requested changes

Sep 3, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Changes look good, thanks for keeping on this!

Could you please add some unit tests for the new logic though? Conditionally skipping tests is a kind of behavior that's easy to trip up over time.

JoshuaKGoldberg added awaiting responseIssues waiting for a reply from the OP or another party and removed triageWaiting for team members to take a look labels

Sep 3, 2023

Copy link

ContributorAuthor

azat-io commentedSep 3, 2023•
edited
Loading

@JoshuaKGoldberg Hmm. Can you tell me the best way to do that? Since this problem occurs only when using RuleTester with Vitest. Because of this:https://github.com/vitest-dev/vitest/blob/main/packages/runner/src/run.ts#L331-L338

Copy link

Member

JoshuaKGoldberg commentedSep 3, 2023•
edited
Loading

See the tests at the bottom ofRuleTester.test.ts in theconstructor constraints block for reference:

typescript-eslint/packages/rule-tester/tests/RuleTester.test.ts

Line 762 in6d3d162

describe('constructor constraints',()=>{

They show runningruleTester.run('my-rule", ...) and then asserting on themockedDescribe.mock. You could add a similar block with tests roughly like:

it('does not call describe with valid if no valid tests are provided',()=>{construleTester=newRuleTester();ruleTester.run('my-rule',NOOP_RULE,{valid:[],invalid:[{code:'invalid',errors:[{messageId:'error'}],},],});expect(mockedDescribe.mock.calls)// ...