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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2885993004: Pass the sdk path to plugins (Closed)
Patch Set: Created 3 years, 7 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 127 matching lines...) Expand 10 before | Expand all | Expand 10 after
138 problems related to the execution of plugins. 138 problems related to the execution of plugins.
139 </p> 139 </p>
140 140
141 141
142 142
143 <h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">p lugin.versionCheck</a> (<a href="#request_plugin.versionCheck">#</a>)</dt><dd><d iv class="box"><pre>request: { 143 <h3>Requests</h3><dl><dt class="request"><a name="request_plugin.versionCheck">p lugin.versionCheck</a> (<a href="#request_plugin.versionCheck">#</a>)</dt><dd><d iv class="box"><pre>request: {
144 "id": String 144 "id": String
145 "method": "plugin.versionCheck" 145 "method": "plugin.versionCheck"
146 "params": { 146 "params": {
147 "<b>byteStorePath</b>": String 147 "<b>byteStorePath</b>": String
148 "<b>sdkPath</b>": String
148 "<b>version</b>": String 149 "<b>version</b>": String
149 } 150 }
150 }</pre><br><pre>response: { 151 }</pre><br><pre>response: {
151 "id": String 152 "id": String
152 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 153 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
153 "result": { 154 "result": {
154 "<b>isCompatible</b>": bool 155 "<b>isCompatible</b>": bool
155 "<b>name</b>": String 156 "<b>name</b>": String
156 "<b>version</b>": String 157 "<b>version</b>": String
157 "<b>contactInfo</b>": <span style="color:#999999">optional</span> String 158 "<b>contactInfo</b>": <span style="color:#999999">optional</span> String
158 "<b>interestingFiles</b>": List&lt;String&gt; 159 "<b>interestingFiles</b>": List&lt;String&gt;
159 } 160 }
160 }</pre></div> 161 }</pre></div>
161 <p> 162 <p>
162 Used to request that the plugin perform a version check to confirm that it 163 Used to request that the plugin perform a version check to confirm that it
163 works with the version of the analysis server that is executing it. 164 works with the version of the analysis server that is executing it.
164 </p> 165 </p>
165 166
166 167
167 <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath (String)</b></dt><d d> 168 <h4>parameters:</h4><dl><dt class="field"><b>byteStorePath (String)</b></dt><d d>
168 169
169 <p> 170 <p>
170 The path to the directory containing the on-disk byte store that is to 171 The path to the directory containing the on-disk byte store that is to
171 be used by any analysis drivers that are created. 172 be used by any analysis drivers that are created.
172 </p> 173 </p>
174 </dd><dt class="field"><b>sdkPath (String)</b></dt><dd>
175
176 <p>
177 The path to the directory containing the SDK that is to be used by any
178 analysis drivers that are created.
179 </p>
173 </dd><dt class="field"><b>version (String)</b></dt><dd> 180 </dd><dt class="field"><b>version (String)</b></dt><dd>
174 181
175 <p> 182 <p>
176 The version number of the plugin spec supported by the analysis server 183 The version number of the plugin spec supported by the analysis server
177 that is executing the plugin. 184 that is executing the plugin.
178 </p> 185 </p>
179 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>isCompatible (bool)</b ></dt><dd> 186 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>isCompatible (bool)</b ></dt><dd>
180 187
181 <p> 188 <p>
182 A flag indicating whether the plugin supports the same version of the 189 A flag indicating whether the plugin supports the same version of the
(...skipping 2302 matching lines...) Expand 10 before | Expand all | Expand 10 after
2485 2492
2486 <p> 2493 <p>
2487 The name that the element should have after the refactoring. 2494 The name that the element should have after the refactoring.
2488 </p> 2495 </p>
2489 </dd></dl></dd></dl> 2496 </dd></dl></dd></dl>
2490 <h2 class="domain"><a name="index">Index</a></h2> 2497 <h2 class="domain"><a name="index">Index</a></h2>
2491 <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.ha ndleWatchEvents">handleWatchEvents</a></li><li><a href="#request_analysis.reanal yze">reanalyze</a></li><li><a href="#request_analysis.setContextBuilderOptions"> setContextBuilderOptions</a></li><li><a href="#request_analysis.setContextRoots" >setContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPri orityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscript ions</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li ></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification _analysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fo lding</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="#notificat ion_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_completion.getSuggestions">getSuggestions</a></li></ul></div><h4 >edit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5> <ul><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#requ est_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href= "#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactor ing">getRefactoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><d iv class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay< /a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#ty pe_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErr orSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType"> AnalysisErrorType</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="# type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#ty pe_ContextBuilderOptions">ContextBuilderOptions</a></li><li><a href="#type_Conte xtRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a></li><li><a h ref="#type_ElementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePat h</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type _FoldingRegion">FoldingRegion</a></li><li><a href="#type_HighlightRegion">Highli ghtRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a ></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="# type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_Linke dEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Locatio n">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></l i><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#ty pe_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li> <li><a href="#type_Position">Position</a></li><li><a href="#type_PrioritizedSour ceChange">PrioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback ">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKin d</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParame ter</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethod ParameterKind</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions< /a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li> <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="# type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Req uestErrorCode</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li> <a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit" >SourceFileEdit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refa ctoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href=" #refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a h ref="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactor ing_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactori ng_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOV E_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div> 2498 <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.ha ndleWatchEvents">handleWatchEvents</a></li><li><a href="#request_analysis.reanal yze">reanalyze</a></li><li><a href="#request_analysis.setContextBuilderOptions"> setContextBuilderOptions</a></li><li><a href="#request_analysis.setContextRoots" >setContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPri orityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscript ions</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li ></ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification _analysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fo lding</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="#notificat ion_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_completion.getSuggestions">getSuggestions</a></li></ul></div><h4 >edit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5> <ul><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#requ est_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href= "#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactor ing">getRefactoring</a></li></ul></div><h3>Types (<a href="#types">↑</a>)</h3><d iv class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay< /a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#ty pe_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErr orSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType"> AnalysisErrorType</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="# type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a href="#ty pe_ContextBuilderOptions">ContextBuilderOptions</a></li><li><a href="#type_Conte xtRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a></li><li><a h ref="#type_ElementKind">ElementKind</a></li><li><a href="#type_FilePath">FilePat h</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a href="#type _FoldingRegion">FoldingRegion</a></li><li><a href="#type_HighlightRegion">Highli ghtRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType</a ></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li><li><a href="# type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a href="#type_Linke dEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href="#type_Locatio n">Location</a></li><li><a href="#type_NavigationRegion">NavigationRegion</a></l i><li><a href="#type_NavigationTarget">NavigationTarget</a></li><li><a href="#ty pe_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Outline</a></li> <li><a href="#type_Position">Position</a></li><li><a href="#type_PrioritizedSour ceChange">PrioritizedSourceChange</a></li><li><a href="#type_RefactoringFeedback ">RefactoringFeedback</a></li><li><a href="#type_RefactoringKind">RefactoringKin d</a></li><li><a href="#type_RefactoringMethodParameter">RefactoringMethodParame ter</a></li><li><a href="#type_RefactoringMethodParameterKind">RefactoringMethod ParameterKind</a></li><li><a href="#type_RefactoringOptions">RefactoringOptions< /a></li><li><a href="#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">RefactoringProblemSeverity</a></li><li> <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a></li><li><a href="# type_RequestError">RequestError</a></li><li><a href="#type_RequestErrorCode">Req uestErrorCode</a></li><li><a href="#type_SourceChange">SourceChange</a></li><li> <a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit" >SourceFileEdit</a></li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type_WatchEventType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refa ctoring_CONVERT_GETTER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href=" #refactoring_CONVERT_METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a h ref="#refactoring_EXTRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactor ing_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactori ng_INLINE_METHOD">INLINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOV E_FILE</a></li><li><a href="#refactoring_RENAME">RENAME</a></li></ul></div>
2492 2499
2493 2500
2494 </body></html> 2501 </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