Proposal for the 'edit.organizeDirectives' request.

pkg/analysis_server/tool/spec/spec_input.html

Index: pkg/analysis_server/tool/spec/spec_input.html
diff --git a/pkg/analysis_server/tool/spec/spec_input.html b/pkg/analysis_server/tool/spec/spec_input.html
index 23e13e418f326326427b50b2a0f73896e7f2de0a..bb9004fb42e29b70e8e8d091e800ff4033881ad6 100644
--- a/pkg/analysis_server/tool/spec/spec_input.html
+++ b/pkg/analysis_server/tool/spec/spec_input.html
@@ -1697,6 +1697,38 @@
           </field>
         </result>
       </request>
+      <request method="organizeDirectives">
+        <p>
+          Organizes all of the directives - removes unused imports and sorts
+          directives of the given Dart file.
+        </p>
+        <p>
+          If a request is made for a file that does not exist, does not belong
+          to an analysis root or is not a Dart file,
+          <tt>ORGANIZE_DIRECTIVES_INVALID_FILE</tt> will be generated.
+        </p>
+        <p>
+          If the Dart file has scan or parse errors,
+          <tt>ORGANIZE_DIRECTIVES_PARSE_ERRORS</tt> will be generated.
+        </p>
+        <params>
+          <field name="file">
+            <ref>FilePath</ref>
+            <p>
+              The Dart file to organize directives in.
+            </p>
+          </field>
+        </params>
+        <result>
+          <field name="edit">
+            <ref>SourceFileEdit</ref>

[Brian Wilkerson, 2015/07/31 19:47:35]

Do we always want to replace all of the imports as a single edit, or might we
want to optimize the edits by having a small number of less disruptive edits? (I
don't know which is best, I just want to make sure we're thought about it.)

[scheglov, 2015/07/31 20:25:02]

Discussed offline.
A single file edit, with possible multiple edits in that file.

+            <p>
+              The file edit that is to be applied to the given file to effect
+              the organizing.
+            </p>
+          </field>
+        </result>
+      </request>
     </domain>
     <domain name="execution">
       <p>
@@ -3456,6 +3488,20 @@
             </p>
           </value>
           <value>
+            <code>ORGANIZE_DIRECTIVES_INVALID_FILE</code>

[Brian Wilkerson, 2015/07/31 19:47:35]

I'm not sure I like this trend of having a separate error code for each request.
Kind of seems like we could have a single "FILE_NOT_ANALYZED" error code for all
of the "*_INVALID_FILE" codes. The client already knows which request cause the
error. Of course, it would be a breaking change to change the others, and it
would be inconsistent to have one general code and lots of specific codes,
but...

[scheglov, 2015/07/31 20:25:02]

Done.

+            <p>
+              An "edit.organizeDirectives" request specified a FilePath
+              which does not match a Dart file in an analysis root.
+            </p>
+          </value>
+          <value>
+            <code>ORGANIZE_DIRECTIVES_PARSE_ERRORS</code>
+            <p>
+              An "edit.organizeDirectives" request specified a Dart file that has
+              scan or parse errors.
+            </p>
+          </value>
+          <value>
             <code>REFACTORING_REQUEST_CANCELLED</code>
             <p>
               Another refactoring request was received during processing of