Skip to content

fix(eslint-plugin): [no-deprecated] check if a JSX attribute is deprecated #10374

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Dec 7, 2024
Merged

fix(eslint-plugin): [no-deprecated] check if a JSX attribute is deprecated #10374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ea6c5ec
test : add testcase
mdm317 Nov 23, 2024
a06f122
fix : check if a JSX attribute is deprecated
mdm317 Nov 23, 2024
ba379b4
test : fix text result
mdm317 Nov 23, 2024
8b90666
fix : check all jsx names
mdm317 Nov 26, 2024
63afd1d
test : add test case for all jsx name
mdm317 Nov 26, 2024
f1c5b10
Merge branch 'main' into fix/issue-10275-no-deprecated
mdm317 Nov 26, 2024
e25b6a2
test : increase coverage
mdm317 Nov 28, 2024
96f3b76
fix : type assertion for test coverage
mdm317 Nov 28, 2024
3309db8
refactor : change variable name
mdm317 Nov 29, 2024
63b00e1
Update packages/eslint-plugin/src/rules/no-deprecated.ts
mdm317 Dec 7, 2024
b808836
Merge branch 'main' into fix/issue-10275-no-deprecated
mdm317 Dec 7, 2024
ae9717e
Add a test case namespace and attribute are of type "any" "unknown" "…
mdm317 Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/eslint-plugin/src/rules/no-deprecated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,11 +274,35 @@ export default createRule({
);
}

function getJSXAttributeDeprecation(
openingElement: TSESTree.JSXOpeningElement,
propertyName: string,
): string | undefined {
const tsNode = services.esTreeNodeToTSNodeMap.get(openingElement.name);

const contextualType = nullThrows(
checker.getContextualType(tsNode as ts.Expression),
'Expected JSX opening element name to have contextualType',
);

const symbol = contextualType.getProperty(propertyName);

return getJsDocDeprecation(symbol);
}

function getDeprecationReason(node: IdentifierLike): string | undefined {
const callLikeNode = getCallLikeNode(node);
if (callLikeNode) {
return getCallLikeDeprecation(callLikeNode);
}

if (
node.parent.type === AST_NODE_TYPES.JSXAttribute &&
node.type !== AST_NODE_TYPES.Super
) {
return getJSXAttributeDeprecation(node.parent.parent, node.name);
}

if (
node.parent.type === AST_NODE_TYPES.Property &&
node.type !== AST_NODE_TYPES.Super
Expand Down
154 changes: 139 additions & 15 deletions packages/eslint-plugin/tests/rules/no-deprecated.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,21 +205,6 @@ ruleTester.run('no-deprecated', rule, {
default as ts,
} from 'typescript';
`,

// TODO: Can anybody figure out how to get this to report on `b`?
// getContextualType retrieves the union type, but it has no symbol...
`
interface AProps {
/** @deprecated */
b: number | string;
}

function A(props: AProps) {
return <div />;
}

const a = <A b="" />;
`,
`
namespace A {
/** @deprecated */
Expand Down Expand Up @@ -284,8 +269,75 @@ ruleTester.run('no-deprecated', rule, {
}
}
`,
`
declare namespace JSX {}

<foo bar={1} />;
`,
`
declare namespace JSX {
interface IntrinsicElements {
foo: any;
}
}

<foo bar={1} />;
`,
`
declare namespace JSX {
interface IntrinsicElements {
foo: unknown;
}
}

<foo bar={1} />;
`,
`
declare namespace JSX {
interface IntrinsicElements {
foo: {
bar: any;
};
}
}
<foo bar={1} />;
`,
`
declare namespace JSX {
interface IntrinsicElements {
foo: {
bar: unknown;
};
}
}
<foo bar={1} />;
`,
],
invalid: [
{
code: `
interface AProps {
/** @deprecated */
b: number | string;
}

function A(props: AProps) {
return <div />;
}

const a = <A b="" />;
`,
errors: [
{
column: 22,
data: { name: 'b' },
endColumn: 23,
endLine: 11,
line: 11,
messageId: 'deprecated',
},
],
},
{
code: `
/** @deprecated */ var a = undefined;
Expand Down Expand Up @@ -2550,5 +2602,77 @@ class B extends A {
},
],
},
{
code: 'const a = <div aria-grabbed></div>;',
errors: [
{
column: 16,
data: { name: 'aria-grabbed', reason: 'in ARIA 1.1' },
endColumn: 28,
endLine: 1,
line: 1,
messageId: 'deprecatedWithReason',
},
],
},
{
code: `
declare namespace JSX {
interface IntrinsicElements {
'foo-bar:baz-bam': {
name: string;
/**
* @deprecated
*/
deprecatedProp: string;
};
}
}

const componentDashed = <foo-bar:baz-bam name="e" deprecatedProp="oh no" />;
`,
errors: [
{
column: 59,
data: { name: 'deprecatedProp' },
endColumn: 73,
endLine: 14,
line: 14,
messageId: 'deprecated',
},
],
},
{
code: `
import * as React from 'react';

interface Props {
/**
* @deprecated
*/
deprecatedProp: string;
}

interface Tab {
List: React.FC<Props>;
}

const Tab: Tab = {
List: () => <div>Hi</div>,
};

const anotherExample = <Tab.List deprecatedProp="oh no" />;
`,
errors: [
{
column: 42,
data: { name: 'deprecatedProp' },
endColumn: 56,
endLine: 19,
line: 19,
messageId: 'deprecated',
},
],
},
],
});
Loading