graph-sitter
Documentation menu

TSAssignment

A class representing TypeScript assignments, including variable declarations and property assignments. Handles various types of TypeScript assignments including variable declarators, assignment expressions, augmented assignments, property signatures, and public field definitions. It provides functionality for manipulating assignments and managing their associated types and comments.

View source on GitHub

Inherits from

TSSymbol, Assignment, Exportable, Symbol, HasValue, Typeable, Usable, Importable, Editable, Expression, HasName

Attributes

comment

Retrieves the comment group associated with the symbol.

export

Returns the export object that exports this symbol.

exported_name

Retrieves the exported name of a symbol from its file.

extended

Returns a SymbolGroup of all extended nodes associated with this element.

extended_nodes

Returns the list of nodes associated with this symbol including extended nodes.

extended_source

Returns the source text representation of all extended nodes.

file

The file object that this Editable instance belongs to.

filepath

The file path of the file that this Editable instance belongs to.

full_name

Returns the full name of the object, including the namespace path.

function_calls

Returns a list of all function calls contained within this expression.

has_semicolon

Checks whether the current symbol has a semicolon at the end.

index

Returns the index of the assignment statement in its parent's code block.

inline_comment

Property that retrieves the inline comment group associated with the symbol.

is_exported

Indicates if the symbol is exported from its defining file.

is_local_variable

Determines if an assignment represents a local variable in the current scope.

is_reexported

Determines if the symbol is re-exported from a different file.

is_typed

Indicates if a node has an explicit type annotation.

name

Retrieves the base name of the object without namespace prefixes.

parent

The parent node of this Editable instance.

parent_class

Find the class this node is contained in

parent_function

Find the function this node is contained in

parent_statement

Find the statement this node is contained in

resolved_value

Returns the resolved type of an Expression.

semicolon_node

Retrieves the semicolon node associated with a TypeScript symbol.

source

Returns the source code of the symbol.

symbol_type

The type of symbol, set to SymbolType.GlobalVar.

type

The type annotation associated with this node

value

Gets the value node of the object.

variable_usages

Returns Editables for all TreeSitter node instances of variable usages within this node's

Methods

add_comment

Adds a new comment to the symbol.

View source on GitHub

Parameters

commentrequired

The comment text to be added.

auto_formatdefault: True

Whether to automatically format the text into a comment style. Defaults to True.

clean_formatdefault: True

Whether to clean the format of the comment before inserting. Defaults to True.

comment_typedefault: TSCommentType.DOUBLE_SLASH

Type of comment to add. Defaults to TSCommentType.DOUBLE_SLASH.

Returns

add_keyword

Insert a keyword in the appropriate place before this symbol if it doesn't already exist.

View source on GitHub

Parameters

keywordrequired

The keyword to be inserted. Must be a valid keyword in the language context.

Returns

ancestors

Find all ancestors of the node of the given type. Does not return itself

View source on GitHub

Returns

dependencies

Returns a list of symbols that this symbol depends on.

View source on GitHub

Parameters

usage_typesdefault: UsageType.DIRECT

The types of dependencies to search for. Defaults to UsageType.DIRECT.

max_depthdefault: None

Maximum depth to traverse in the dependency graph. If provided, will recursively collect

Returns

A list of symbols and imports that this symbol depends on, sorted by file location.

edit

Replace the source of this node with new_src.

View source on GitHub

Parameters

new_srcrequired

The new source code to replace the current source with.

fix_indentationdefault: False

If True, adjusts the indentation of new_src to match the current text's indentation. Defaults to False.

prioritydefault: 0

The priority of this edit. Higher priority edits take precedence. Defaults to 0.

dedupedefault: True

If True, prevents duplicate edits. Defaults to True.

Returns

find

Find and return matching nodes or substrings within an Editable instance.

View source on GitHub

Parameters

strings_to_matchrequired

One or more strings to search for.

exactdefault: False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

A list of Editable instances that match the search criteria.

find_string_literals

Returns a list of string literals within this node's source that match any of the given

View source on GitHub

Parameters

strings_to_matchrequired

A list of strings to search for in string literals.

fuzzy_matchdefault: False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

A list of Editable objects representing the matching string literals.

flag

Flags a TypeScript symbol by adding a flag comment and returning a CodeFlag.

View source on GitHub

Returns

The code flag object for tracking purposes

from_named_expression

Creates a MultiExpression object from a TypeScript named expression node.

View source on GitHub

Parameters

ts_noderequired

The TypeScript node representing the named expression.

file_node_idrequired

The unique identifier for the file containing this node.

ctxrequired

The graph representation of the codebase.

parentrequired

The parent node containing this expression.

Returns

A MultiExpression object containing the constructed assignments.

get_import_string

Generates the appropriate import string for a symbol.

View source on GitHub

Parameters

aliasdefault: None

The alias to use for the imported symbol. Defaults to None.

moduledefault: None

The module to import from. If None, uses the file's import module name.

import_typedefault: ImportType.UNKNOWN

The type of import to generate (e.g., WILDCARD). Defaults to

is_type_importdefault: False

