Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(318)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analyzer_plugin/doc/api.html

Issue 2988743002: Remove the analysus.reanalyze request from the plugin API (Closed)
Patch Set: Restart plugins Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « pkg/analysis_server/test/src/plugin/plugin_manager_test.dart ('k') | pkg/analyzer_plugin/lib/plugin/plugin.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><html><head> 1 <!DOCTYPE html><html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server Plugin API Specification</title> 3 <title>Analysis Server Plugin API Specification</title>
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {
5 font-family: 'Roboto', sans-serif; 5 font-family: 'Roboto', sans-serif;
6 max-width: 800px; 6 max-width: 800px;
7 margin: 0 auto; 7 margin: 0 auto;
8 padding: 0 16px; 8 padding: 0 16px;
9 font-size: 16px; 9 font-size: 16px;
10 line-height: 1.5; 10 line-height: 1.5;
(...skipping 260 matching lines...) Expand 10 before | Expand all | Expand 10 after
271 271
272 272
273 273
274 274
275 275
276 276
277 277
278 278
279 279
280 280
281
282 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation ">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: { 281 <h3>Requests</h3><dl><dt class="request"><a name="request_analysis.getNavigation ">analysis.getNavigation</a></dt><dd><div class="box"><pre>request: {
283 "id": String 282 "id": String
284 "method": "analysis.getNavigation" 283 "method": "analysis.getNavigation"
285 "params": { 284 "params": {
286 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 285 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
287 "<b>offset</b>": int 286 "<b>offset</b>": int
288 "<b>length</b>": int 287 "<b>length</b>": int
289 } 288 }
290 }</pre><br><pre>response: { 289 }</pre><br><pre>response: {
291 "id": String 290 "id": String
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after
365 Used to inform the plugin of changes to files in the file system. Only 364 Used to inform the plugin of changes to files in the file system. Only
366 events associated with files that match the <tt>interestingFiles</tt> glob 365 events associated with files that match the <tt>interestingFiles</tt> glob
367 patterns will be forwarded to the plugin. 366 patterns will be forwarded to the plugin.
368 </p> 367 </p>
369 368
370 <h4>parameters:</h4><dl><dt class="field"><b>events: List&lt;<a href="#type_Wa tchEvent">WatchEvent</a>&gt;</b></dt><dd> 369 <h4>parameters:</h4><dl><dt class="field"><b>events: List&lt;<a href="#type_Wa tchEvent">WatchEvent</a>&gt;</b></dt><dd>
371 370
372 <p> 371 <p>
373 The watch events that the plugin should handle. 372 The watch events that the plugin should handle.
374 </p> 373 </p>
375 </dd></dl></dd><dt class="request"><a name="request_analysis.reanalyze">an alysis.reanalyze</a></dt><dd><div class="box"><pre>request: {
376 "id": String
377 "method": "analysis.reanalyze"
378 "params": {
379 "<b>roots</b>": <span style="color:#999999">optional</span> List&lt;<a href= "#type_FilePath">FilePath</a>&gt;
380 }
381 }</pre><br><pre>response: {
382 "id": String
383 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
384 }</pre></div>
385 <p>
386 Used to force the re-analysis of everything contained in the specified
387 context roots. This should cause all previously computed analysis results
388 to be discarded and recomputed, and should cause all subscribed
389 notifications to be re-sent.
390 </p>
391
392 <h4>parameters:</h4><dl><dt class="field"><b>roots: List&lt;<a href="#type_Fil ePath">FilePath</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><d d>
393
394 <p>
395 A list of the context roots that are to be re-analyzed.
396 </p>
397 <p>
398 If no context roots are provided, then all current context roots
399 should be re-analyzed.
400 </p>
401 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoo ts">analysis.setContextRoots</a></dt><dd><div class="box"><pre>request: { 374 </dd></dl></dd><dt class="request"><a name="request_analysis.setContextRoo ts">analysis.setContextRoots</a></dt><dd><div class="box"><pre>request: {
402 "id": String 375 "id": String
403 "method": "analysis.setContextRoots" 376 "method": "analysis.setContextRoots"
404 "params": { 377 "params": {
405 "<b>roots</b>": List&lt;<a href="#type_ContextRoot">ContextRoot</a>&gt; 378 "<b>roots</b>": List&lt;<a href="#type_ContextRoot">ContextRoot</a>&gt;
406 } 379 }
407 }</pre><br><pre>response: { 380 }</pre><br><pre>response: {
408 "id": String 381 "id": String
409 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 382 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
410 }</pre></div> 383 }</pre></div>
(...skipping 2088 matching lines...) Expand 10 before | Expand all | Expand 10 after
2499 <p> 2472 <p>
2500 The old name of the element before the refactoring. 2473 The old name of the element before the refactoring.
2501 </p> 2474 </p>
2502 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b></d t><dd> 2475 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b></d t><dd>
2503 2476
2504 <p> 2477 <p>
2505 The name that the element should have after the refactoring. 2478 The name that the element should have after the refactoring.
2506 </p> 2479 </p>
2507 </dd></dl></dd></dl> 2480 </dd></dl></dd></dl>
2508 <h2 class="domain"><a name="index">Index</a></h2> 2481 <h2 class="domain"><a name="index">Index</a></h2>
2509 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setContextRoots">setContextRoots</a></ li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</a></li><li ><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li><li><a hr ef="#request_analysis.updateContent">updateContent</a></li></ul><h5>Notification s</h5><div class="subindex"><ul><li><a href="#notification_analysis.errors">erro rs</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a h ref="#notification_analysis.highlights">highlights</a></li><li><a href="#notific ation_analysis.navigation">navigation</a></li><li><a href="#notification_analysi s.occurrences">occurrences</a></li><li><a href="#notification_analysis.outline"> outline</a></li></ul></div></div><h4>completion (<a href="#domain_completion">↑< /a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_comple tion.getSuggestions">getSuggestions</a></li></ul></div><h4>edit (<a href="#domai n_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ est_edit.getAssists">getAssists</a></li><li><a href="#request_edit.getAvailableR efactorings">getAvailableRefactorings</a></li><li><a href="#request_edit.getFixe s">getFixes</a></li><li><a href="#request_edit.getRefactoring">getRefactoring</a ></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="subindex"><u l><li><a href="#type_AddContentOverlay">AddContentOverlay</a></li><li><a href="# type_AnalysisError">AnalysisError</a></li><li><a href="#type_AnalysisErrorFixes" >AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSeverity">AnalysisEr rorSeverity</a></li><li><a href="#type_AnalysisErrorType">AnalysisErrorType</a>< /li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#ty pe_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#type_Complet ionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSuggest ionKind">CompletionSuggestionKind</a></li><li><a href="#type_ContextRoot">Contex tRoot</a></li><li><a href="#type_Element">Element</a></li><li><a href="#type_Ele mentKind">ElementKind</a></li><li><a href="#type_FilePath">FilePath</a></li><li> <a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegion ">FoldingRegion</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a>< /li><li><a href="#type_HighlightRegionType">HighlightRegionType</a></li><li><a h ref="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="#type_LinkedEdi tSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_LinkedEditSuggestio nKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Location">Location</a ></li><li><a href="#type_NavigationRegion">NavigationRegion</a></li><li><a href= "#type_NavigationTarget">NavigationTarget</a></li><li><a href="#type_Occurrences ">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li><li><a href="# type_Position">Position</a></li><li><a href="#type_PrioritizedSourceChange">Prio ritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback">RefactoringF eedback</a></li><li><a href="#type_RefactoringKind">RefactoringKind</a></li><li> <a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a></li><l i><a href="#type_RefactoringMethodParameterKind">RefactoringMethodParameterKind< /a></li><li><a href="#type_RefactoringOptions">RefactoringOptions</a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_R efactoringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type _RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestEr ror">RequestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode< /a></li><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type _SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileEdi t</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type_W atchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#ref actorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVER T_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_C ONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactor ing_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refacto ring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOC AL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METH OD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li ><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> 2482 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.setContextRoots">s etContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPrior ityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptio ns</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li>< /ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_a nalysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fold ing</a></li><li><a href="#notification_analysis.highlights">highlights</a></li>< li><a href="#notification_analysis.navigation">navigation</a></li><li><a href="# notification_analysis.occurrences">occurrences</a></li><li><a href="#notificatio n_analysis.outline">outline</a></li></ul></div></div><h4>completion (<a href="#d omain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h ref="#request_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>e dit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><u l><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reques t_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="# request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactorin g">getRefactoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a ></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type _AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisError Severity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">An alysisErrorType</a></li><li><a href="#type_AnalysisService">AnalysisService</a>< /li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#ty pe_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#type _ContextRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a></li><l i><a href="#type_ElementKind">ElementKind</a></li><li><a href="#type_FilePath">F ilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href= "#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_HighlightRegion"> HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionT ype</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a h ref="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type _LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_L ocation">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion< /a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a hre f="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a ></li><li><a href="#type_Position">Position</a></li><li><a href="#type_Prioritiz edSourceChange">PrioritizedSourceChange</a></li><li><a href="#type_RefactoringFe edback">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">Refactor ingKind</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethod Parameter</a></li><li><a href="#type_RefactoringMethodParameterKind">Refactoring MethodParameterKind</a></li><li><a href="#type_RefactoringOptions">RefactoringOp tions</a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li> <li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></l i><li><a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a h ref="#type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCod e">RequestErrorCode</a></li><li><a href="#type_SourceChange">SourceChange</a></l i><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFil eEdit">SourceFileEdit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li> <li><a href="#type_WatchEventType">WatchEventType</a></li></ul></div><h3>Refacto rings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href= "#refactoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><l i><a href="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li>< li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#re factoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#ref actoring_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FIL E">MOVE_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div >
2510 2483
2511 2484
2512 </body></html> 2485 </body></html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/test/src/plugin/plugin_manager_test.dart ('k') | pkg/analyzer_plugin/lib/plugin/plugin.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698