pkg/analysis_server/doc/api.html - Issue 1258563008: Proposal for the 'edit.organizeDirectives' request.

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

Issue 1258563008: Proposal for the 'edit.organizeDirectives' request. (Closed) Base URL: git@github.com:dart-lang/sdk.git@master

Patch Set: Created 5 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

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 1557 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1568 <p>	1568 <p>

1569 The edit domain contains commands related to edits that can be	1569 The edit domain contains commands related to edits that can be

1570 applied to the code.	1570 applied to the code.

1571 </p>	1571 </p>

1572	1572

1573	1573

1574	1574

1575	1575

1576	1576

1577	1577

	1578

1578 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit. format</a> (<a href="#request_edit.format">#</a>)</dt><dd><div class="box"><pre> request: {	1579 <h3>Requests</h3><dl><dt class="request"><a name="request_edit.format">edit. format</a> (<a href="#request_edit.format">#</a>)</dt><dd><div class="box"><pre> request: {

1579 "id": String	1580 "id": String

1580 "method": "edit.format"	1581 "method": "edit.format"

1581 "params": {	1582 "params": {

1582 "<b>file</b>": <a href="#type_FilePath">FilePath</a>	1583 "<b>file</b>": <a href="#type_FilePath">FilePath</a>

1583 "<b>selectionOffset</b>": int	1584 "<b>selectionOffset</b>": int

1584 "<b>selectionLength</b>": int	1585 "<b>selectionLength</b>": int

1585 "<b>lineLength</b>": <span style="color:#999999">optional</span> int	1586 "<b>lineLength</b>": <span style="color:#999999">optional</span> int

1586 }	1587 }

1587 }</pre><br><pre>response: {	1588 }</pre><br><pre>response: {

(...skipping 345 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1933	1934

1934 <p>	1935 <p>

1935 The Dart file to sort.	1936 The Dart file to sort.

1936 </p>	1937 </p>

1937 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href=" #type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd>	1938 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href=" #type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd>

1938	1939

1939 <p>	1940 <p>

1940 The file edit that is to be applied to the given file to effect	1941 The file edit that is to be applied to the given file to effect

1941 the sorting.	1942 the sorting.

1942 </p>	1943 </p>

	1944 </dd></dl></dd><dt class="request"><a name="request_edit.organizeDirec tives">edit.organizeDirectives</a> (<a href="#request_edit.organizeDirectives"># </a>)</dt><dd><div class="box"><pre>request: {

	1945 "id": String

	1946 "method": "edit.organizeDirectives"

	1947 "params": {

	1948 "<b>file</b>": <a href="#type_FilePath">FilePath</a>

	1949 }

	1950 }</pre><br><pre>response: {

	1951 "id": String

	1952 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

	1953 "result": {

	1954 "<b>edit</b>": <a href="#type_SourceFileEdit">SourceFileEdit</a>

	1955 }

	1956 }</pre></div>

	1957 <p>

	1958 Organizes all of the directives - removes unused imports and sorts

	1959 directives of the given Dart file.

	1960 </p>

	1961 <p>

	1962 If a request is made for a file that does not exist, does not belong

	1963 to an analysis root or is not a Dart file,

	1964 <tt>ORGANIZE_DIRECTIVES_INVALID_FILE</tt> will be generated.

	1965 </p>

	1966 <p>

	1967 If the Dart file has scan or parse errors,

	1968 <tt>ORGANIZE_DIRECTIVES_PARSE_ERRORS</tt> will be generated.

	1969 </p>

	1970

	1971

	1972 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>

	1973

	1974 <p>

	1975 The Dart file to organize directives in.

	1976 </p>

	1977 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>edit ( <a href=" #type_SourceFileEdit">SourceFileEdit</a> )</i></b></dt><dd>

	1978

	1979 <p>

	1980 The file edit that is to be applied to the given file to effect

	1981 the organizing.

	1982 </p>

1943 </dd></dl></dd></dl>	1983 </dd></dl></dd></dl>

1944 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>	1984 <h2 class="domain"><a name="domain_execution">Domain: execution</a></h2>

1945 <p>	1985 <p>

1946 The execution domain contains commands related to providing an execution	1986 The execution domain contains commands related to providing an execution

1947 or debugging experience.	1987 or debugging experience.

1948 </p>	1988 </p>

1949	1989

1950	1990

1951	1991

1952	1992

(...skipping 1462 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3415	3455

3416 <p>	3456 <p>

3417 A malformed request was received.	3457 A malformed request was received.

3418 </p>	3458 </p>

3419 </dd><dt class="value">NO_INDEX_GENERATED</dt><dd>	3459 </dd><dt class="value">NO_INDEX_GENERATED</dt><dd>

3420	3460

3421 <p>	3461 <p>

3422 The "--no-index" flag was passed when the analysis server created,	3462 The "--no-index" flag was passed when the analysis server created,

3423 but this API call requires an index to have been generated.	3463 but this API call requires an index to have been generated.

3424 </p>	3464 </p>

	3465 </dd><dt class="value">ORGANIZE_DIRECTIVES_INVALID_FILE</dt><dd>

	3466

	3467 <p>

	3468 An "edit.organizeDirectives" request specified a FilePath

	3469 which does not match a Dart file in an analysis root.

	3470 </p>

	3471 </dd><dt class="value">ORGANIZE_DIRECTIVES_PARSE_ERRORS</dt><dd>

	3472

	3473 <p>

	3474 An "edit.organizeDirectives" request specified a Dart file that ha s

	3475 scan or parse errors.

	3476 </p>

3425 </dd><dt class="value">REFACTORING_REQUEST_CANCELLED</dt><dd>	3477 </dd><dt class="value">REFACTORING_REQUEST_CANCELLED</dt><dd>

3426	3478

3427 <p>	3479 <p>

3428 Another refactoring request was received during processing of	3480 Another refactoring request was received during processing of

3429 this one.	3481 this one.

3430 </p>	3482 </p>

3431 </dd><dt class="value">SERVER_ALREADY_STARTED</dt><dd>	3483 </dd><dt class="value">SERVER_ALREADY_STARTED</dt><dd>

3432	3484

3433 <p>	3485 <p>

3434 The analysis server has already been started (and hence	3486 The analysis server has already been started (and hence

(...skipping 605 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
4040 <p>	4092 <p>

4041 This section contains a list of all of the errors that are	4093 This section contains a list of all of the errors that are

4042 produced by the server and the data that is returned with each.	4094 produced by the server and the data that is returned with each.

4043 </p>	4095 </p>

4044 <p>	4096 <p>

4045 TBD	4097 TBD

4046 </p>	4098 </p>

4047	4099

4048	4100

4049 </body></html>	4101 </body></html>

OLD	NEW

« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | pkg/analysis_server/tool/spec/spec_input.html » ('J')