Skip to content
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

Jump to bottom

Fix NodePath.referencesImport for JSXMemberExpression #14403

Merged
merged 5 commits into from Mar 31, 2022
Merged

Fix NodePath.referencesImport for JSXMemberExpression #14403

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5454591
add failing test
swandir Mar 29, 2022
e072ba9
fix
swandir Mar 29, 2022
f7973e7
add Expression alias for JSXMemberExpression & update condition
swandir Mar 29, 2022
7db9378
make this NodePath<Node> instead
swandir Mar 30, 2022
1cc2a3e
remove useless type assertion
swandir Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 7 additions & 5 deletions packages/babel-traverse/src/path/introspection.ts
View file
Open in desktop
Expand Up @@ -175,16 +175,18 @@ export function isStatementOrBlock(this: NodePath): boolean {
*/

export function referencesImport(
this: NodePath<t.Expression>,
this: NodePath,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because JSXMemberExpression is not an Expression

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can mark it as NodePath<t.Expression | t.JSXMemberExpression>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, done
Though I wonder what's the point of narrowing the type of this here? all the other methods accept NodePath 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uhm yes that's a good observation. This method always work, it just return false for other node types.

You are right, NodePath is good enough here. Sorry!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I had a thought that making this type narrower doesn't make it more convenient for the TypeScript user, since they either would already be in a context where the type matches (e.g in a visitor) and won't notice, or would be forced to preclude the call with a manual check, which is performed inside the method anyway.

Sure, done

Reverted 😃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although...

function f(path: NodePath) {
  path.referencesImport("moduleSource", "importName");
}

this does not produce a TS error now 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's correct, right? It can return false for every unsupported node type, but it always knows what to return.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, if a function is typed to accept only a certain type as this, I'd expect TypeScript to prevent me from calling it on anything incompatible

https://www.typescriptlang.org/play?#code/GYVwdgxgLglg9mABMAFFAFjAzgLkQb0QEM8soAnGMAc0QF8BKAugKBYgTMTkQF4Dk9ANxs4AOlQMRQA

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! I forgot that definitions currently are published separately, and they differ. So this function signature does not affect third party usage. Mystery solved 😅

moduleSource: string,
importName: string,
): boolean {
if (!this.isReferencedIdentifier()) {
if (
(this.isMemberExpression() || this.isOptionalMemberExpression()) &&
(this.node.computed
? isStringLiteral(this.node.property, { value: importName })
: (this.node.property as t.Identifier).name === importName)
(this.isJSXMemberExpression() &&
(this.node.property as t.JSXIdentifier).name === importName) ||
((this.isMemberExpression() || this.isOptionalMemberExpression()) &&
(this.node.computed
? isStringLiteral(this.node.property, { value: importName })
: (this.node.property as t.Identifier).name === importName))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSXMemberExpression is never computed

) {
const object = (
this as NodePath<t.MemberExpression | t.OptionalMemberExpression>
Expand Down
8 changes: 8 additions & 0 deletions packages/babel-traverse/test/introspection.js
View file
Open in desktop
Expand Up @@ -161,6 +161,14 @@ describe("path/introspection", function () {
const reference = program.get("body.1.expression");
expect(reference.referencesImport("source", "😅")).toBe(true);
});
it("accepts a named import via a namespace import jsx member expression", function () {
const program = getPath(`import * as ns from "source"; <ns.dep />;`, {
sourceType: "module",
plugins: ["jsx"],
});
const reference = program.get("body.1.expression.openingElement.name");
expect(reference.referencesImport("source", "dep")).toBe(true);
});
it("rejects a named import from the wrong module", function () {
const program = getPath(`import { dep } from "wrong-source"; dep;`, {
sourceType: "module",
Expand Down