-
Notifications
You must be signed in to change notification settings - Fork 26
/
extension.ts
199 lines (177 loc) · 7.98 KB
/
extension.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
'use strict';
import * as vscode from 'vscode';
import * as solargraph from 'solargraph-utils';
import { LanguageClient, Disposable } from 'vscode-languageclient/node';
import { makeLanguageClient } from './language-client';
import SolargraphWebviewProvider from './SolargraphWebviewProvider';
import { configureShell } from './configure-shell';
const isRelative = require('is-relative');
let languageClient: LanguageClient;
export function activate(context: vscode.ExtensionContext) {
let haveWorkspace = function () {
return (vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders[0]);
};
let firstWorkspace = function () {
return haveWorkspace() ? vscode.workspace.workspaceFolders![0].uri.fsPath : null;
};
let isBare = function (str: String) {
return ((str.search(/\//) == -1) && (str.search(/\\/) == -1));
};
let applyConfiguration = function (config: solargraph.Configuration) {
let vsconfig = vscode.workspace.getConfiguration('solargraph');
if (!vsconfig.commandPath) {
// Given there is a default value for commandPath in package.json, this branch shouldn't
// be reachable. Still, better safe than sorry...
// Search for 'solargraph' in the shell environment's PATH
config.commandPath = 'solargraph';
} else if (isBare(vsconfig.commandPath)) {
// Search for the binary name in the shell environment's PATH
config.commandPath = vsconfig.commandPath;
} else if (isRelative(vsconfig.commandPath) && haveWorkspace()) {
// For portability, try to make any other relative path absolute with respect to the
// root of the vscode project, rather than letting solargraph-utils try to resolve it
// from whatever random directory VS Code chooses as its current working directory
// (often not even inside the project). This makes it so that you can specify,
// e.g. "bin/solargraph" to use a version of solargraph shipped within the project.
config.commandPath = vscode.Uri.joinPath(vscode.workspace.workspaceFolders![0].uri, vsconfig.commandPath).fsPath;
} else {
// Either already an absolute path, or it is a relative path but we don't have a
// workspace to join it with to make it absolute.
config.commandPath = vsconfig.commandPath;
}
config.useBundler = vsconfig.useBundler || false;
config.bundlerPath = vsconfig.bundlerPath || 'bundle';
config.viewsPath = vscode.extensions.getExtension('castwide.solargraph')!.extensionPath + '/views';
config.withSnippets = vsconfig.withSnippets || false;
// @ts-ignore TODO: This needs to be fixed in solargraph-utils
config.workspace = firstWorkspace();
// TODO: Temporary placeholder until shellArgs is supported in configuration
let args;
[config.shell, args] = configureShell();
};
let solargraphConfiguration = new solargraph.Configuration();
applyConfiguration(solargraphConfiguration);
let disposableClient: Disposable;
let webViewProvider: SolargraphWebviewProvider = new SolargraphWebviewProvider();
var startLanguageServer = function () {
languageClient = makeLanguageClient(solargraphConfiguration);
languageClient.onReady().then(() => {
languageClient.onNotification('$/solargraph/restart', (params) => {
restartLanguageServer();
});
}).catch((err) => {
console.log('Error starting Solargraph socket provider', err);
if (err.toString().includes('ENOENT') || err.toString().includes('command not found')) {
vscode.window.showErrorMessage('Solargraph gem not found. Run `gem install solargraph` or update your Gemfile.', 'Install Now').then((item) => {
if (item == 'Install Now') {
solargraph.installGem(solargraphConfiguration).then(() => {
vscode.window.showInformationMessage('Successfully installed the Solargraph gem.');
startLanguageServer();
}).catch(() => {
vscode.window.showErrorMessage('Failed to install the Solargraph gem.');
});
}
});
} else {
vscode.window.showErrorMessage("Failed to start Solargraph: " + err);
}
});
disposableClient = languageClient.start();
webViewProvider.setLanguageClient(languageClient);
context.subscriptions.push(disposableClient);
};
var restartLanguageServer = function (): void {
if (disposableClient) {
disposableClient.dispose();
}
startLanguageServer();
};
// Open URL command (used internally for browsing documentation pages)
var disposableOpenUrl = vscode.commands.registerCommand('solargraph._openDocumentUrl', (uriString: string) => {
var hashed = uriString.replace('#', '%23');
var uri = vscode.Uri.parse(hashed);
webViewProvider.open(uri);
});
context.subscriptions.push(disposableOpenUrl);
// Restart command
var disposableRestart = vscode.commands.registerCommand('solargraph.restart', () => {
restartLanguageServer();
vscode.window.showInformationMessage('Solargraph server restarted.');
});
context.subscriptions.push(disposableRestart);
// Search command
var disposableSearch = vscode.commands.registerCommand('solargraph.search', () => {
vscode.window.showInputBox({ prompt: 'Search Ruby documentation:' }).then(val => {
if (val) {
var uri = 'solargraph:/search?query=' + encodeURIComponent(val);
webViewProvider.open(vscode.Uri.parse(uri));
}
});
});
context.subscriptions.push(disposableSearch);
// Environment command
var disposableEnv = vscode.commands.registerCommand('solargraph.environment', () => {
var uri = vscode.Uri.parse('solargraph:/environment');
webViewProvider.open(uri);
});
context.subscriptions.push(disposableEnv);
// Check gem version command
var disposableCheckGemVersion = vscode.commands.registerCommand('solargraph.checkGemVersion', () => {
languageClient.sendNotification('$/solargraph/checkGemVersion', { verbose: true });
});
context.subscriptions.push(disposableCheckGemVersion);
var doBuildGemDocs = function (rebuild: Boolean) {
let message = (rebuild ? 'Rebuilding all gem documentation...' : 'Building new gem documentation');
let prepareStatus = vscode.window.setStatusBarMessage(message);
try {
languageClient.sendRequest('$/solargraph/documentGems', { rebuild: rebuild }).then((response: any) => {
prepareStatus.dispose();
if (response['status'] == 'ok') {
vscode.window.setStatusBarMessage('Gem documentation complete.', 3000);
} else {
vscode.window.setStatusBarMessage('An error occurred building gem documentation.', 3000);
}
});
} catch (err: any) {
prepareStatus.dispose();
vscode.window.showErrorMessage('The language server is still initializing. Please try again shortly. (Error: ' + err.message + ')');
}
};
// Build gem documentation command
var disposableBuildGemDocs = vscode.commands.registerCommand('solargraph.buildGemDocs', () => {
doBuildGemDocs(false);
});
context.subscriptions.push(disposableBuildGemDocs);
// Rebuild gems documentation command
var disposableRebuildAllGemDocs = vscode.commands.registerCommand('solargraph.rebuildAllGemDocs', () => {
doBuildGemDocs(true);
});
context.subscriptions.push(disposableRebuildAllGemDocs);
// Solargraph configuration command
var disposableSolargraphConfig = vscode.commands.registerCommand('solargraph.config', () => {
var child = solargraph.commands.solargraphCommand(['config'], solargraphConfiguration);
child.on('exit', (code) => {
if (code == 0) {
vscode.window.showInformationMessage('Created default .solargraph.yml file.');
} else {
vscode.window.showErrorMessage('Error creating .solargraph.yml file.');
}
});
});
context.subscriptions.push(disposableSolargraphConfig);
// Solargraph download core command
var disposableSolargraphDownloadCore = vscode.commands.registerCommand('solargraph.downloadCore', () => {
if (languageClient) {
languageClient.sendNotification('$/solargraph/downloadCore');
} else {
vscode.window.showInformationMessage('Solargraph is still starting. Please try again in a moment.');
}
});
context.subscriptions.push(disposableSolargraphDownloadCore);
startLanguageServer();
}
export function deactivate() {
if (languageClient) {
languageClient.stop();
}
}