TSSymbol

A TypeScript symbol representing a code element with advanced manipulation capabilities. This class extends Symbol and Exportable to provide TypeScript-specific functionality for managing code symbols. It offers methods for handling imports, comments, code refactoring, and file operations like moving symbols between files while maintaining their dependencies and references. The class provides functionality for managing both inline and block comments, setting and retrieving import strings, and maintaining semicolon presence. It includes capabilities for moving symbols between files with options to handle dependencies and import strategy selection.

View Source on Github

Inherits from

Exportable, Symbol, Usable, Importable, Expression, HasName, Editable

Attributes

comment

dependencies

export

exported_name

extended

extended_nodes

extended_source

file

file_node_id

filepath

full_name

function_calls

has_semicolon

inline_comment

is_exported

is_reexported

name

node_type

parent

parent_class

parent_function

parent_statement

resolved_value

semicolon_node

source

symbol_type

ts_node

variable_usages

Methods

add_comment

Adds a new comment to the symbol.

View Source on Github

Parameters

add_keyword

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

View Source on Github

Parameters

ancestors

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

View Source on Github

edit

Replace the source of this node with new_src.

View Source on Github

Parameters

find

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

View Source on Github

Parameters

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

flag

Adds a visual flag comment to the end of this Editable’s source text.

View Source on Github

get_import_string

Generates the appropriate import string for a symbol.

View Source on Github

Parameters

get_name

Returns the name node of the object.

View Source on Github

get_variable_usages

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

View Source on Github

Parameters

insert_after

Inserts code after this node.

View Source on Github

Parameters

insert_before

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

View Source on Github

Parameters

is_wrapped_in

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

View Source on Github

move_to_file

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

View Source on Github

Parameters

parent_of_type

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

View Source on Github

reduce_condition

Reduces an editable to the following condition

View Source on Github

remove

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

View Source on Github

Parameters

rename

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

View Source on Github

Parameters

replace

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

View Source on Github

Parameters

search

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

View Source on Github

Parameters

set_comment

Sets a comment to the symbol.

View Source on Github

Parameters

set_inline_comment

Sets an inline comment to the symbol.

View Source on Github

Parameters

set_name

Sets the name of a code element.

View Source on Github

Parameters

symbol_usages

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

View Source on Github

Parameters

usages

Returns a list of usages of the exportable object.

View Source on Github

Parameters