Add custom lint rule to ensure import paths end with .d.ts extension
#1168
Conversation
| export const importPathRule = /** @type {const} */ ({ | ||
| meta: { | ||
| type: 'problem', |
There was a problem hiding this comment.
The /** @type {const} */ comment ensures that the inferred type of meta.type is 'problem' and not string, because otherwise there would be complaints in xo.config.js.
It would have been nice if XO exposed rule creation utilities (like ESLintUtils.RuleCreator.withoutDocs) from typescript-eslint, that would have ensured proper type safety on this rule. That said, even with that utility, we would have still required node types.
And this shouldn't cause slowdowns even when we disable Also, on a different note, after the V5 updates, I remember seeing errors when |
Yeah, I think we can. I also saw errors, but not anymore. |
Adds an auto-fixable solution for Add lint rule to prevent
.js/.tsextensions in import statements #1152, improving DX as mentioned in this comment.import-path-rule.mov
Updates
xobecause there are some bugs in the existing version.Enables the
allowJSflag intsconfig.jsonto ensure thexo.config.jsfile is checked. This shouldn't be a problem because we havenoEmitenabled, so it shouldn't matter if.jsfiles are part of the program. Also, this doesn't check all.jsfiles for errors, only those that have the@ts-checkdirective.This is kinda better than the
no-restricted-importsrule, because that restricts certain extensions, whereas this enforces the desired one.And interestingly, it also catches some existing errors that weren't caught earlier. And these errors are not because of any of our recent changes, these were there since the very beginning.
type-fest/source/pick-deep.d.ts
Lines 4 to 5 in d71242a
type-fest/test-d/internal/is-number-like.ts
Line 2 in d71242a