Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-27 21:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #15779 - Veykril:open-docs, r=Veykril

Browse source 
Add command for only opening external docs and attempt to fix vscode-remote issue

opening URI in a remote env causes vscode to ask the OS to handle `vscode-remote` URIs as there is no handler registered for such a scheme. This attempts to instruct vscode to handle those.

This is untested, as I can't figure out how to open a debug session on WSL rn.
This commit is contained in:
bors 2023-10-18 12:13:01 +00:00
commit 4586a6b26c
4 changed files with 47 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
editors/code/package.json
View file

@ -248,6 +248,11 @@
"title": "Open Docs",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openExternalDocs",
"title": "Open External Docs",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openCargoToml",
"title": "Open Cargo.toml",
@ -260,12 +265,12 @@
},
{
"command": "rust-analyzer.moveItemUp",
"title": "Move item up",
"title": "Move Item Up",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.moveItemDown",
"title": "Move item down",
"title": "Move Item Down",
"category": "rust-analyzer"
},
{

46
editors/code/src/commands.ts
View file

@ -948,27 +948,51 @@ export function openDocs(ctx: CtxInit): Cmd {
const position = editor.selection.active;
const textDocument = { uri: editor.document.uri.toString() };
const doclinks = await client.sendRequest(ra.openDocs, { position, textDocument });
const docLinks = await client.sendRequest(ra.openDocs, { position, textDocument });
log.debug(docLinks);
let fileType = vscode.FileType.Unknown;
if (typeof doclinks.local === "string") {
if (docLinks.local !== undefined) {
try {
fileType = (await vscode.workspace.fs.stat(vscode.Uri.parse(doclinks.local))).type;
fileType = (await vscode.workspace.fs.stat(vscode.Uri.parse(docLinks.local))).type;
} catch (e) {
log.debug("stat() threw error. Falling back to web version", e);
}
}
let doclink;
if (fileType & vscode.FileType.File) {
// file does exist locally
doclink = doclinks.local;
} else {
doclink = doclinks.web;
let docLink = fileType & vscode.FileType.File ? docLinks.local : docLinks.web;
if (docLink) {
// instruct vscode to handle the vscode-remote link directly
if (docLink.startsWith("vscode-remote://")) {
docLink = docLink.replace("vscode-remote://", "vscode://vscode-remote/");
}
const docUri = vscode.Uri.parse(docLink);
await vscode.env.openExternal(docUri);
}
};
}
if (doclink != null) {
await vscode.env.openExternal(vscode.Uri.parse(doclink));
export function openExternalDocs(ctx: CtxInit): Cmd {
return async () => {
const editor = vscode.window.activeTextEditor;
if (!editor) {
return;
}
const client = ctx.client;
const position = editor.selection.active;
const textDocument = { uri: editor.document.uri.toString() };
const docLinks = await client.sendRequest(ra.openDocs, { position, textDocument });
let docLink = docLinks.web;
if (docLink) {
// instruct vscode to handle the vscode-remote link directly
if (docLink.startsWith("vscode-remote://")) {
docLink = docLink.replace("vscode-remote://", "vscode://vscode-remote/");
}
const docUri = vscode.Uri.parse(docLink);
await vscode.env.openExternal(docUri);
}
};
}

8
editors/code/src/lsp_ext.ts
View file

@ -74,8 +74,8 @@ export interface FetchDependencyListParams {}
export interface FetchDependencyListResult {
crates: {
name: string | undefined;
version: string | undefined;
name?: string;
version?: string;
path: string;
}[];
}
@ -136,8 +136,8 @@ export const openCargoToml = new lc.RequestType<OpenCargoTomlParams, lc.Location
"experimental/openCargoToml",
);
export interface DocsUrls {
local: string | void;
web: string | void;
local?: string;
web?: string;
}
export const openDocs = new lc.RequestType<lc.TextDocumentPositionParams, DocsUrls, void>(
"experimental/externalDocs",

1
editors/code/src/main.ts
View file

@ -170,6 +170,7 @@ function createCommands(): Record<string, CommandFactory> {
debug: { enabled: commands.debug },
newDebugConfig: { enabled: commands.newDebugConfig },
openDocs: { enabled: commands.openDocs },
openExternalDocs: { enabled: commands.openExternalDocs },
openCargoToml: { enabled: commands.openCargoToml },
peekTests: { enabled: commands.peekTests },
moveItemUp: { enabled: commands.moveItemUp },