Lsproxy Docs

Get Started

API Reference

The input position should point to the identifier of the symbol you want to get the references for.

Returns a list of locations where the symbol at the given position is referenced.

The returned positions point to the start of the reference identifier.

e.g. for `User` on line 0 of `src/main.py`:
```
 0: class User:
 input____^^^^
 1:     def __init__(self, name, age):
 2:         self.name = name
 3:         self.age = age
 4:
 5: user = User("John", 30)
 output____^
```

Find all references to a symbol

Response to a references request.

Points to the start position of the symbol's identifier.

e.g. for the references of `User` on line 0 character 6 of `src/main.py` with the code:
```
0: class User:
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age
4:
5: user = User("John", 30)
_________^
6:
7: print(user.name)
```
The references will be `[{"path": "src/main.py", "line": 5, "character": 7}]`.

Returns a list of symbols (functions, classes, variables, etc.) defined in the specified file.

Only the variabels defined at the file level are included.

The returned positions point to the start of the symbol's identifier.

e.g. for `User` on line 0 of `src/main.py`:
```
0: class User:
_________^
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age
```

Get symbols in a specific file (uses ast-grep)

Returns the location of the definition for the symbol at the given position.

The input position should point inside the symbol's identifier, e.g.

The returned position points to the identifier of the symbol, and the file_path from workspace root

e.g. for the definition of `User` on line 5 of `src/main.py` with the code:
```
0: class User:
output___^
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age
4:
5: user = User("John", 30)
input_____^^^^
```

Get the definition of a symbol at a specific position in a file

Returns an array of file paths for all files in the current workspace.

This is a convenience endpoint that does not use the underlying Language Servers directly, but it does apply the same filtering.

Get a list of all files in the workspace

Returns the contents of the specified file.

symbol

workspace

Body

Response