Getting locations of the variable declarations - visual-studio-code

Question

I am developing an extension which requires me to get the locations of the variable declarations.
For example,
var x = 5;
console.log(x);
Does the VS Code API provide functionality like getVariableLocations() which will return the position of the var x = 5;?

Answer 1

You can get the document symbols by running 'vscode.executeDocumentSymbolProvider'.
Here's an example that executes the command on the active document, and then converts the nested list of symbols (each DocumentSymbol can have children) into a flat list filtered by SymbolKind.Variable:
function findVars(symbols: vscode.DocumentSymbol[]): vscode.DocumentSymbol[] {
var vars =
symbols.filter(symbol => symbol.kind === vscode.SymbolKind.Variable);
return vars.concat(symbols.map(symbol => findVars(symbol.children))
.reduce((a, b) => a.concat(b), []));
}
var activeEditor = vscode.window.activeTextEditor;
if (activeEditor !== undefined) {
vscode.commands
.executeCommand<vscode.DocumentSymbol[]>(
'vscode.executeDocumentSymbolProvider', activeEditor.document.uri)
.then(symbols => {
if (symbols !== undefined) {
for (const variable of findVars(symbols)) {
console.log(variable.name);
}
}
});
}
When running this on this code snippet itself, it logs activeEditor, vars and variable. You can check the position with DocumentSymbol.range.