OLD | NEW |
1 <html><head> | 1 <html><head> |
2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
3 <title>Analysis Server API Specification</title> | 3 <title>Analysis Server API Specification</title> |
4 <style>body { | 4 <style>body { |
5 font-family: sans-serif, serif; | 5 font-family: sans-serif, serif; |
6 padding-left: 5%; | 6 padding-left: 5%; |
7 padding-right: 5%; | 7 padding-right: 5%; |
8 } | 8 } |
9 h1 { | 9 h1 { |
10 text-align: center; | 10 text-align: center; |
(...skipping 433 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
444 existing analysis roots. This will cause all previously | 444 existing analysis roots. This will cause all previously |
445 computed analysis results to be discarded and recomputed, | 445 computed analysis results to be discarded and recomputed, |
446 and will cause all subscribed notifications to be re-sent. | 446 and will cause all subscribed notifications to be re-sent. |
447 </p> | 447 </p> |
448 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box
"><pre>request: { | 448 </dd><dt class="request">analysis.setAnalysisRoots</dt><dd><div class="box
"><pre>request: { |
449 "id": String | 449 "id": String |
450 "method": "analysis.setAnalysisRoots" | 450 "method": "analysis.setAnalysisRoots" |
451 "params": { | 451 "params": { |
452 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> | 452 "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>> |
453 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> | 453 "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>> |
| 454 "<b>packageRoots</b>": <span style="color:#999999">optional</span> Map<<a
href="#type_FilePath">FilePath</a>, <a href="#type_FilePath">FilePath</a>> |
454 } | 455 } |
455 }</pre><br><pre>response: { | 456 }</pre><br><pre>response: { |
456 "id": String | 457 "id": String |
457 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 458 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
458 }</pre></div> | 459 }</pre></div> |
459 <p> | 460 <p> |
460 Sets the root paths used to determine which files to | 461 Sets the root paths used to determine which files to |
461 analyze. The set of files to be analyzed are all of the | 462 analyze. The set of files to be analyzed are all of the |
462 files in one of the root paths that are not also in one of | 463 files in one of the root paths that are not also in one of |
463 the excluded paths. | 464 the excluded paths. |
(...skipping 27 matching lines...) Expand all Loading... |
491 <p> | 492 <p> |
492 A list of the files and directories that should be | 493 A list of the files and directories that should be |
493 analyzed. | 494 analyzed. |
494 </p> | 495 </p> |
495 </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePat
h">FilePath</a>> )</i></b></dt><dd> | 496 </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePat
h">FilePath</a>> )</i></b></dt><dd> |
496 | 497 |
497 <p> | 498 <p> |
498 A list of the files and directories within the | 499 A list of the files and directories within the |
499 included directories that should not be analyzed. | 500 included directories that should not be analyzed. |
500 </p> | 501 </p> |
| 502 </dd><dt class="field"><b><i>packageRoots ( <span style="color:#999999
">optional</span> Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_F
ilePath">FilePath</a>> )</i></b></dt><dd> |
| 503 |
| 504 <p> |
| 505 A mapping from source directories to target directories |
| 506 that should override the normal package: URI resolution |
| 507 mechanism. The analyzer will behave as though each |
| 508 source directory in the map contains a special |
| 509 pubspec.yaml file which resolves any package: URI to the |
| 510 corresponding path within the target directory. The |
| 511 effect is the same as specifying the target directory as |
| 512 a "--package_root" parameter to the Dart VM when |
| 513 executing any Dart file inside the source directory. |
| 514 </p> |
| 515 <p> |
| 516 If this field is absent, or the empty map is specified, |
| 517 then all package: URI's are resolved the normal |
| 518 pubspec.yaml mechanism. |
| 519 </p> |
501 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd><
div class="box"><pre>request: { | 520 </dd></dl></dd><dt class="request">analysis.setPriorityFiles</dt><dd><
div class="box"><pre>request: { |
502 "id": String | 521 "id": String |
503 "method": "analysis.setPriorityFiles" | 522 "method": "analysis.setPriorityFiles" |
504 "params": { | 523 "params": { |
505 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> | 524 "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>> |
506 } | 525 } |
507 }</pre><br><pre>response: { | 526 }</pre><br><pre>response: { |
508 "id": String | 527 "id": String |
509 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> | 528 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr
or">RequestError</a> |
510 }</pre></div> | 529 }</pre></div> |
(...skipping 2773 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3284 <p> | 3303 <p> |
3285 This section contains a list of all of the errors that are | 3304 This section contains a list of all of the errors that are |
3286 produced by the server and the data that is returned with each. | 3305 produced by the server and the data that is returned with each. |
3287 </p> | 3306 </p> |
3288 <p> | 3307 <p> |
3289 TBD | 3308 TBD |
3290 </p> | 3309 </p> |
3291 | 3310 |
3292 | 3311 |
3293 </body></html> | 3312 </body></html> |
OLD | NEW |