feat: standardize debug namespaces to file paths - #10599
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! 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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
View your CI Pipeline Execution ↗ for commit e9fe780.
☁️ Nx Cloud last updated this comment at |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #10599 +/- ##
==========================================
+ Coverage 86.90% 86.91% +0.01%
==========================================
Files 446 447 +1
Lines 15505 15525 +20
Branches 4517 4521 +4
==========================================
+ Hits 13475 13494 +19
Misses 1675 1675
- Partials 355 356 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
| const matched = | ||
| /typescript-eslint[\\/]+packages[\\/]+([a-z-]+)[\\/]+(.+)/.exec(filePath); |
There was a problem hiding this comment.
Probably better to just make this a path relative to this file? Eg pkgsRoot = path.resolve('..', '..', '..'); relativePath = file.replace(pkgsRoot, '..');
That way the rule doesn't rely on the folder name.
There was a problem hiding this comment.
Ah, those got irksome to deal with in unit tests with explicit filenames. But +1 that this regex is unseemly. I switched to .split(/packages[\\/]+/) and added a bit more testing.
2 participants
PR Checklist
Overview
Adds a new
@typescript-eslint/internal/debug-namespacelint rule that makes sure anyconst log = debug('...')uses a namespace equivalent to the package name, file directory, and file path.This caught several discrepancies in existing namespaces. I don't think we need to count this as a breaking change as those namespaces really aren't part of the public API. But this does constitute a
feat:I think.💖