diff options
author | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-04-02 11:10:26 +0100 |
---|---|---|
committer | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-04-02 11:10:26 +0100 |
commit | bb3b159fb7d377f667732ade715cbe019da84d71 (patch) | |
tree | 2cfb500a2eec37f1689ec9448babbbfedc28fba0 /editors/code/src/commands/cargo_watch.ts | |
parent | b0d244719323d68905986857844f56d1fa38cac4 (diff) | |
parent | b60e2f779b28f654dbd5a2657c668de8452933c6 (diff) |
Merge #1079
1079: Improve cargo-watch usage in vscode plugin r=matklad a=edwin0cheng
*This PR try to improve current cargo-watch usage in VSCode :*
1. Add Multi-lines error support :
![multilines-error](https://i.imgur.com/gbLEwMG.gif)
2. Add cargo-watch status animation :
![cargo-watch-status](https://i.imgur.com/GbHwzjj.gif)
*Implementation Details*
* Current VSCode `ProblemMatcher` still do not support multiple line parsing.
* However we can, spawn a cargo watch process instead of using vscode.Task to allow more control.
* Use `cargo-check --message-format json` to get json format of compiler-message.
* Use `vscode.DiagnosticCollection` to manage the problems directly, which allow multiple lines diagnostic.
However,
* VSCode use non mono-space font for problems, at this moment i cannot find a good solution about it.
* I am not so good in typescript, please let me know if anything is bad in this PR.
Co-authored-by: Edwin Cheng <[email protected]>
Co-authored-by: Edwin Cheng <[email protected]>
Diffstat (limited to 'editors/code/src/commands/cargo_watch.ts')
-rw-r--r-- | editors/code/src/commands/cargo_watch.ts | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/editors/code/src/commands/cargo_watch.ts b/editors/code/src/commands/cargo_watch.ts new file mode 100644 index 000000000..6d8e4d885 --- /dev/null +++ b/editors/code/src/commands/cargo_watch.ts | |||
@@ -0,0 +1,211 @@ | |||
1 | import * as child_process from 'child_process'; | ||
2 | import * as fs from 'fs'; | ||
3 | import * as path from 'path'; | ||
4 | import * as vscode from 'vscode'; | ||
5 | import { Server } from '../server'; | ||
6 | import { terminate } from '../utils/processes'; | ||
7 | import { LineBuffer } from './line_buffer'; | ||
8 | import { StatusDisplay } from './watch_status'; | ||
9 | |||
10 | export class CargoWatchProvider { | ||
11 | private diagnosticCollection?: vscode.DiagnosticCollection; | ||
12 | private cargoProcess?: child_process.ChildProcess; | ||
13 | private outBuffer: string = ''; | ||
14 | private statusDisplay?: StatusDisplay; | ||
15 | private outputChannel?: vscode.OutputChannel; | ||
16 | |||
17 | public activate(subscriptions: vscode.Disposable[]) { | ||
18 | let cargoExists = false; | ||
19 | const cargoTomlFile = path.join( | ||
20 | vscode.workspace.rootPath!, | ||
21 | 'Cargo.toml' | ||
22 | ); | ||
23 | // Check if the working directory is valid cargo root path | ||
24 | try { | ||
25 | if (fs.existsSync(cargoTomlFile)) { | ||
26 | cargoExists = true; | ||
27 | } | ||
28 | } catch (err) { | ||
29 | cargoExists = false; | ||
30 | } | ||
31 | |||
32 | if (!cargoExists) { | ||
33 | vscode.window.showErrorMessage( | ||
34 | `Couldn\'t find \'Cargo.toml\' in ${cargoTomlFile}` | ||
35 | ); | ||
36 | return; | ||
37 | } | ||
38 | |||
39 | subscriptions.push(this); | ||
40 | this.diagnosticCollection = vscode.languages.createDiagnosticCollection( | ||
41 | 'rustc' | ||
42 | ); | ||
43 | |||
44 | this.statusDisplay = new StatusDisplay(subscriptions); | ||
45 | this.outputChannel = vscode.window.createOutputChannel( | ||
46 | 'Cargo Watch Trace' | ||
47 | ); | ||
48 | |||
49 | let args = '"check --message-format json'; | ||
50 | if (Server.config.cargoWatchOptions.checkArguments.length > 0) { | ||
51 | // Excape the double quote string: | ||
52 | args += ' ' + Server.config.cargoWatchOptions.checkArguments; | ||
53 | } | ||
54 | args += '"'; | ||
55 | |||
56 | // Start the cargo watch with json message | ||
57 | this.cargoProcess = child_process.spawn( | ||
58 | 'cargo', | ||
59 | ['watch', '-x', args], | ||
60 | { | ||
61 | stdio: ['ignore', 'pipe', 'pipe'], | ||
62 | cwd: vscode.workspace.rootPath, | ||
63 | windowsVerbatimArguments: true | ||
64 | } | ||
65 | ); | ||
66 | |||
67 | const stdoutData = new LineBuffer(); | ||
68 | this.cargoProcess.stdout.on('data', (s: string) => { | ||
69 | stdoutData.processOutput(s, line => { | ||
70 | this.logInfo(line); | ||
71 | this.parseLine(line); | ||
72 | }); | ||
73 | }); | ||
74 | |||
75 | const stderrData = new LineBuffer(); | ||
76 | this.cargoProcess.stderr.on('data', (s: string) => { | ||
77 | stderrData.processOutput(s, line => { | ||
78 | this.logError('Error on cargo-watch : {\n' + line + '}\n'); | ||
79 | }); | ||
80 | }); | ||
81 | |||
82 | this.cargoProcess.on('error', (err: Error) => { | ||
83 | this.logError( | ||
84 | 'Error on cargo-watch process : {\n' + err.message + '}\n' | ||
85 | ); | ||
86 | }); | ||
87 | |||
88 | this.logInfo('cargo-watch started.'); | ||
89 | } | ||
90 | |||
91 | public dispose(): void { | ||
92 | if (this.diagnosticCollection) { | ||
93 | this.diagnosticCollection.clear(); | ||
94 | this.diagnosticCollection.dispose(); | ||
95 | } | ||
96 | |||
97 | if (this.cargoProcess) { | ||
98 | this.cargoProcess.kill(); | ||
99 | terminate(this.cargoProcess); | ||
100 | } | ||
101 | |||
102 | if (this.outputChannel) { | ||
103 | this.outputChannel.dispose(); | ||
104 | } | ||
105 | } | ||
106 | |||
107 | private logInfo(line: string) { | ||
108 | if (Server.config.cargoWatchOptions.trace === 'verbose') { | ||
109 | this.outputChannel!.append(line); | ||
110 | } | ||
111 | } | ||
112 | |||
113 | private logError(line: string) { | ||
114 | if ( | ||
115 | Server.config.cargoWatchOptions.trace === 'error' || | ||
116 | Server.config.cargoWatchOptions.trace === 'verbose' | ||
117 | ) { | ||
118 | this.outputChannel!.append(line); | ||
119 | } | ||
120 | } | ||
121 | |||
122 | private parseLine(line: string) { | ||
123 | if (line.startsWith('[Running')) { | ||
124 | this.diagnosticCollection!.clear(); | ||
125 | this.statusDisplay!.show(); | ||
126 | } | ||
127 | |||
128 | if (line.startsWith('[Finished running')) { | ||
129 | this.statusDisplay!.hide(); | ||
130 | } | ||
131 | |||
132 | function getLevel(s: string): vscode.DiagnosticSeverity { | ||
133 | if (s === 'error') { | ||
134 | return vscode.DiagnosticSeverity.Error; | ||
135 | } | ||
136 | |||
137 | if (s.startsWith('warn')) { | ||
138 | return vscode.DiagnosticSeverity.Warning; | ||
139 | } | ||
140 | |||
141 | return vscode.DiagnosticSeverity.Information; | ||
142 | } | ||
143 | |||
144 | interface ErrorSpan { | ||
145 | line_start: number; | ||
146 | line_end: number; | ||
147 | column_start: number; | ||
148 | column_end: number; | ||
149 | } | ||
150 | |||
151 | interface ErrorMessage { | ||
152 | reason: string; | ||
153 | message: { | ||
154 | spans: ErrorSpan[]; | ||
155 | rendered: string; | ||
156 | level: string; | ||
157 | code?: { | ||
158 | code: string; | ||
159 | }; | ||
160 | }; | ||
161 | } | ||
162 | |||
163 | // cargo-watch itself output non json format | ||
164 | // Ignore these lines | ||
165 | let data: ErrorMessage; | ||
166 | try { | ||
167 | data = JSON.parse(line.trim()); | ||
168 | } catch (error) { | ||
169 | this.logError(`Fail to pass to json : { ${error} }`); | ||
170 | return; | ||
171 | } | ||
172 | |||
173 | // Only handle compiler-message now | ||
174 | if (data.reason !== 'compiler-message') { | ||
175 | return; | ||
176 | } | ||
177 | |||
178 | let spans: any[] = data.message.spans; | ||
179 | spans = spans.filter(o => o.is_primary); | ||
180 | |||
181 | // We only handle primary span right now. | ||
182 | if (spans.length > 0) { | ||
183 | const o = spans[0]; | ||
184 | |||
185 | const rendered = data.message.rendered; | ||
186 | const level = getLevel(data.message.level); | ||
187 | const range = new vscode.Range( | ||
188 | new vscode.Position(o.line_start - 1, o.column_start - 1), | ||
189 | new vscode.Position(o.line_end - 1, o.column_end - 1) | ||
190 | ); | ||
191 | |||
192 | const fileName = path.join(vscode.workspace.rootPath!, o.file_name); | ||
193 | const diagnostic = new vscode.Diagnostic(range, rendered, level); | ||
194 | |||
195 | diagnostic.source = 'rustc'; | ||
196 | diagnostic.code = data.message.code | ||
197 | ? data.message.code.code | ||
198 | : undefined; | ||
199 | diagnostic.relatedInformation = []; | ||
200 | |||
201 | const fileUrl = vscode.Uri.file(fileName!); | ||
202 | |||
203 | const diagnostics: vscode.Diagnostic[] = [ | ||
204 | ...(this.diagnosticCollection!.get(fileUrl) || []) | ||
205 | ]; | ||
206 | diagnostics.push(diagnostic); | ||
207 | |||
208 | this.diagnosticCollection!.set(fileUrl, diagnostics); | ||
209 | } | ||
210 | } | ||
211 | } | ||