Skip to content

fix: include string literal children in kind queries #1689

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

Open
zanmlakar wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

fix: include string literal children in kind queries #1689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/ts-morph/src/compiler/ast/common/Node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4389,7 +4389,7 @@ function* getCompilerDescendantsIterator(node: ts.Node, sourceFile: ts.SourceFil
* of having to parse all the tokens via `node.getChildren()`.
*/
function useParseTreeSearchForKind(thisNodeOrSyntaxKind: Node | SyntaxKind, searchingKind: SyntaxKind) {
return searchingKind >= SyntaxKind.FirstNode && searchingKind < SyntaxKind.FirstJSDocNode
return (searchingKind === SyntaxKind.StringLiteral || searchingKind >= SyntaxKind.FirstNode && searchingKind < SyntaxKind.FirstJSDocNode)
&& getThisKind() !== SyntaxKind.SyntaxList;

function getThisKind() {
Expand Down
39 changes: 39 additions & 0 deletions packages/ts-morph/src/tests/compiler/ast/common/nodeTests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -849,6 +849,40 @@ class MyClass {
doTest("class C {} interface I {}", sourceFile => sourceFile.getChildSyntaxListOrThrow(), SyntaxKind.ClassDeclaration, ["class C {}"]);
});

it("should get string literal children of an array literal", () => {
doTest(
"[\"abc\", \"def\"];",
sourceFile => sourceFile.getFirstDescendantByKindOrThrow(SyntaxKind.ArrayLiteralExpression),
SyntaxKind.StringLiteral,
["\"abc\"", "\"def\""],
);
});

it("should get string literal children of a call expression", () => {
doTest(
"fn(\"abc\", \"def\");",
sourceFile => sourceFile.getFirstDescendantByKindOrThrow(SyntaxKind.CallExpression),
SyntaxKind.StringLiteral,
["\"abc\"", "\"def\""],
);
});

it("should get string literal children of a syntax list", () => {
doTest(
"[\"abc\", \"def\"];",
sourceFile => sourceFile.getFirstDescendantByKindOrThrow(SyntaxKind.ArrayLiteralExpression).getFirstChildByKindOrThrow(SyntaxKind.SyntaxList),
SyntaxKind.StringLiteral,
["\"abc\"", "\"def\""],
);
});

it("should get the first and last string literal children by kind", () => {
const { sourceFile } = getInfoFromText("[\"abc\", \"def\"];");
const arrayLiteral = sourceFile.getFirstDescendantByKindOrThrow(SyntaxKind.ArrayLiteralExpression);
expect(arrayLiteral.getFirstChildByKindOrThrow(SyntaxKind.StringLiteral).getLiteralValue()).to.equal("abc");
expect(arrayLiteral.getLastChildByKindOrThrow(SyntaxKind.StringLiteral).getLiteralValue()).to.equal("def");
});

it("should get children using .getChildren() when specifying a token kind", () => {
doTest("class C {}", sourceFile => sourceFile.getClassOrThrow("C"), SyntaxKind.OpenBraceToken, ["{"]);
});
Expand All @@ -859,6 +893,11 @@ class MyClass {
});

describe(nameof<Node>("getDescendantsOfKind"), () => {
it("should get nested string literals once in source order", () => {
const { sourceFile } = getInfoFromText("fn(\"abc\", [\"def\", \"ghi\"]);");
expect(sourceFile.getDescendantsOfKind(SyntaxKind.StringLiteral).map(node => node.getLiteralValue())).to.deep.equal(["abc", "def", "ghi"]);
});

it("should get the descendant by a kind", () => {
const { sourceFile } = getInfoFromText("interface Identifier { prop: string; }\ninterface MyInterface { nextProp: string; }");
const properties = sourceFile.getDescendantsOfKind(SyntaxKind.PropertySignature);
Expand Down