-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat(eslint-plugin): add no-unsafe-declaration-merging #5840
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
1417919
28560e0
944a5a4
231ff6f
9be6acc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
description: 'Disallow unsafe declaration merging.' | ||
--- | ||
|
||
> 🛑 This file is source code, not the primary documentation location! 🛑 | ||
> | ||
> See **https://typescript-eslint.io/rules/no-unsafe-declaration-merging** for documentation. | ||
|
||
TypeScript's "declaration merging" supports merging separate declarations with the same name. | ||
|
||
Declaration merging between classes and interfaces is unsafe. | ||
The TypeScript compiler doesn't check whether properties are initialized, which can cause lead to TypeScript not detecting code that will cause runtime errors. | ||
|
||
```ts | ||
interface Foo { | ||
nums: number[]; | ||
} | ||
|
||
class Foo {} | ||
|
||
const foo = new Foo(); | ||
|
||
foo.nums.push(1); // Runtime Error: Cannot read properties of undefined. | ||
``` | ||
|
||
## Examples | ||
|
||
<!--tabs--> | ||
|
||
### ❌ Incorrect | ||
|
||
```ts | ||
interface Foo {} | ||
|
||
class Foo {} | ||
``` | ||
|
||
### ✅ Correct | ||
|
||
```ts | ||
interface Foo {} | ||
class Bar implements Foo {} | ||
|
||
namespace Baz {} | ||
namespace Baz {} | ||
enum Baz {} | ||
|
||
namespace Qux {} | ||
function Qux() {} | ||
``` | ||
|
||
## Further Reading | ||
|
||
- [Declaration Merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
import type { TSESTree } from '@typescript-eslint/utils'; | ||
import * as ts from 'typescript'; | ||
|
||
import * as util from '../util'; | ||
|
||
export default util.createRule({ | ||
name: 'no-unsafe-declaration-merging', | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'Disallow unsafe declaration merging', | ||
recommended: 'strict', | ||
requiresTypeChecking: true, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should actually be able to do this without type info and just with the scope analysis APIs. You can see that if the names clash, then we can iterate through the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, I should finally get familiar with the scope manager 😄. #5854 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @yeonjuan do you have time to tackle this soon? I can if not, no worries 😄 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi @bradzacher, @JoshuaKGoldberg I can fix this soon. I'll make a PR for it. (including fixing typo) |
||
}, | ||
messages: { | ||
unsafeMerging: | ||
'Unsafe declaration merging between classes and interfaces.', | ||
}, | ||
schema: [], | ||
}, | ||
defaultOptions: [], | ||
create(context) { | ||
const parserServices = util.getParserServices(context); | ||
const checker = parserServices.program.getTypeChecker(); | ||
|
||
function checkUnsafeDeclaration( | ||
node: TSESTree.Identifier, | ||
unsafeKind: ts.SyntaxKind, | ||
): void { | ||
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(node); | ||
const type = checker.getTypeAtLocation(tsNode); | ||
const symbol = type.getSymbol(); | ||
if (symbol?.declarations?.some(decl => decl.kind === unsafeKind)) { | ||
context.report({ | ||
node, | ||
messageId: 'unsafeMerging', | ||
}); | ||
} | ||
} | ||
|
||
return { | ||
ClassDeclaration(node): void { | ||
if (node.id) { | ||
checkUnsafeDeclaration(node.id, ts.SyntaxKind.InterfaceDeclaration); | ||
} | ||
}, | ||
TSInterfaceDeclaration(node): void { | ||
checkUnsafeDeclaration(node.id, ts.SyntaxKind.ClassDeclaration); | ||
}, | ||
}; | ||
}, | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
import rule from '../../src/rules/no-unsafe-declaration-merging'; | ||
import { getFixturesRootDir, RuleTester } from '../RuleTester'; | ||
|
||
const rootPath = getFixturesRootDir(); | ||
|
||
const ruleTester = new RuleTester({ | ||
parser: '@typescript-eslint/parser', | ||
parserOptions: { | ||
sourceType: 'module', | ||
tsconfigRootDir: rootPath, | ||
project: './tsconfig.json', | ||
}, | ||
}); | ||
|
||
ruleTester.run('no-unsafe-declaration-merging', rule, { | ||
valid: [ | ||
` | ||
interface Foo {} | ||
class Bar implements Foo {} | ||
`, | ||
` | ||
namespace Foo {} | ||
namespace Foo {} | ||
`, | ||
` | ||
enum Foo {} | ||
namespace Foo {} | ||
`, | ||
` | ||
namespace Fooo {} | ||
function Foo() {} | ||
`, | ||
` | ||
const Foo = class {}; | ||
`, | ||
` | ||
interface Foo { | ||
props: string; | ||
} | ||
|
||
function bar() { | ||
return class Foo {}; | ||
} | ||
`, | ||
` | ||
interface Foo { | ||
props: string; | ||
} | ||
|
||
(function bar() { | ||
class Foo {} | ||
})(); | ||
`, | ||
` | ||
declare global { | ||
interface Foo {} | ||
} | ||
|
||
class Foo {} | ||
`, | ||
], | ||
invalid: [ | ||
{ | ||
code: ` | ||
interface Foo {} | ||
class Foo {} | ||
`, | ||
errors: [ | ||
{ | ||
messageId: 'unsafeMerging', | ||
JoshuaKGoldberg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
line: 2, | ||
column: 11, | ||
}, | ||
{ | ||
messageId: 'unsafeMerging', | ||
line: 3, | ||
column: 7, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: ` | ||
namespace Foo { | ||
export interface Bar {} | ||
} | ||
namespace Foo { | ||
export class Bar {} | ||
} | ||
`, | ||
errors: [ | ||
{ | ||
messageId: 'unsafeMerging', | ||
line: 3, | ||
column: 20, | ||
}, | ||
{ | ||
messageId: 'unsafeMerging', | ||
line: 6, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: ` | ||
declare global { | ||
interface Foo {} | ||
class Foo {} | ||
} | ||
`, | ||
errors: [ | ||
{ | ||
messageId: 'unsafeMerging', | ||
line: 3, | ||
column: 13, | ||
}, | ||
{ | ||
messageId: 'unsafeMerging', | ||
line: 4, | ||
column: 9, | ||
}, | ||
], | ||
}, | ||
], | ||
}); | ||
JoshuaKGoldberg marked this conversation as resolved.
Show resolved
Hide resolved
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops typo!