[eslint-plugin] feat: no-deprecated-type-references rule #5509
Conversation
finish autofixerPreviews: documentation | landing | table | demo |
fix lint configPreviews: documentation | landing | table | demo |
| @@ -26,6 +26,7 @@ module.exports = { | |||
| "@blueprintjs/classes-constants": "error", | |||
| "@blueprintjs/html-components": "error", | |||
| "@blueprintjs/no-deprecated-components": "error", | |||
| "@blueprintjs/no-deprecated-type-references": "error", | |||
There was a problem hiding this comment.
since this is autofixable, can/should we promote it in the default eslint config?
| for (const [packageName, deprecatedTypeNames] of Object.entries(DEPRECATED_TYPE_REFERENCES_BY_PACKAGE)) { | ||
| for (const typeName of deprecatedTypeNames) { | ||
| const newTypeName = typeName.slice(1); | ||
| // "IProps": "Props" | ||
| DEPRECATED_TYPES_MAPPING[typeName] = newTypeName; | ||
| // "Props": "@blueprintjs/core" | ||
| NEW_TYPE_PACKAGE_MAPPING[newTypeName] = packageName; | ||
| } | ||
| } |
There was a problem hiding this comment.
i kind of wonder if this is logic we should be running unilaterally as part of importing this rule, or if it should instead be worked into the logic within the rule but without the for loop.
There was a problem hiding this comment.
moved it into the create callback
| const MySelect = Select.ofType<TimezoneItem>(); | ||
| `, | ||
| }, | ||
| { |
There was a problem hiding this comment.
can you add a test for when there are multiple imports from the same package?
There was a problem hiding this comment.
I tried to do this, but for some reason the rule tester fixer doesn't like to run multiple auto-fixes. so when I write a test like this:
import { IItemRendererProps, ISelectProps } from "@blueprintjs/select";
const mySelectProps: ISelectProps = { items: [], renderItem };
const renderItem = (_item: any, { handleClick, modifiers }: IItemRendererProps) => {
return <MenuItem {...modifiers} onClick={handleClick} />;
};expecting it to be autofixed to:
import { ItemRendererProps, SelectProps } from "@blueprintjs/select";
const mySelectProps: SelectProps = { items: [], renderItem };
const renderItem = (_item: any, { handleClick, modifiers }: ItemRendererProps) => {
return <MenuItem {...modifiers} onClick={handleClick} />;
};then it doesn't pass, since the rule tester only runs the first auto-fix. I don't want to write a test with weird expected output showing only one of the deprecated type symbols being fixed. I can look into if this is a bug on ESLint's part...
There was a problem hiding this comment.
is it possible to test without the fixer, but show that both symbols are flagged as errors instead?
There was a problem hiding this comment.
discussed offline, ESLint does not allow testing fixable rules without running their fixers. probably another FR for ESLint given the limitations of fixer output in RuleTester (see eslint/eslint#11187 (comment))
Merge remote-tracking branch 'origin/develop' into ad/lint-no-deprecated-interfacesPreviews: documentation | landing | table | demo |
add link to code commentPreviews: documentation | landing | table | demo |
Changes proposed in this pull request:
New ESLint rule
@blueprintjs/no-deprecated-type-referencesto flag & fix usage of deprecated interfaces in preparation for Blueprint v5.0.