Merge pull request #4191 from danielmartin/swift-format-documentation

Add swift-format documentation

Author: CodaFi

docs/SwiftFormat.md

@@ -0,0 +1,49 @@
+
+# Swift-format
+
+## Introduction
+
+Note: This tool is still a work in progress.
+
+swift-format is a tool for automatically format your Swift files according to a
+set of rules. It is implemented as another driver kind, like swiftc, the batch
+compiler, so swift-format is actually a symbolic link to swift. This tool uses
+libIDE to format code, so it can be leveraged from multiple systems and editors.
+
+## Usage
+
+To print all the available options:
+
+     swift-format -help
+
+By default, swift-format will output the formatted file to the standard output:
+
+     swift-format sample.swift
+
+You can either output the result to a separate file:
+
+     swift-format sample.swift -o result.swift
+
+Or you can format in-place (the original file will be overwritten):
+
+     swift-format -in-place sample.swift
+
+If you want to indent using tabs instead of spaces, use the "-use-tabs" option:
+
+     swift-format -use-tabs sample.swift
+
+You can set the number of tabs or spaces using the "-tab-width" and
+"-indent-width" options, respectively.
+
+swift-format supports formatting a range of lines from a file:
+
+     swift-format -line-range 2:45 sample.swift
+
+This will format the file from lines 2 to 45, inclusive.
+
+You can format several files, but the "-line-range" option is not supported in
+that case.
+
+You can also provide several line ranges by using multiple "-line-range" options:
+
+     swift-format -line-range 2:45 -line-range 100:120 sample.swift

include/swift/Option/Options.td

@@ -321,19 +321,19 @@ def use_tabs : Flag<["-"], "use-tabs">, Group<code_formatting_Group>,
   Flags<[SwiftFormatOption]>,
   HelpText<"Use tabs for indentation.">;
 
-def inplace : Flag<["-"], "inplace">, Group<code_formatting_Group>,
+def in_place : Flag<["-"], "in-place">, Group<code_formatting_Group>,
   Flags<[SwiftFormatOption]>,
   HelpText<"Overwrite input file with formatted file.">;
 
-def tab_width : Separate<["-"], "tabwidth">, Group<code_formatting_Group>,
+def tab_width : Separate<["-"], "tab-width">, Group<code_formatting_Group>,
   Flags<[SwiftFormatOption]>,
   HelpText<"Width of tab character.">, MetaVarName<"<n>">;
 
 def indent_width : Separate<["-"], "indent-width">, Group<code_formatting_Group>,
   Flags<[SwiftFormatOption]>,
   HelpText<"Number of characters to indent.">, MetaVarName<"<n>">;
 
-def line_ranges : Separate<["-"], "line-ranges">, Group<code_formatting_Group>,
+def line_range : Separate<["-"], "line-range">, Group<code_formatting_Group>,
   Flags<[SwiftFormatOption]>,
   HelpText<"<start line>:<end line>. Formats a range of lines (1-based). "
            "Can only be used with one input file.">, MetaVarName<"<n:n>">;

test/swift-format/main.swift

@@ -4,7 +4,7 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-ranges 12:18 %s >%t.response
+// RUN: %swift-format -line-range 12:18 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
 
 import Foundation

test/swift-format/main.swift.indent2.response

@@ -4,7 +4,7 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-ranges 12:18 %s >%t.response
+// RUN: %swift-format -line-range 12:18 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
 
 import Foundation

test/swift-format/main.swift.lines.response

@@ -4,7 +4,7 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-ranges 12:18 %s >%t.response
+// RUN: %swift-format -line-range 12:18 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
 
 import Foundation

test/swift-format/main.swift.response

@@ -4,7 +4,7 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-ranges 12:18 %s >%t.response
+// RUN: %swift-format -line-range 12:18 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
 
 import Foundation

test/swift-format/main.swift.tabs.response

@@ -4,7 +4,7 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-ranges 12:18 %s >%t.response
+// RUN: %swift-format -line-range 12:18 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
 
 import Foundation

tools/driver/swift_format_main.cpp

@@ -120,7 +120,7 @@ class SwiftFormatInvocation {
     if (ParsedArgs.getLastArg(OPT_use_tabs))
       UseTabs = true;
 
-    if (ParsedArgs.getLastArg(OPT_inplace))
+    if (ParsedArgs.getLastArg(OPT_in_place))
       InPlace = true;
 
     if (const Arg *A = ParsedArgs.getLastArg(OPT_tab_width))
@@ -133,7 +133,7 @@ class SwiftFormatInvocation {
         Diags.diagnose(SourceLoc(), diag::error_invalid_arg_value,
                        A->getAsString(ParsedArgs), A->getValue());
 
-    for (const Arg *A : make_range(ParsedArgs.filtered_begin(OPT_line_ranges),
+    for (const Arg *A : make_range(ParsedArgs.filtered_begin(OPT_line_range),
                                    ParsedArgs.filtered_end()))
       LineRanges.push_back(A->getValue());