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 | |
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]>
-rw-r--r-- | docs/user/README.md | 3 | ||||
-rw-r--r-- | editors/code/package-lock.json | 51 | ||||
-rw-r--r-- | editors/code/package.json | 38 | ||||
-rw-r--r-- | editors/code/src/commands/cargo_watch.ts | 211 | ||||
-rw-r--r-- | editors/code/src/commands/line_buffer.ts | 16 | ||||
-rw-r--r-- | editors/code/src/commands/runnables.ts | 33 | ||||
-rw-r--r-- | editors/code/src/commands/watch_status.ts | 41 | ||||
-rw-r--r-- | editors/code/src/config.ts | 34 | ||||
-rw-r--r-- | editors/code/src/extension.ts | 2 | ||||
-rw-r--r-- | editors/code/src/utils/processes.ts | 51 | ||||
-rw-r--r-- | editors/code/src/utils/terminateProcess.sh | 12 |
11 files changed, 448 insertions, 44 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 439c4e6ae..33dd4f995 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -59,7 +59,10 @@ for details. | |||
59 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable | 59 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable |
60 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo | 60 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo |
61 | watch` for live error highlighting (note, this **does not** use rust-analyzer) | 61 | watch` for live error highlighting (note, this **does not** use rust-analyzer) |
62 | * `rust-analyzer.cargo-watch.check-arguments`: cargo-watch check arguments. | ||
63 | (e.g: `--features="shumway,pdf"` will run as `cargo watch -x "check --features="shumway,pdf""` ) | ||
62 | * `rust-analyzer.trace.server`: enables internal logging | 64 | * `rust-analyzer.trace.server`: enables internal logging |
65 | * `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging | ||
63 | 66 | ||
64 | 67 | ||
65 | ## Emacs | 68 | ## Emacs |
diff --git a/editors/code/package-lock.json b/editors/code/package-lock.json index 5a0d21e78..008df6f52 100644 --- a/editors/code/package-lock.json +++ b/editors/code/package-lock.json | |||
@@ -607,6 +607,12 @@ | |||
607 | "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", | 607 | "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", |
608 | "dev": true | 608 | "dev": true |
609 | }, | 609 | }, |
610 | "es6-object-assign": { | ||
611 | "version": "1.1.0", | ||
612 | "resolved": "https://registry.npmjs.org/es6-object-assign/-/es6-object-assign-1.1.0.tgz", | ||
613 | "integrity": "sha1-wsNYJlYkfDnqEHyx5mUrb58kUjw=", | ||
614 | "dev": true | ||
615 | }, | ||
610 | "escape-string-regexp": { | 616 | "escape-string-regexp": { |
611 | "version": "1.0.5", | 617 | "version": "1.0.5", |
612 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", | 618 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", |
@@ -1121,6 +1127,12 @@ | |||
1121 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", | 1127 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", |
1122 | "dev": true | 1128 | "dev": true |
1123 | }, | 1129 | }, |
1130 | "interpret": { | ||
1131 | "version": "1.2.0", | ||
1132 | "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.2.0.tgz", | ||
1133 | "integrity": "sha512-mT34yGKMNceBQUoVn7iCDKDntA7SC6gycMAWzGx1z/CMCTV7b2AAtXlo3nRyHZ1FelRkQbQjprHSYGwzLtkVbw==", | ||
1134 | "dev": true | ||
1135 | }, | ||
1124 | "is": { | 1136 | "is": { |
1125 | "version": "3.3.0", | 1137 | "version": "3.3.0", |
1126 | "resolved": "https://registry.npmjs.org/is/-/is-3.3.0.tgz", | 1138 | "resolved": "https://registry.npmjs.org/is/-/is-3.3.0.tgz", |
@@ -1791,6 +1803,15 @@ | |||
1791 | "util-deprecate": "^1.0.1" | 1803 | "util-deprecate": "^1.0.1" |
1792 | } | 1804 | } |
1793 | }, | 1805 | }, |
1806 | "rechoir": { | ||
1807 | "version": "0.6.2", | ||
1808 | "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", | ||
1809 | "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", | ||
1810 | "dev": true, | ||
1811 | "requires": { | ||
1812 | "resolve": "^1.1.6" | ||
1813 | } | ||
1814 | }, | ||
1794 | "remove-bom-buffer": { | 1815 | "remove-bom-buffer": { |
1795 | "version": "3.0.0", | 1816 | "version": "3.0.0", |
1796 | "resolved": "https://registry.npmjs.org/remove-bom-buffer/-/remove-bom-buffer-3.0.0.tgz", | 1817 | "resolved": "https://registry.npmjs.org/remove-bom-buffer/-/remove-bom-buffer-3.0.0.tgz", |
@@ -1902,6 +1923,36 @@ | |||
1902 | "resolved": "https://registry.npmjs.org/semver/-/semver-5.6.0.tgz", | 1923 | "resolved": "https://registry.npmjs.org/semver/-/semver-5.6.0.tgz", |
1903 | "integrity": "sha512-RS9R6R35NYgQn++fkDWaOmqGoj4Ek9gGs+DPxNUZKuwE183xjJroKvyo1IzVFeXvUrvmALy6FWD5xrdJT25gMg==" | 1924 | "integrity": "sha512-RS9R6R35NYgQn++fkDWaOmqGoj4Ek9gGs+DPxNUZKuwE183xjJroKvyo1IzVFeXvUrvmALy6FWD5xrdJT25gMg==" |
1904 | }, | 1925 | }, |
1926 | "shelljs": { | ||
1927 | "version": "0.8.3", | ||
1928 | "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.3.tgz", | ||
1929 | "integrity": "sha512-fc0BKlAWiLpwZljmOvAOTE/gXawtCoNrP5oaY7KIaQbbyHeQVg01pSEuEGvGh3HEdBU4baCD7wQBwADmM/7f7A==", | ||
1930 | "dev": true, | ||
1931 | "requires": { | ||
1932 | "glob": "^7.0.0", | ||
1933 | "interpret": "^1.0.0", | ||
1934 | "rechoir": "^0.6.2" | ||
1935 | } | ||
1936 | }, | ||
1937 | "shx": { | ||
1938 | "version": "0.3.2", | ||
1939 | "resolved": "https://registry.npmjs.org/shx/-/shx-0.3.2.tgz", | ||
1940 | "integrity": "sha512-aS0mWtW3T2sHAenrSrip2XGv39O9dXIFUqxAEWHEOS1ePtGIBavdPJY1kE2IHl14V/4iCbUiNDPGdyYTtmhSoA==", | ||
1941 | "dev": true, | ||
1942 | "requires": { | ||
1943 | "es6-object-assign": "^1.0.3", | ||
1944 | "minimist": "^1.2.0", | ||
1945 | "shelljs": "^0.8.1" | ||
1946 | }, | ||
1947 | "dependencies": { | ||
1948 | "minimist": { | ||
1949 | "version": "1.2.0", | ||
1950 | "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", | ||
1951 | "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", | ||
1952 | "dev": true | ||
1953 | } | ||
1954 | } | ||
1955 | }, | ||
1905 | "source-map": { | 1956 | "source-map": { |
1906 | "version": "0.6.1", | 1957 | "version": "0.6.1", |
1907 | "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", | 1958 | "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", |
diff --git a/editors/code/package.json b/editors/code/package.json index facb633d9..1c8caaa60 100644 --- a/editors/code/package.json +++ b/editors/code/package.json | |||
@@ -18,7 +18,7 @@ | |||
18 | "scripts": { | 18 | "scripts": { |
19 | "vscode:prepublish": "npm run compile", | 19 | "vscode:prepublish": "npm run compile", |
20 | "package": "vsce package", | 20 | "package": "vsce package", |
21 | "compile": "tsc -p ./", | 21 | "compile": "tsc -p ./ && shx cp src/utils/terminateProcess.sh out/utils/terminateProcess.sh", |
22 | "watch": "tsc -watch -p ./", | 22 | "watch": "tsc -watch -p ./", |
23 | "postinstall": "node ./node_modules/vscode/bin/install", | 23 | "postinstall": "node ./node_modules/vscode/bin/install", |
24 | "fix": "prettier **/*.{json,ts} --write && tslint --project . --fix", | 24 | "fix": "prettier **/*.{json,ts} --write && tslint --project . --fix", |
@@ -41,7 +41,8 @@ | |||
41 | "tslint-config-prettier": "^1.18.0", | 41 | "tslint-config-prettier": "^1.18.0", |
42 | "typescript": "^3.3.1", | 42 | "typescript": "^3.3.1", |
43 | "vsce": "^1.57.0", | 43 | "vsce": "^1.57.0", |
44 | "vscode": "^1.1.29" | 44 | "vscode": "^1.1.29", |
45 | "shx": "^0.3.1" | ||
45 | }, | 46 | }, |
46 | "activationEvents": [ | 47 | "activationEvents": [ |
47 | "onLanguage:rust", | 48 | "onLanguage:rust", |
@@ -183,6 +184,11 @@ | |||
183 | ], | 184 | ], |
184 | "description": "Whether to run `cargo watch` on startup" | 185 | "description": "Whether to run `cargo watch` on startup" |
185 | }, | 186 | }, |
187 | "rust-analyzer.cargo-watch.check-arguments": { | ||
188 | "type": "string", | ||
189 | "description": "`cargo-watch` check arguments. (e.g: `--features=\"shumway,pdf\"` will run as `cargo watch -x \"check --features=\"shumway,pdf\"\"` )", | ||
190 | "default": "" | ||
191 | }, | ||
186 | "rust-analyzer.trace.server": { | 192 | "rust-analyzer.trace.server": { |
187 | "type": "string", | 193 | "type": "string", |
188 | "scope": "window", | 194 | "scope": "window", |
@@ -191,8 +197,24 @@ | |||
191 | "messages", | 197 | "messages", |
192 | "verbose" | 198 | "verbose" |
193 | ], | 199 | ], |
200 | "enumDescriptions": [ | ||
201 | "No traces", | ||
202 | "Error only", | ||
203 | "Full log" | ||
204 | ], | ||
194 | "default": "off", | 205 | "default": "off", |
195 | "description": "Trace requests to the ra_lsp_server" | 206 | "description": "Trace requests to the ra_lsp_server" |
207 | }, | ||
208 | "rust-analyzer.trace.cargo-watch": { | ||
209 | "type": "string", | ||
210 | "scope": "window", | ||
211 | "enum": [ | ||
212 | "off", | ||
213 | "error", | ||
214 | "verbose" | ||
215 | ], | ||
216 | "default": "off", | ||
217 | "description": "Trace output of cargo-watch" | ||
196 | } | 218 | } |
197 | } | 219 | } |
198 | }, | 220 | }, |
@@ -223,18 +245,6 @@ | |||
223 | "${workspaceRoot}" | 245 | "${workspaceRoot}" |
224 | ], | 246 | ], |
225 | "pattern": "$rustc" | 247 | "pattern": "$rustc" |
226 | }, | ||
227 | { | ||
228 | "name": "rustc-watch", | ||
229 | "fileLocation": [ | ||
230 | "relative", | ||
231 | "${workspaceRoot}" | ||
232 | ], | ||
233 | "background": { | ||
234 | "beginsPattern": "^\\[Running\\b", | ||
235 | "endsPattern": "^\\[Finished running\\b" | ||
236 | }, | ||
237 | "pattern": "$rustc" | ||
238 | } | 248 | } |
239 | ] | 249 | ] |
240 | } | 250 | } |
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 | } | ||
diff --git a/editors/code/src/commands/line_buffer.ts b/editors/code/src/commands/line_buffer.ts new file mode 100644 index 000000000..fb5b9f7f2 --- /dev/null +++ b/editors/code/src/commands/line_buffer.ts | |||
@@ -0,0 +1,16 @@ | |||
1 | export class LineBuffer { | ||
2 | private outBuffer: string = ''; | ||
3 | |||
4 | public processOutput(chunk: string, cb: (line: string) => void) { | ||
5 | this.outBuffer += chunk; | ||
6 | let eolIndex = this.outBuffer.indexOf('\n'); | ||
7 | while (eolIndex >= 0) { | ||
8 | // line includes the EOL | ||
9 | const line = this.outBuffer.slice(0, eolIndex + 1); | ||
10 | cb(line); | ||
11 | this.outBuffer = this.outBuffer.slice(eolIndex + 1); | ||
12 | |||
13 | eolIndex = this.outBuffer.indexOf('\n'); | ||
14 | } | ||
15 | } | ||
16 | } | ||
diff --git a/editors/code/src/commands/runnables.ts b/editors/code/src/commands/runnables.ts index 4187ef4d1..3589edcee 100644 --- a/editors/code/src/commands/runnables.ts +++ b/editors/code/src/commands/runnables.ts | |||
@@ -1,9 +1,11 @@ | |||
1 | import * as child_process from 'child_process'; | 1 | import * as child_process from 'child_process'; |
2 | |||
2 | import * as util from 'util'; | 3 | import * as util from 'util'; |
3 | import * as vscode from 'vscode'; | 4 | import * as vscode from 'vscode'; |
4 | import * as lc from 'vscode-languageclient'; | 5 | import * as lc from 'vscode-languageclient'; |
5 | 6 | ||
6 | import { Server } from '../server'; | 7 | import { Server } from '../server'; |
8 | import { CargoWatchProvider } from './cargo_watch'; | ||
7 | 9 | ||
8 | interface RunnablesParams { | 10 | interface RunnablesParams { |
9 | textDocument: lc.TextDocumentIdentifier; | 11 | textDocument: lc.TextDocumentIdentifier; |
@@ -127,37 +129,19 @@ export async function handleSingle(runnable: Runnable) { | |||
127 | return vscode.tasks.executeTask(task); | 129 | return vscode.tasks.executeTask(task); |
128 | } | 130 | } |
129 | 131 | ||
130 | export const autoCargoWatchTask: vscode.Task = { | ||
131 | name: 'cargo watch', | ||
132 | source: 'rust-analyzer', | ||
133 | definition: { | ||
134 | type: 'watch' | ||
135 | }, | ||
136 | execution: new vscode.ShellExecution('cargo', ['watch'], { cwd: '.' }), | ||
137 | |||
138 | isBackground: true, | ||
139 | problemMatchers: ['$rustc-watch'], | ||
140 | presentationOptions: { | ||
141 | clear: true | ||
142 | }, | ||
143 | // Not yet exposed in the vscode.d.ts | ||
144 | // https://github.com/Microsoft/vscode/blob/ea7c31d770e04b51d586b0d3944f3a7feb03afb9/src/vs/workbench/contrib/tasks/common/tasks.ts#L444-L456 | ||
145 | runOptions: ({ | ||
146 | runOn: 2 // RunOnOptions.folderOpen | ||
147 | } as unknown) as vscode.RunOptions | ||
148 | }; | ||
149 | |||
150 | /** | 132 | /** |
151 | * Interactively asks the user whether we should run `cargo check` in order to | 133 | * Interactively asks the user whether we should run `cargo check` in order to |
152 | * provide inline diagnostics; the user is met with a series of dialog boxes | 134 | * provide inline diagnostics; the user is met with a series of dialog boxes |
153 | * that, when accepted, allow us to `cargo install cargo-watch` and then run it. | 135 | * that, when accepted, allow us to `cargo install cargo-watch` and then run it. |
154 | */ | 136 | */ |
155 | export async function interactivelyStartCargoWatch() { | 137 | export async function interactivelyStartCargoWatch( |
156 | if (Server.config.enableCargoWatchOnStartup === 'disabled') { | 138 | context: vscode.ExtensionContext |
139 | ) { | ||
140 | if (Server.config.cargoWatchOptions.enableOnStartup === 'disabled') { | ||
157 | return; | 141 | return; |
158 | } | 142 | } |
159 | 143 | ||
160 | if (Server.config.enableCargoWatchOnStartup === 'ask') { | 144 | if (Server.config.cargoWatchOptions.enableOnStartup === 'ask') { |
161 | const watch = await vscode.window.showInformationMessage( | 145 | const watch = await vscode.window.showInformationMessage( |
162 | 'Start watching changes with cargo? (Executes `cargo watch`, provides inline diagnostics)', | 146 | 'Start watching changes with cargo? (Executes `cargo watch`, provides inline diagnostics)', |
163 | 'yes', | 147 | 'yes', |
@@ -212,5 +196,6 @@ export async function interactivelyStartCargoWatch() { | |||
212 | } | 196 | } |
213 | } | 197 | } |
214 | 198 | ||
215 | vscode.tasks.executeTask(autoCargoWatchTask); | 199 | const validater = new CargoWatchProvider(); |
200 | validater.activate(context.subscriptions); | ||
216 | } | 201 | } |
diff --git a/editors/code/src/commands/watch_status.ts b/editors/code/src/commands/watch_status.ts new file mode 100644 index 000000000..f027d7bbc --- /dev/null +++ b/editors/code/src/commands/watch_status.ts | |||
@@ -0,0 +1,41 @@ | |||
1 | import * as vscode from 'vscode'; | ||
2 | |||
3 | const spinnerFrames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']; | ||
4 | |||
5 | export class StatusDisplay { | ||
6 | private i = 0; | ||
7 | private statusBarItem: vscode.StatusBarItem; | ||
8 | private timer?: NodeJS.Timeout; | ||
9 | |||
10 | constructor(subscriptions: vscode.Disposable[]) { | ||
11 | this.statusBarItem = vscode.window.createStatusBarItem( | ||
12 | vscode.StatusBarAlignment.Left, | ||
13 | 10 | ||
14 | ); | ||
15 | subscriptions.push(this.statusBarItem); | ||
16 | this.statusBarItem.hide(); | ||
17 | } | ||
18 | |||
19 | public show() { | ||
20 | this.timer = | ||
21 | this.timer || | ||
22 | setInterval(() => { | ||
23 | this.statusBarItem!.text = 'cargo check ' + this.frame(); | ||
24 | }, 300); | ||
25 | |||
26 | this.statusBarItem!.show(); | ||
27 | } | ||
28 | |||
29 | public hide() { | ||
30 | if (this.timer) { | ||
31 | clearInterval(this.timer); | ||
32 | this.timer = undefined; | ||
33 | } | ||
34 | |||
35 | this.statusBarItem!.hide(); | ||
36 | } | ||
37 | |||
38 | private frame() { | ||
39 | return spinnerFrames[(this.i = ++this.i % spinnerFrames.length)]; | ||
40 | } | ||
41 | } | ||
diff --git a/editors/code/src/config.ts b/editors/code/src/config.ts index 420589068..481a5e5f1 100644 --- a/editors/code/src/config.ts +++ b/editors/code/src/config.ts | |||
@@ -4,14 +4,25 @@ import { Server } from './server'; | |||
4 | 4 | ||
5 | const RA_LSP_DEBUG = process.env.__RA_LSP_SERVER_DEBUG; | 5 | const RA_LSP_DEBUG = process.env.__RA_LSP_SERVER_DEBUG; |
6 | 6 | ||
7 | export type CargoWatchOptions = 'ask' | 'enabled' | 'disabled'; | 7 | export type CargoWatchStartupOptions = 'ask' | 'enabled' | 'disabled'; |
8 | export type CargoWatchTraceOptions = 'off' | 'error' | 'verbose'; | ||
9 | |||
10 | export interface CargoWatchOptions { | ||
11 | enableOnStartup: CargoWatchStartupOptions; | ||
12 | checkArguments: string; | ||
13 | trace: CargoWatchTraceOptions; | ||
14 | } | ||
8 | 15 | ||
9 | export class Config { | 16 | export class Config { |
10 | public highlightingOn = true; | 17 | public highlightingOn = true; |
11 | public enableEnhancedTyping = true; | 18 | public enableEnhancedTyping = true; |
12 | public raLspServerPath = RA_LSP_DEBUG || 'ra_lsp_server'; | 19 | public raLspServerPath = RA_LSP_DEBUG || 'ra_lsp_server'; |
13 | public showWorkspaceLoadedNotification = true; | 20 | public showWorkspaceLoadedNotification = true; |
14 | public enableCargoWatchOnStartup: CargoWatchOptions = 'ask'; | 21 | public cargoWatchOptions: CargoWatchOptions = { |
22 | enableOnStartup: 'ask', | ||
23 | trace: 'off', | ||
24 | checkArguments: '' | ||
25 | }; | ||
15 | 26 | ||
16 | private prevEnhancedTyping: null | boolean = null; | 27 | private prevEnhancedTyping: null | boolean = null; |
17 | 28 | ||
@@ -73,9 +84,22 @@ export class Config { | |||
73 | } | 84 | } |
74 | 85 | ||
75 | if (config.has('enableCargoWatchOnStartup')) { | 86 | if (config.has('enableCargoWatchOnStartup')) { |
76 | this.enableCargoWatchOnStartup = config.get<CargoWatchOptions>( | 87 | this.cargoWatchOptions.enableOnStartup = config.get< |
77 | 'enableCargoWatchOnStartup', | 88 | CargoWatchStartupOptions |
78 | 'ask' | 89 | >('enableCargoWatchOnStartup', 'ask'); |
90 | } | ||
91 | |||
92 | if (config.has('trace.cargo-watch')) { | ||
93 | this.cargoWatchOptions.trace = config.get<CargoWatchTraceOptions>( | ||
94 | 'trace.cargo-watch', | ||
95 | 'off' | ||
96 | ); | ||
97 | } | ||
98 | |||
99 | if (config.has('cargo-watch.check-arguments')) { | ||
100 | this.cargoWatchOptions.checkArguments = config.get<string>( | ||
101 | 'cargo-watch.check-arguments', | ||
102 | '' | ||
79 | ); | 103 | ); |
80 | } | 104 | } |
81 | } | 105 | } |
diff --git a/editors/code/src/extension.ts b/editors/code/src/extension.ts index 2e13c87de..ef83c0b8b 100644 --- a/editors/code/src/extension.ts +++ b/editors/code/src/extension.ts | |||
@@ -121,7 +121,7 @@ export function activate(context: vscode.ExtensionContext) { | |||
121 | ); | 121 | ); |
122 | 122 | ||
123 | // Executing `cargo watch` provides us with inline diagnostics on save | 123 | // Executing `cargo watch` provides us with inline diagnostics on save |
124 | interactivelyStartCargoWatch(); | 124 | interactivelyStartCargoWatch(context); |
125 | 125 | ||
126 | // Start the language server, finally! | 126 | // Start the language server, finally! |
127 | Server.start(allNotifications); | 127 | Server.start(allNotifications); |
diff --git a/editors/code/src/utils/processes.ts b/editors/code/src/utils/processes.ts new file mode 100644 index 000000000..da8be9eb1 --- /dev/null +++ b/editors/code/src/utils/processes.ts | |||
@@ -0,0 +1,51 @@ | |||
1 | 'use strict'; | ||
2 | |||
3 | import * as cp from 'child_process'; | ||
4 | import ChildProcess = cp.ChildProcess; | ||
5 | |||
6 | import { join } from 'path'; | ||
7 | |||
8 | const isWindows = process.platform === 'win32'; | ||
9 | const isMacintosh = process.platform === 'darwin'; | ||
10 | const isLinux = process.platform === 'linux'; | ||
11 | |||
12 | // this is very complex, but is basically copy-pased from VSCode implementation here: | ||
13 | // https://github.com/Microsoft/vscode-languageserver-node/blob/dbfd37e35953ad0ee14c4eeced8cfbc41697b47e/client/src/utils/processes.ts#L15 | ||
14 | |||
15 | // And see discussion at | ||
16 | // https://github.com/rust-analyzer/rust-analyzer/pull/1079#issuecomment-478908109 | ||
17 | |||
18 | export function terminate(process: ChildProcess, cwd?: string): boolean { | ||
19 | if (isWindows) { | ||
20 | try { | ||
21 | // This we run in Atom execFileSync is available. | ||
22 | // Ignore stderr since this is otherwise piped to parent.stderr | ||
23 | // which might be already closed. | ||
24 | const options: any = { | ||
25 | stdio: ['pipe', 'pipe', 'ignore'] | ||
26 | }; | ||
27 | if (cwd) { | ||
28 | options.cwd = cwd; | ||
29 | } | ||
30 | cp.execFileSync( | ||
31 | 'taskkill', | ||
32 | ['/T', '/F', '/PID', process.pid.toString()], | ||
33 | options | ||
34 | ); | ||
35 | return true; | ||
36 | } catch (err) { | ||
37 | return false; | ||
38 | } | ||
39 | } else if (isLinux || isMacintosh) { | ||
40 | try { | ||
41 | const cmd = join(__dirname, 'terminateProcess.sh'); | ||
42 | const result = cp.spawnSync(cmd, [process.pid.toString()]); | ||
43 | return result.error ? false : true; | ||
44 | } catch (err) { | ||
45 | return false; | ||
46 | } | ||
47 | } else { | ||
48 | process.kill('SIGKILL'); | ||
49 | return true; | ||
50 | } | ||
51 | } | ||
diff --git a/editors/code/src/utils/terminateProcess.sh b/editors/code/src/utils/terminateProcess.sh new file mode 100644 index 000000000..2ec9e1c2e --- /dev/null +++ b/editors/code/src/utils/terminateProcess.sh | |||
@@ -0,0 +1,12 @@ | |||
1 | #!/bin/bash | ||
2 | |||
3 | terminateTree() { | ||
4 | for cpid in $(pgrep -P $1); do | ||
5 | terminateTree $cpid | ||
6 | done | ||
7 | kill -9 $1 > /dev/null 2>&1 | ||
8 | } | ||
9 | |||
10 | for pid in $*; do | ||
11 | terminateTree $pid | ||
12 | done \ No newline at end of file | ||