Whether this is a type-only import. Defaults to False.

Returns

A formatted import statement string.

get_name

Returns the name node of the object.

View source on GitHub

Returns

The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name.

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

View source on GitHub

Parameters

var_namerequired

The variable name to search for.

fuzzy_matchdefault: False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

List of Editable objects representing variable usage nodes matching the given name.

insert_after

Inserts code after this node.

View source on GitHub

Parameters

new_srcrequired

The source code to insert after this node.

fix_indentationdefault: False

Whether to adjust the indentation of new_src to match the current node. Defaults to False.

newlinedefault: True

Whether to add a newline before the new_src. Defaults to True.

prioritydefault: 0

Priority of the insertion transaction. Defaults to 0.

dedupedefault: True

Whether to deduplicate identical transactions. Defaults to True.

Returns

insert_before

Inserts text before the current symbol node in the Abstract Syntax Tree.

View source on GitHub

Parameters

new_srcrequired

The source code text to insert.

fix_indentationdefault: False

Whether to adjust the indentation of new_src to match current text. Defaults to False.

newlinedefault: True

Whether to add a newline after insertion. Defaults to True.

prioritydefault: 0

Priority of this edit operation. Higher priority edits are applied first. Defaults to 0.

dedupedefault: True

Whether to remove duplicate insertions. Defaults to True.

extendeddefault: True

Whether to insert before extended nodes like comments and decorators. Defaults to True.

Returns

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

View source on GitHub

Returns

is_wrapped_in

Check if this node is contained another node of the given class

View source on GitHub

Returns

local_usages

Retrieves all usages of the assigned variable within its code block scope.

View source on GitHub

Returns

A sorted list of statement nodes where the variable is used.

move_to_file

Moves the given symbol to a new file and updates its imports and references.

View source on GitHub

Parameters

filerequired

The destination file to move the symbol to.

include_dependenciesdefault: True

If True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True.

strategydefault: "update_all_imports"

The strategy to use for updating imports. Can be either 'add_back_edge' or 'update_all_imports'. Defaults to 'update_all_imports'.

Returns

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

View source on GitHub

Returns

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

View source on GitHub

Returns

reduce_condition

Simplifies an assignment expression by reducing it based on a boolean condition and updating all the usages.

View source on GitHub

Parameters

bool_conditionrequired

The boolean value to reduce the condition to.

Returns

remove

Deletes this Node and its related extended nodes (e.g. decorators, comments).

View source on GitHub

Parameters

delete_formattingdefault: True

Whether to delete surrounding whitespace and formatting. Defaults to True.

prioritydefault: 0

Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.

dedupedefault: True

Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

rename

Renames a symbol and updates all its references in the codebase.

View source on GitHub

Parameters

new_namerequired

The new name for the symbol.

prioritydefault: 0

Priority of the edit operation. Defaults to 0.

Returns

A tuple containing the file node ID and the new node ID of the renamed symbol.

replace

Search and replace occurrences of text within this node's source and its extended nodes.

View source on GitHub

Parameters

oldrequired

The text or pattern to search for.

newrequired

The text to replace matches with.

countdefault: -1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regexdefault: False

Whether to treat 'old' as a regex pattern. Defaults to False.

prioritydefault: 0

Priority of the replacement operation. Defaults to 0.

Returns

The total number of replacements made.

Returns a list of all regex match of regex_pattern, similar to python's re.search().

View source on GitHub

Parameters

regex_patternrequired

The regular expression pattern to search for.

include_stringsdefault: True

When False, excludes the contents of string literals from the search. Defaults to True.

include_commentsdefault: True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

A list of Editable objects corresponding to the matches found.

set_comment

Sets a comment to the symbol.

View source on GitHub

Parameters

commentrequired

The comment text to be added.

auto_formatdefault: True

Whether to automatically format the text into a comment syntax.

clean_formatdefault: True

Whether to clean the format of the comment before inserting.

comment_typedefault: TSCommentType.DOUBLE_SLASH

The style of comment to add.

Returns

set_inline_comment

Sets an inline comment for an assignment node.

View source on GitHub

Parameters

commentrequired

The comment text to set.

auto_formatdefault: True

Whether to automatically format the comment. Defaults to True.

clean_formatdefault: True

Whether to clean existing formatting. Defaults to True.

Returns

set_name

Sets the name of a code element.

View source on GitHub

Parameters

namerequired

The new name to set for the object.

Returns

set_type_annotation

Adds or updates a type annotation for the current assignment.

View source on GitHub

Parameters

type_strrequired

The type annotation to be added or updated.

Returns

set_value

Sets the value of an assignment expression.

View source on GitHub

Parameters

srcrequired

The source code string representing the new value to be assigned.

Returns

symbol_usages

Returns a list of symbols that use or import the exportable object.

View source on GitHub

Parameters

usage_typesdefault: None

The types of usages to search for. Defaults to any.

Returns

A list of symbols that use or import the exportable object.

usages

Returns a list of usages of the exportable object.

View source on GitHub

Parameters

usage_typesdefault: None

Specifies which types of usages to include in the results. Default is any usages.

Returns

A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse.