typescript-eslint/typescript-eslintPublic

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

fix(rule-tester): use cwd option to set base path for tests with file name#10201

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

bradzacher merged 5 commits intotypescript-eslint:mainfromreduckted:bugfix/10191

Oct 28, 2024

Merged

fix(rule-tester): use cwd option to set base path for tests with file name#10201

bradzacher merged 5 commits intotypescript-eslint:mainfromreduckted:bugfix/10191

Oct 28, 2024

Conversation

Copy link

Contributor

reduckted commentedOct 23, 2024•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug:RuleTester: cannot read properties ofundefined (reading'parse' ) #10191
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

If thefilename specified in a test is absolute or steps up at least one directory, then theLinter'scwd option is used to specify the base path.

When creating aFlatConfigArray, ESLint uses the linter'scwd option to specify the base path:
https://github.com/eslint/eslint/blob/725962731538eaa38d5d78b9e82ce3fccc9762d0/lib/linter/linter.js#L1524

Thecwd option is specified when creating theLinter object:
https://github.com/eslint/eslint/blob/3a4eaf921543b1cd5d1df4ea9dec02fab396af2a/lib/linter/linter.js#L1304

That means theRuleTester may need to create multipleLinter objects. I've created a Map ofLinter objects keyed by their base path.

For absolute paths and paths that step up a directory, the base path is calculated by resolving the file name relative to either thetsconfigRootDir specified in the parser options, orprocess.cwd(). The root of that path is used as the base path. This is equivalent to what#10174 was fixing. For any other paths, the filename does not affect the base path, meaning the behavior prior to#10174 is used.

Warning

This bug only exists after ESLint v9.5 (see#10191 (comment)).

I have tested these changes locally against ESLint v9.13.0, but haven't updated the version in this PR. I'm not sure what the desired solution is in regards to testing against multiple ESLint versions.

Use cwd to set the base path for absolute and relative file names.

ef3176a

Copy link

Contributor

typescript-eslintbot commentedOct 23, 2024

Thanks for the PR,@reduckted!

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 commentedOct 23, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`1e47a9e`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/671f7880d489ee0008e9f9db
😎 Deploy Preview	https://deploy-preview-10201--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 5 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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedOct 23, 2024•
edited
Loading

☁️ Nx Cloud Report

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

Sent with 💌 fromNxCloud.

reduckted changed the title~~fix(rule-tester) use cwd option to set base path for tests with file name~~fix(rule-tester): use cwd option to set base path for tests with file name

Oct 23, 2024

Fixed lint errors

50ed82b

Copy link

codecovbot commentedOct 23, 2024•
edited
Loading

Codecov Report

Attention: Patch coverage is95.83333% with1 line in your changes missing coverage. Please review.

Project coverage is 86.50%. Comparing base(79c27a8) to head(1e47a9e).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/rule-tester/src/RuleTester.ts	95.83%	1 Missing⚠️

Additional details and impacted files

@@            Coverage Diff             @@##             main   #10201      +/-   ##==========================================+ Coverage   86.18%   86.50%   +0.32%==========================================  Files         430      430                Lines       15029    15088      +59       Branches     4360     4380      +20     ==========================================+ Hits        12952    13052     +100+ Misses       1725     1679      -46- Partials      352      357       +5

Flag	Coverage Δ
unittest	`86.50% <95.83%> (+0.32%)`	⬆️

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

Files with missing lines	Coverage Δ
packages/rule-tester/src/RuleTester.ts	`73.67% <95.83%> (+9.96%)`	⬆️

... and6 files with indirect coverage changes

Improved code coverage.

538f4cb

Copy link

ContributorAuthor

reduckted commentedOct 24, 2024

Is the code coverage sufficient to get this merged? I feel like what it's reporting is wrong because it says that this statement is uncovered:

basePath=path.parse(path.resolve(basePath??process.cwd(),filename),).root;

But that statement is definitely being hit because the tests would fail if it wasn't. 😕

Copy link

jeremybanka commentedOct 24, 2024•
edited
Loading

Is the code coverage sufficient to get this merged? I feel like what it's reporting is wrong because it says that this statement is uncovered:
basePath=path.parse(path.resolve(basePath??process.cwd(),filename),).root;
But that statement is definitely being hit because the tests would fail if it wasn't. 😕

Hey thank you for taking a look at this. You're right, this lineshould be covered. But it's not being run at all somehow. It seems to me that the reason that it's not is this one line infilename.test.ts:

import{RuleTester}from'@typescript-eslint/rule-tester';

This appears to resolve to a built asset in the dist/ folder and should be replaced with

import{RuleTester}from'../src/RuleTester';

That's whatRuleTester.test.ts does anyway.

See if this fixes the missing coverage issue!

Used relative import to fix code coverage.

72ff7d5

Copy link

ContributorAuthor

reduckted commentedOct 25, 2024

This appears to resolve to a built asset in the dist/ folder and should be replaced with

Ah, brilliant! That's exactly what the problem was. Thanks!

kirkwaiblinger mentioned this pull request

Oct 26, 2024

Bug:RuleTester: cannot read properties ofundefined (reading'parse' )#10191

Closed

4 tasks

Copy link

Contributor

lotmek commentedOct 26, 2024

Thank you@reduckted for this amazing fix !

I'm the one who introduced that regression with my changes and I sincerely apologize for any inconvenience it caused... 😔

Copy link

Member

kirkwaiblinger commentedOct 26, 2024

Warning
This bug only exists after ESLint v9.5 (see#10191 (comment)).
I have tested these changes locally against ESLint v9.13.0, but haven't updated the version in this PR. I'm not sure what the desired solution is in regards to testing against multiple ESLint versions.

I think for now, let's just go with "I tested it on my machine and it worked" (infamous last words) rather than upgrade eslint for this PR. Related,#1752.