Skip to content
This repository
Browse code

index.html

  • Loading branch information...
commit da5e992363cdc8d502eeec0f3b7c4aa4d397bf33 1 parent 9229b16
Matt Russell authored

Showing 2 changed files with 202 additions and 592 deletions. Show diff stats Hide diff stats

  1. +0 560 README.html
  2. +202 32 index.html
560 README.html
... ... @@ -1,560 +0,0 @@
1   -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3   -
4   -<html xmlns="http://www.w3.org/1999/xhtml">
5   - <head>
6   - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7   -
8   - <title>Scalariform &mdash; Scalariform v0.1.0-SNAPSHOT documentation</title>
9   - <link rel="stylesheet" href="static/default.css" type="text/css" />
10   - <link rel="stylesheet" href="static/pygments.css" type="text/css" />
11   - <script type="text/javascript">
12   - var DOCUMENTATION_OPTIONS = {
13   - URL_ROOT: '',
14   - VERSION: '0.1.0-SNAPSHOT',
15   - COLLAPSE_MODINDEX: false,
16   - FILE_SUFFIX: '.html',
17   - HAS_SOURCE: true
18   - };
19   - </script>
20   - <script type="text/javascript" src="static/jquery.js"></script>
21   - <script type="text/javascript" src="static/doctools.js"></script>
22   - <link rel="top" title="Scalariform v0.1.0-SNAPSHOT documentation" href="index.html" />
23   - </head>
24   - <body>
25   - <div class="related">
26   - <h3>Navigation</h3>
27   - <ul>
28   - <li class="right" style="margin-right: 10px">
29   - <a href="genindex.html" title="General Index"
30   - accesskey="I">index</a></li>
31   - <li><a href="#">Scalariform v0.1.0-SNAPSHOT documentation</a> &raquo;</li>
32   - </ul>
33   - </div>
34   -
35   - <div class="document">
36   - <div class="documentwrapper">
37   - <div class="body">
38   -
39   - <div class="section" id="scalariform">
40   -<h1>Scalariform<a class="headerlink" href="#scalariform" title="Permalink to this headline">¶</a></h1>
41   -<p>Scalariform is a code formatter for Scala 2.8+. It is a library and a
42   -stand-alone command line tool, with integrations available for various
43   -editors (see below).</p>
44   -<p>Currently, Scalariform supports only a limited set of options. The
45   -plan is to add further features as and when people ask for them, so
46   -please do raise a ticket if it doesn&#8217;t format your code the way you&#8217;d
47   -like it, and I&#8217;ll see what I can do.</p>
48   -<p>Scalariform is licenced under <a class="reference external" href="http://www.opensource.org/licenses/mit-license.php">The MIT Licence</a>.</p>
49   -<div class="section" id="download">
50   -<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
51   -<p>Scalariform is available from Scala-tools.org:</p>
52   -<blockquote>
53   -<a class="reference external" href="http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.9/">http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.9/</a></blockquote>
54   -<p>If you&#8217;re using sbt, you can declare a dependency as follows:</p>
55   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">scalariform</span> <span class="k">=</span> <span class="s">&quot;org.scalariform&quot;</span> <span class="o">%%</span> <span class="s">&quot;scalariform&quot;</span> <span class="o">%</span> <span class="s">&quot;0.0.9&quot;</span>
56   -</pre></div>
57   -</div>
58   -</div>
59   -<div class="section" id="integration-with-eclipse">
60   -<h2>Integration with Eclipse<a class="headerlink" href="#integration-with-eclipse" title="Permalink to this headline">¶</a></h2>
61   -<p>Scala IDE for Eclipse uses Scalariform for formatting:</p>
62   -<blockquote>
63   -<a class="reference external" href="http://download.scala-ide.org/">http://download.scala-ide.org/</a></blockquote>
64   -<p>(See <a class="reference external" href="http://www.assembla.com/wiki/show/scala-ide/Requirements_and_Installation">http://www.assembla.com/wiki/show/scala-ide/Requirements_and_Installation</a>
65   -for more detailed instructions.)</p>
66   -<p>Formatting works the same in the Scala editor; that is, either</p>
67   -<ul class="simple">
68   -<li>Right click in the editor -&gt; Source -&gt; Format</li>
69   -<li>Press Ctrl-Shift-F</li>
70   -</ul>
71   -<p>To configure preferences, go to Window -&gt; Preferences -&gt; Scala -&gt; Formatter</p>
72   -<p>It can also perform formatting as a save action (Window -&gt; Preferences -&gt; Java -&gt; Editor -&gt; Save Actions).</p>
73   -</div>
74   -<div class="section" id="integration-with-emacs-ensime">
75   -<h2>Integration with Emacs/ENSIME<a class="headerlink" href="#integration-with-emacs-ensime" title="Permalink to this headline">¶</a></h2>
76   -<p>&#8220;<a class="reference external" href="http://github.com/aemoncannon/ensime">ENSIME</a> uses the Scalariform library to format Scala sources. Type C-c C-v f to format the current buffer.&#8221;</p>
77   -<blockquote>
78   -<a class="reference external" href="http://aemon.com/file_dump/ensime_manual.html#tth_sEc4.8">http://aemon.com/file_dump/ensime_manual.html#tth_sEc4.8</a></blockquote>
79   -</div>
80   -<div class="section" id="integration-with-jedit">
81   -<h2>Integration with jEdit<a class="headerlink" href="#integration-with-jedit" title="Permalink to this headline">¶</a></h2>
82   -<p>See <a class="reference external" href="http://github.com/StefanE/ScalaSidekick">ScalaSidekick</a> by Stefan Ettrup:</p>
83   -<p>Run Plugins -&gt; scalaSidekickPlugin -&gt; Format Scala File</p>
84   -</div>
85   -<div class="section" id="integration-with-maven">
86   -<h2>Integration with Maven<a class="headerlink" href="#integration-with-maven" title="Permalink to this headline">¶</a></h2>
87   -<p>There is a Maven plugin to run Scalariform contributed by <a class="reference external" href="https://github.com/jadamcrain">Adam
88   -Crain</a> on scala-tools.</p>
89   -<p>Usage:</p>
90   -<div class="highlight-scala"><div class="highlight"><pre><span class="o">&lt;</span><span class="n">plugin</span><span class="o">&gt;</span>
91   - <span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">org</span><span class="o">.</span><span class="n">scalariform</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
92   - <span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">scalariform</span><span class="o">-</span><span class="n">maven</span><span class="o">-</span><span class="n">plugin</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
93   - <span class="o">&lt;</span><span class="n">version</span><span class="o">&gt;</span><span class="mf">0.0</span><span class="o">.</span><span class="mi">9</span><span class="o">&lt;/</span><span class="n">version</span><span class="o">&gt;</span>
94   - <span class="o">&lt;</span><span class="n">executions</span><span class="o">&gt;</span>
95   - <span class="o">&lt;</span><span class="n">execution</span><span class="o">&gt;</span>
96   - <span class="o">&lt;</span><span class="n">phase</span><span class="o">&gt;</span><span class="n">process</span><span class="o">-</span><span class="n">sources</span><span class="o">&lt;/</span><span class="n">phase</span><span class="o">&gt;</span>
97   - <span class="o">&lt;</span><span class="n">goals</span><span class="o">&gt;</span>
98   - <span class="o">&lt;</span><span class="n">goal</span><span class="o">&gt;</span><span class="n">format</span><span class="o">&lt;/</span><span class="n">goal</span><span class="o">&gt;</span>
99   - <span class="o">&lt;/</span><span class="n">goals</span><span class="o">&gt;</span>
100   - <span class="o">&lt;</span><span class="n">configuration</span><span class="o">&gt;</span>
101   - <span class="o">&lt;</span><span class="n">rewriteArrowSymbols</span><span class="o">&gt;</span><span class="kc">true</span><span class="o">&lt;/</span><span class="n">rewriteArrowSymbols</span><span class="o">&gt;</span>
102   - <span class="o">&lt;/</span><span class="n">configuration</span><span class="o">&gt;</span>
103   - <span class="o">&lt;/</span><span class="n">execution</span><span class="o">&gt;</span>
104   - <span class="o">&lt;/</span><span class="n">executions</span><span class="o">&gt;</span>
105   -<span class="o">&lt;/</span><span class="n">plugin</span><span class="o">&gt;</span>
106   -</pre></div>
107   -</div>
108   -</div>
109   -<div class="section" id="integration-with-sbt">
110   -<h2>Integration with sbt<a class="headerlink" href="#integration-with-sbt" title="Permalink to this headline">¶</a></h2>
111   -<p><a class="reference external" href="http://github.com/olim7t/sbt-scalariform">sbt-scalariform</a>, written by Olivier Michallat, provides an sbt plugin contributing formatting actions.</p>
112   -</div>
113   -<div class="section" id="integration-with-textmate">
114   -<h2>Integration with TextMate<a class="headerlink" href="#integration-with-textmate" title="Permalink to this headline">¶</a></h2>
115   -<p>See Mads Jensen&#8217;s Scala TextMate bundle:</p>
116   -<blockquote>
117   -<a class="reference external" href="http://github.com/mads379/scala.tmbundle">http://github.com/mads379/scala.tmbundle</a></blockquote>
118   -<p>Reformat using Ctrl-Shift-H.</p>
119   -</div>
120   -<div class="section" id="use-with-vim">
121   -<h2>Use with Vim<a class="headerlink" href="#use-with-vim" title="Permalink to this headline">¶</a></h2>
122   -<p>While there is no specific Vim integration at present, you can use
123   -Scalariform as an external formatter for the <tt class="docutils literal"><span class="pre">gq</span></tt> command by adding
124   -the following to <tt class="docutils literal"><span class="pre">.vimrc</span></tt></p>
125   -<div class="highlight-scala"><div class="highlight"><pre><span class="n">au</span> <span class="nc">BufEnter</span> <span class="o">*.</span><span class="n">scala</span> <span class="n">setl</span> <span class="n">formatprg</span><span class="o">=</span><span class="n">scala</span><span class="o">\</span> <span class="o">-</span><span class="n">cp</span><span class="o">\</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">scalariform_2</span><span class="o">.</span><span class="mf">8.0</span><span class="o">-</span><span class="mf">0.0</span><span class="o">.</span><span class="mf">9.</span><span class="n">jar</span><span class="o">\</span> <span class="n">scalariform</span><span class="o">.</span><span class="n">commandline</span><span class="o">.</span><span class="nc">Main</span><span class="o">\</span> <span class="o">--</span><span class="n">forceOutput</span>
126   -</pre></div>
127   -</div>
128   -</div>
129   -<div class="section" id="command-line-tool">
130   -<h2>Command line tool<a class="headerlink" href="#command-line-tool" title="Permalink to this headline">¶</a></h2>
131   -<p>Scalariform includes a stand-alone command line utility. Sample script:</p>
132   -<div class="highlight-scala"><pre>#!/bin/bash
133   -scala -cp /path/to/scalariform-0.0.9.jar scalariform.commandline.Main "$@"</pre>
134   -</div>
135   -<p>Usage:</p>
136   -<div class="highlight-scala"><pre>Usage: scalariform [options] [files...]
137   -
138   -Options:
139   - --encoding=&lt;encoding&gt; Set the encoding, e.g. UTF-8. If not set, defaults to the platform default encoding.
140   - --fileList=&lt;path&gt;, -l=&lt;path&gt; Read the list of input file(s) from a text file (one per line)
141   - --help, -h Show help
142   - --inPlace, -i Replace the input file(s) in place with a formatted version.
143   - --test, -t Check the input(s) to see if they are correctly formatted, return a non-zero error code if not.
144   - --forceOutput, -f Return the input unchanged if the file cannot be parsed correctly. (Only works for input on stdin)
145   - --verbose, -v Verbose output
146   - --version Show Scalariform version
147   -
148   -Preferences:
149   - [+|-]alignParameters Enable/disable Align parameters on different lines in the same column
150   - [+|-]alignSingleLineCaseStatements Enable/disable Align the arrows of consecutive single-line case statements
151   - [+|-]compactStringConcatenation Enable/disable Omit spaces when formatting a '+' operator on String literals
152   - [+|-]doubleIndentClassDeclaration Enable/disable Double indent either a class's parameters or its inheritance list
153   - [+|-]formatXml Enable/disable Format XML literals
154   - [+|-]indentLocalDefs Enable/disable Indent local defs an extra level
155   - [+|-]indentPackageBlocks Enable/disable Indent package blocks
156   - [+|-]preserveDanglingCloseParenthesis Enable/disable Allow a newline before a ')' in an argument expression.
157   - [+|-]preserveSpaceBeforeArguments Enable/disable Preserve a space before a parenthesis argument
158   - [+|-]rewriteArrowSymbols Enable/disable Replace arrow tokens with unicode equivalents: =&gt; with ⇒, and &lt;- with ←
159   - [+|-]spaceBeforeColon Enable/disable Add a space before colons
160   - [+|-]spaceInsideBrackets Enable/disable Require a space after '[' and before ']'
161   - [+|-]spaceInsideParentheses Enable/disable Require a space after '(' and before ')'
162   - -alignSingleLineCaseStatements.maxArrowIndent=[1-100] Set Maximum number of spaces inserted before an arrow to align case statements
163   - -indentSpaces=[1-10] Set Number of spaces to use for indentation
164   -
165   -Examples:
166   - scalariform +spaceBeforeColon -alignParameters -indentSpaces=2 --inPlace foo.scala
167   - find . -name '*.scala' | xargs scalariform +rewriteArrowSymbols --verbose --test
168   - echo 'class A ( n :Int )' | scalariform</pre>
169   -</div>
170   -</div>
171   -<div class="section" id="library">
172   -<h2>Library<a class="headerlink" href="#library" title="Permalink to this headline">¶</a></h2>
173   -<p>Example usage:</p>
174   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">import</span> <span class="nn">scalariform.formatter.preferences._</span>
175   -<span class="k">import</span> <span class="nn">scalariform.formatter.ScalaFormatter</span>
176   -<span class="k">import</span> <span class="nn">scalariform.parser.ScalaParserException</span>
177   -
178   -<span class="k">object</span> <span class="nc">Test</span> <span class="k">extends</span> <span class="nc">Application</span> <span class="o">{</span>
179   -
180   - <span class="k">val</span> <span class="n">unformattedScala</span> <span class="k">=</span> <span class="s">&quot;&quot;&quot;</span>
181   -<span class="s"> class A {</span>
182   -<span class="s"> println (42)}&quot;&quot;&quot;</span>
183   - <span class="k">val</span> <span class="n">preferences</span> <span class="k">=</span> <span class="nc">FormattingPreferences</span><span class="o">().</span><span class="n">setPreference</span><span class="o">(</span><span class="nc">IndentSpaces</span><span class="o">,</span> <span class="mi">3</span><span class="o">)</span>
184   - <span class="k">try</span> <span class="o">{</span>
185   - <span class="k">val</span> <span class="n">formattedScala</span> <span class="k">=</span> <span class="nc">ScalaFormatter</span><span class="o">.</span><span class="n">format</span><span class="o">(</span><span class="n">unformattedScala</span><span class="o">,</span> <span class="n">preferences</span><span class="o">)</span>
186   - <span class="n">println</span><span class="o">(</span><span class="n">formattedScala</span><span class="o">)</span>
187   - <span class="o">}</span> <span class="k">catch</span> <span class="o">{</span>
188   - <span class="k">case</span> <span class="n">e</span><span class="k">:</span> <span class="kt">ScalaParserException</span> <span class="o">=&gt;</span> <span class="n">println</span><span class="o">(</span><span class="s">&quot;Syntax error in Scala source&quot;</span><span class="o">)</span>
189   - <span class="o">}</span>
190   -
191   -<span class="o">}</span>
192   -</pre></div>
193   -</div>
194   -</div>
195   -<div class="section" id="preferences">
196   -<h2>Preferences<a class="headerlink" href="#preferences" title="Permalink to this headline">¶</a></h2>
197   -<div class="section" id="alignparameters">
198   -<h3>alignParameters<a class="headerlink" href="#alignparameters" title="Permalink to this headline">¶</a></h3>
199   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
200   -<p>Align class/function parameters in the same column. For example, if <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
201   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="o">(</span><span class="n">name</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
202   - <span class="n">age</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
203   - <span class="n">birthdate</span><span class="k">:</span> <span class="kt">Date</span><span class="o">,</span>
204   - <span class="n">astrologicalSign</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
205   - <span class="n">shoeSize</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
206   - <span class="n">favoriteColor</span><span class="k">:</span> <span class="kt">java.awt.Color</span><span class="o">)</span>
207   -</pre></div>
208   -</div>
209   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
210   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="o">(</span><span class="n">name</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
211   - <span class="n">age</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
212   - <span class="n">birthdate</span><span class="k">:</span> <span class="kt">Date</span><span class="o">,</span>
213   - <span class="n">astrologicalSign</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
214   - <span class="n">shoeSize</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
215   - <span class="n">favoriteColor</span><span class="k">:</span> <span class="kt">java.awt.Color</span><span class="o">)</span>
216   -</pre></div>
217   -</div>
218   -</div>
219   -<div class="section" id="alignsinglelinecasestatements">
220   -<h3>alignSingleLineCaseStatements<a class="headerlink" href="#alignsinglelinecasestatements" title="Permalink to this headline">¶</a></h3>
221   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
222   -<p>Align the arrows of consecutive single-line case statements. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
223   -<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
224   - <span class="k">case</span> <span class="n">b</span> <span class="k">=&gt;</span> <span class="mi">1</span>
225   - <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
226   - <span class="k">case</span> <span class="n">dd</span> <span class="k">=&gt;</span> <span class="mi">3</span>
227   -<span class="o">}</span>
228   -</pre></div>
229   -</div>
230   -<p>Is reformatted as:</p>
231   -<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
232   - <span class="k">case</span> <span class="n">b</span> <span class="k">=&gt;</span> <span class="mi">1</span>
233   - <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
234   - <span class="k">case</span> <span class="n">dd</span> <span class="k">=&gt;</span> <span class="mi">3</span>
235   -<span class="o">}</span>
236   -</pre></div>
237   -</div>
238   -</div>
239   -<div class="section" id="alignsinglelinecasestatements-maxarrowindent">
240   -<h3>alignSingleLineCaseStatements.maxArrowIndent<a class="headerlink" href="#alignsinglelinecasestatements-maxarrowindent" title="Permalink to this headline">¶</a></h3>
241   -<p>Default: <tt class="docutils literal"><span class="pre">40</span></tt></p>
242   -<p>When using alignSingleLineCaseStatements == true, this is a limit on
243   -the number of spaces that can be inserted before an arrow to align it
244   -with other case statements. This can be used to avoid very large gaps,
245   -e.g.:</p>
246   -<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
247   - <span class="k">case</span> <span class="nc">Some</span><span class="o">(</span><span class="n">wibble</span><span class="o">,</span> <span class="n">wobble</span><span class="o">)</span> <span class="k">if</span> <span class="n">wibble</span> <span class="o">+</span> <span class="n">wibble</span> <span class="o">&gt;</span> <span class="n">wobble</span> <span class="o">*</span> <span class="n">wibble</span> <span class="k">=&gt;</span> <span class="mi">1</span>
248   - <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
249   -<span class="o">}</span>
250   -</pre></div>
251   -</div>
252   -</div>
253   -<div class="section" id="compactstringconcatenation">
254   -<h3>compactStringConcatenation<a class="headerlink" href="#compactstringconcatenation" title="Permalink to this headline">¶</a></h3>
255   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
256   -<p>Omit spaces when formatting a &#8216;+&#8217; operator on String literals&#8221;. For example, If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
257   -<div class="highlight-scala"><div class="highlight"><pre><span class="s">&quot;Hello &quot;</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="s">&quot;!&quot;</span>
258   -</pre></div>
259   -</div>
260   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
261   -<div class="highlight-scala"><div class="highlight"><pre><span class="s">&quot;Hello &quot;</span><span class="o">+</span><span class="n">name</span><span class="o">+</span><span class="s">&quot;!&quot;</span>
262   -</pre></div>
263   -</div>
264   -<p>The Scala Style Guide <a class="reference external" href="http://davetron5000.github.com/scala-style/method_invocation/operators.html">recommends</a> that operators, &#8220;should <cite>always</cite> be
265   -invoked using infix notation with spaces separated the target&#8221;.</p>
266   -</div>
267   -<div class="section" id="doubleindentclassdeclaration">
268   -<h3>doubleIndentClassDeclaration<a class="headerlink" href="#doubleindentclassdeclaration" title="Permalink to this headline">¶</a></h3>
269   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
270   -<p>With this set to <tt class="docutils literal"><span class="pre">true</span></tt>, class (and trait / object) declarations
271   -will be formatted as recommended by the <a class="reference external" href="http://davetron5000.github.com/scala-style/">Scala Style Guide</a>. That is,
272   -if the declaration section spans multiple lines, it will be formatted
273   -so that either the parameter section or the inheritance section is
274   -doubly indented. This provides a visual distinction from the members
275   -of the class. For example:</p>
276   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="o">(</span>
277   - <span class="n">name</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
278   - <span class="n">age</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
279   - <span class="n">birthdate</span><span class="k">:</span> <span class="kt">Date</span><span class="o">,</span>
280   - <span class="n">astrologicalSign</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
281   - <span class="n">shoeSize</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
282   - <span class="n">favoriteColor</span><span class="k">:</span> <span class="kt">java.awt.Color</span><span class="o">)</span>
283   - <span class="k">extends</span> <span class="nc">Entity</span>
284   - <span class="k">with</span> <span class="nc">Logging</span>
285   - <span class="k">with</span> <span class="nc">Identifiable</span>
286   - <span class="k">with</span> <span class="nc">Serializable</span> <span class="o">{</span>
287   - <span class="k">def</span> <span class="n">firstMethod</span> <span class="k">=</span> <span class="o">...</span>
288   -<span class="o">}</span>
289   -</pre></div>
290   -</div>
291   -<p>Or:</p>
292   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Person</span><span class="o">(</span>
293   - <span class="n">name</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
294   - <span class="n">age</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
295   - <span class="n">birthdate</span><span class="k">:</span> <span class="kt">Date</span><span class="o">,</span>
296   - <span class="n">astrologicalSign</span><span class="k">:</span> <span class="kt">String</span><span class="o">,</span>
297   - <span class="n">shoeSize</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span>
298   - <span class="n">favoriteColor</span><span class="k">:</span> <span class="kt">java.awt.Color</span><span class="o">)</span> <span class="o">{</span>
299   - <span class="k">def</span> <span class="n">firstMethod</span> <span class="k">=</span> <span class="o">...</span>
300   -<span class="o">}</span>
301   -</pre></div>
302   -</div>
303   -</div>
304   -<div class="section" id="formatxml">
305   -<h3>formatXml<a class="headerlink" href="#formatxml" title="Permalink to this headline">¶</a></h3>
306   -<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
307   -<p>Format embedded XML literals; if <tt class="docutils literal"><span class="pre">false</span></tt> they will be left untouched.</p>
308   -</div>
309   -<div class="section" id="indentlocaldefs">
310   -<h3>indentLocalDefs<a class="headerlink" href="#indentlocaldefs" title="Permalink to this headline">¶</a></h3>
311   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
312   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, indent local methods an extra level, with the intention of distinguishing them from other statements. For example,:</p>
313   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">A</span> <span class="o">{</span>
314   - <span class="k">def</span> <span class="n">find</span><span class="o">(...)</span> <span class="k">=</span> <span class="o">{</span>
315   - <span class="k">val</span> <span class="n">x</span> <span class="k">=</span> <span class="o">...</span>
316   - <span class="k">def</span> <span class="n">find0</span><span class="o">()</span> <span class="k">=</span> <span class="o">{</span>
317   - <span class="o">...</span>
318   - <span class="o">}</span>
319   - <span class="n">find0</span><span class="o">(...)</span>
320   - <span class="o">}</span>
321   -<span class="o">}</span>
322   -</pre></div>
323   -</div>
324   -</div>
325   -<div class="section" id="indentpackageblocks">
326   -<h3>indentPackageBlocks<a class="headerlink" href="#indentpackageblocks" title="Permalink to this headline">¶</a></h3>
327   -<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
328   -<p>Whether to indent package blocks. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>:</p>
329   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">package</span> <span class="nn">foo</span> <span class="o">{</span>
330   - <span class="k">package</span> <span class="nn">bar</span> <span class="o">{</span>
331   - <span class="k">class</span> <span class="nc">Baz</span>
332   - <span class="o">}</span>
333   -<span class="o">}</span>
334   -</pre></div>
335   -</div>
336   -<p>Else if <tt class="docutils literal"><span class="pre">false</span></tt>:</p>
337   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">package</span> <span class="nn">foo</span> <span class="o">{</span>
338   -<span class="k">package</span> <span class="nn">bar</span> <span class="o">{</span>
339   -<span class="k">class</span> <span class="nc">Baz</span>
340   -<span class="o">}</span>
341   -<span class="o">}</span>
342   -</pre></div>
343   -</div>
344   -</div>
345   -<div class="section" id="indentspaces">
346   -<h3>indentSpaces<a class="headerlink" href="#indentspaces" title="Permalink to this headline">¶</a></h3>
347   -<p>Default: <tt class="docutils literal"><span class="pre">2</span></tt></p>
348   -<p>The number of spaces to use for each level of indentation.</p>
349   -</div>
350   -<div class="section" id="preservedanglingcloseparenthesis">
351   -<h3>preserveDanglingCloseParenthesis<a class="headerlink" href="#preservedanglingcloseparenthesis" title="Permalink to this headline">¶</a></h3>
352   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
353   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, it will keep a newline before a close parenthesis &#8216;)&#8217; in an
354   -argument expression. For example:</p>
355   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">book</span> <span class="k">=</span> <span class="nc">Book</span><span class="o">(</span>
356   - <span class="n">name</span> <span class="k">=</span> <span class="s">&quot;Name&quot;</span><span class="o">,</span>
357   - <span class="n">author</span> <span class="k">=</span> <span class="s">&quot;Author&quot;</span><span class="o">,</span>
358   - <span class="n">rating</span> <span class="k">=</span> <span class="mi">5</span>
359   -<span class="o">)</span>
360   -</pre></div>
361   -</div>
362   -<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, the parenthesis will be joined to the end of the argument list:</p>
363   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">book</span> <span class="k">=</span> <span class="nc">Book</span><span class="o">(</span>
364   - <span class="n">name</span> <span class="k">=</span> <span class="s">&quot;Name&quot;</span><span class="o">,</span>
365   - <span class="n">author</span> <span class="k">=</span> <span class="s">&quot;Author&quot;</span><span class="o">,</span>
366   - <span class="n">rating</span> <span class="k">=</span> <span class="mi">5</span><span class="o">)</span>
367   -</pre></div>
368   -</div>
369   -</div>
370   -<div class="section" id="preservespacebeforearguments">
371   -<h3>preserveSpaceBeforeArguments<a class="headerlink" href="#preservespacebeforearguments" title="Permalink to this headline">¶</a></h3>
372   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
373   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, the formatter will keep an existing space before a parenthesis argument. For example:</p>
374   -<div class="highlight-scala"><div class="highlight"><pre><span class="n">stack</span><span class="o">.</span><span class="n">pop</span><span class="o">()</span> <span class="n">should</span> <span class="n">equal</span> <span class="o">(</span><span class="mi">2</span><span class="o">)</span>
375   -</pre></div>
376   -</div>
377   -<p>Otherwise, if <tt class="docutils literal"><span class="pre">false</span></tt>, spaces before arguments will always be removed.</p>
378   -</div>
379   -<div class="section" id="rewritearrowsymbols">
380   -<h3>rewriteArrowSymbols<a class="headerlink" href="#rewritearrowsymbols" title="Permalink to this headline">¶</a></h3>
381   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
382   -<p>Replace arrow tokens with their unicode equivalents: <tt class="docutils literal"><span class="pre">=&gt;</span></tt> with <tt class="docutils literal"><span class="pre">⇒</span></tt>, and <tt class="docutils literal"><span class="pre">&lt;-</span></tt> with <tt class="docutils literal"><span class="pre">←</span></tt>. For example:</p>
383   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">for</span> <span class="o">(</span><span class="n">n</span> <span class="k">&lt;-</span> <span class="mi">1</span> <span class="n">to</span> <span class="mi">10</span><span class="o">)</span> <span class="n">n</span> <span class="o">%</span> <span class="mi">2</span> <span class="k">match</span> <span class="o">{</span>
384   - <span class="k">case</span> <span class="mi">0</span> <span class="k">=&gt;</span> <span class="n">println</span><span class="o">(</span><span class="s">&quot;even&quot;</span><span class="o">)</span>
385   - <span class="k">case</span> <span class="mi">1</span> <span class="k">=&gt;</span> <span class="n">println</span><span class="o">(</span><span class="s">&quot;odd&quot;</span><span class="o">)</span>
386   -<span class="o">}</span>
387   -</pre></div>
388   -</div>
389   -<p>is formatted as:</p>
390   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">for</span> <span class="o">(</span><span class="n">n</span> <span class="k">←</span> <span class="mi">1</span> <span class="n">to</span> <span class="mi">10</span><span class="o">)</span> <span class="n">n</span> <span class="o">%</span> <span class="mi">2</span> <span class="k">match</span> <span class="o">{</span>
391   - <span class="k">case</span> <span class="mi">0</span> <span class="k">⇒</span> <span class="n">println</span><span class="o">(</span><span class="s">&quot;even&quot;</span><span class="o">)</span>
392   - <span class="k">case</span> <span class="mi">1</span> <span class="k">⇒</span> <span class="n">println</span><span class="o">(</span><span class="s">&quot;odd&quot;</span><span class="o">)</span>
393   -<span class="o">}</span>
394   -</pre></div>
395   -</div>
396   -</div>
397   -<div class="section" id="spacebeforecolon">
398   -<h3>spaceBeforeColon<a class="headerlink" href="#spacebeforecolon" title="Permalink to this headline">¶</a></h3>
399   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
400   -<p>Whether to ensure a space before colon. For example, If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
401   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">add</span><span class="o">(</span><span class="n">a</span><span class="k">:</span> <span class="kt">Int</span><span class="o">,</span> <span class="n">b</span><span class="k">:</span> <span class="kt">Int</span><span class="o">)</span><span class="k">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span>
402   -</pre></div>
403   -</div>
404   -<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
405   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">add</span><span class="o">(</span><span class="n">a</span> <span class="k">:</span> <span class="kt">Int</span><span class="o">,</span> <span class="n">b</span> <span class="k">:</span> <span class="kt">Int</span><span class="o">)</span> <span class="k">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span>
406   -</pre></div>
407   -</div>
408   -</div>
409   -<div class="section" id="spaceinsidebrackets">
410   -<h3>spaceInsideBrackets<a class="headerlink" href="#spaceinsidebrackets" title="Permalink to this headline">¶</a></h3>
411   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
412   -<p>Whether to use a space inside type brackets. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
413   -<div class="highlight-scala"><div class="highlight"><pre><span class="nc">Array</span><span class="o">[</span> <span class="kt">String</span> <span class="o">]</span>
414   -</pre></div>
415   -</div>
416   -<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
417   -<div class="highlight-scala"><div class="highlight"><pre><span class="nc">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">]</span>
418   -</pre></div>
419   -</div>
420   -</div>
421   -<div class="section" id="spaceinsideparentheses">
422   -<h3>spaceInsideParentheses<a class="headerlink" href="#spaceinsideparentheses" title="Permalink to this headline">¶</a></h3>
423   -<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
424   -<p>Whether to use a space inside non-empty parentheses. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
425   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">main</span><span class="o">(</span> <span class="n">args</span> <span class="k">:</span> <span class="kt">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">]</span> <span class="o">)</span>
426   -</pre></div>
427   -</div>
428   -<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
429   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">main</span><span class="o">(</span><span class="n">args</span> <span class="k">:</span> <span class="kt">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">])</span>
430   -</pre></div>
431   -</div>
432   -</div>
433   -<div class="section" id="id1">
434   -<h3>Scala Style Guide<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
435   -<p>Scalariform is compatible with the <a class="reference external" href="http://davetron5000.github.com/scala-style/">Scala Style Guide</a> in the sense
436   -that, given the right preference settings, source code that is
437   -initially compiliant with the Style Guide will not become uncompliant
438   -after formatting. In a number of cases, running the formatter will
439   -make uncompliant source more compliant.</p>
440   -<table border="1" class="docutils">
441   -<colgroup>
442   -<col width="61%" />
443   -<col width="20%" />
444   -<col width="20%" />
445   -</colgroup>
446   -<thead valign="bottom">
447   -<tr><th class="head">Preference</th>
448   -<th class="head">Value</th>
449   -<th class="head">Default?</th>
450   -</tr>
451   -</thead>
452   -<tbody valign="top">
453   -<tr><td>alignParameters</td>
454   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
455   -<td>&nbsp;</td>
456   -</tr>
457   -<tr><td>compactStringConcatenation</td>
458   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
459   -<td>&nbsp;</td>
460   -</tr>
461   -<tr><td>doubleIndentClassDeclaration</td>
462   -<td><tt class="docutils literal"><span class="pre">true</span></tt></td>
463   -<td>No</td>
464   -</tr>
465   -<tr><td>indentSpaces</td>
466   -<td><tt class="docutils literal"><span class="pre">2</span></tt></td>
467   -<td>&nbsp;</td>
468   -</tr>
469   -<tr><td>preserveSpaceBeforeArguments</td>
470   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
471   -<td>&nbsp;</td>
472   -</tr>
473   -<tr><td>rewriteArrowSymbols</td>
474   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
475   -<td>&nbsp;</td>
476   -</tr>
477   -<tr><td>spaceBeforeColon</td>
478   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
479   -<td>&nbsp;</td>
480   -</tr>
481   -<tr><td>spaceInsideBrackets</td>
482   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
483   -<td>&nbsp;</td>
484   -</tr>
485   -<tr><td>spaceInsideParentheses</td>
486   -<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
487   -<td>&nbsp;</td>
488   -</tr>
489   -</tbody>
490   -</table>
491   -</div>
492   -</div>
493   -<div class="section" id="source-directives">
494   -<h2>Source directives<a class="headerlink" href="#source-directives" title="Permalink to this headline">¶</a></h2>
495   -<p>As well as global preferences, formatting can be tweaked at the source level through comments.</p>
496   -<div class="section" id="format-on-off">
497   -<h3>format: [ON|OFF]<a class="headerlink" href="#format-on-off" title="Permalink to this headline">¶</a></h3>
498   -<p>Disables the formatter for selective portions of a source file:</p>
499   -<div class="highlight-scala"><div class="highlight"><pre><span class="c1">// format: OFF &lt;-- this directive disables formatting from this point</span>
500   -<span class="k">class</span> <span class="nc">AsciiDSL</span> <span class="o">{</span>
501   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;1&quot;</span> <span class="o">-+</span> <span class="o">{</span> <span class="n">n</span><span class="k">:</span> <span class="kt">Node</span> <span class="o">=&gt;</span>
502   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;i&quot;</span>
503   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;ii&quot;</span>
504   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;iii&quot;</span>
505   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;iv&quot;</span>
506   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;v&quot;</span>
507   - <span class="o">}</span>
508   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;2&quot;</span>
509   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;3&quot;</span> <span class="o">-+</span> <span class="o">{</span> <span class="n">n</span><span class="k">:</span> <span class="kt">Node</span> <span class="o">=&gt;</span>
510   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;i&quot;</span>
511   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;ii&quot;</span> <span class="o">-+</span> <span class="o">{</span> <span class="n">n</span><span class="k">:</span> <span class="kt">Node</span> <span class="o">=&gt;</span>
512   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;a&quot;</span>
513   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;b&quot;</span>
514   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;c&quot;</span>
515   - <span class="o">}</span>
516   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;iii&quot;</span>
517   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;iv&quot;</span>
518   - <span class="n">n</span> <span class="o">¦-</span> <span class="s">&quot;v&quot;</span>
519   - <span class="o">}</span>
520   - <span class="c1">// format: ON &lt;-- formatter resumes from this point</span>
521   - <span class="o">...</span>
522   -<span class="o">}</span>
523   -<span class="c1">// (see: http://dev.day.com/microsling/content/blogs/main/scalajcr2.html)</span>
524   -</pre></div>
525   -</div>
526   -</div>
527   -<div class="section" id="format-preferencename">
528   -<h3>format: [+|-]&lt;preferenceName&gt;<a class="headerlink" href="#format-preferencename" title="Permalink to this headline">¶</a></h3>
529   -<p>Sets a preference for the entire of the source file, overriding the global formatting settings:</p>
530   -<div class="highlight-scala"><div class="highlight"><pre><span class="c1">// format: +preserveSpaceBeforeArguments</span>
531   -<span class="k">class</span> <span class="nc">StackSpec</span> <span class="k">extends</span> <span class="nc">FlatSpec</span> <span class="k">with</span> <span class="nc">ShouldMatchers</span> <span class="o">{</span>
532   - <span class="c1">// ...</span>
533   - <span class="n">stack</span><span class="o">.</span><span class="n">pop</span><span class="o">()</span> <span class="n">should</span> <span class="n">equal</span> <span class="o">(</span><span class="mi">2</span><span class="o">)</span>
534   -<span class="o">}</span>
535   -</pre></div>
536   -</div>
537   -</div>
538   -</div>
539   -</div>
540   -
541   -
542   - </div>
543   - </div>
544   - <div class="clearer"></div>
545   - </div>
546   - <div class="related">
547   - <h3>Navigation</h3>
548   - <ul>
549   - <li class="right" style="margin-right: 10px">
550   - <a href="genindex.html" title="General Index"
551   - >index</a></li>
552   - <li><a href="#">Scalariform v0.1.0-SNAPSHOT documentation</a> &raquo;</li>
553   - </ul>
554   - </div>
555   - <div class="footer">
556   - &copy; Copyright 2010, Matt Russell.
557   - Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
558   - </div>
559   - </body>
560   -</html>
234 index.html
@@ -5,13 +5,13 @@
5 5 <head>
6 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 7
8   - <title>Scalariform &mdash; Scalariform v0.0.6 documentation</title>
  8 + <title>Scalariform &mdash; Scalariform v0.1.0-SNAPSHOT documentation</title>
9 9 <link rel="stylesheet" href="static/default.css" type="text/css" />
10 10 <link rel="stylesheet" href="static/pygments.css" type="text/css" />
11 11 <script type="text/javascript">
12 12 var DOCUMENTATION_OPTIONS = {
13   - URL_ROOT: '#',
14   - VERSION: '0.0.6',
  13 + URL_ROOT: '',
  14 + VERSION: '0.1.0-SNAPSHOT',
15 15 COLLAPSE_MODINDEX: false,
16 16 FILE_SUFFIX: '.html',
17 17 HAS_SOURCE: true
@@ -19,7 +19,7 @@
19 19 </script>
20 20 <script type="text/javascript" src="static/jquery.js"></script>
21 21 <script type="text/javascript" src="static/doctools.js"></script>
22   - <link rel="top" title="Scalariform v0.0.6 documentation" href="index.html" />
  22 + <link rel="top" title="Scalariform v0.1.0-SNAPSHOT documentation" href="index.html" />
23 23 </head>
24 24 <body>
25 25 <div class="related">
@@ -28,7 +28,7 @@
28 28 <li class="right" style="margin-right: 10px">
29 29 <a href="genindex.html" title="General Index"
30 30 accesskey="I">index</a></li>
31   - <li><a href="#">Scalariform v0.0.6 documentation</a> &raquo;</li>
  31 + <li><a href="#">Scalariform v0.1.0-SNAPSHOT documentation</a> &raquo;</li>
32 32 </ul>
33 33 </div>
34 34
@@ -38,20 +38,21 @@
38 38
39 39 <div class="section" id="scalariform">
40 40 <h1>Scalariform<a class="headerlink" href="#scalariform" title="Permalink to this headline">¶</a></h1>
41   -<p>Scalariform is a code formatter for Scala 2.8. It is a library and a
42   -stand-alone command line tool, with integrations for Eclipse, ENSIME,
43   -TextMate and sbt. Currently, Scalariform supports only a limited set
44   -of options, although it is intended to be compatible with the
45   -recommendations of the <a class="reference external" href="http://davetron5000.github.com/scala-style/">Scala Style Guide</a> (see below). Please let me
46   -know what other features people would like.</p>
  41 +<p>Scalariform is a code formatter for Scala 2.8+. It is a library and a
  42 +stand-alone command line tool, with integrations available for various
  43 +editors (see below).</p>
  44 +<p>Currently, Scalariform supports only a limited set of options. The
  45 +plan is to add further features as and when people ask for them, so
  46 +please do raise a ticket if it doesn&#8217;t format your code the way you&#8217;d
  47 +like it, and I&#8217;ll see what I can do.</p>
47 48 <p>Scalariform is licenced under <a class="reference external" href="http://www.opensource.org/licenses/mit-license.php">The MIT Licence</a>.</p>
48 49 <div class="section" id="download">
49 50 <h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
50 51 <p>Scalariform is available from Scala-tools.org:</p>
51 52 <blockquote>
52   -<a class="reference external" href="http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.5/">http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.5/</a></blockquote>
  53 +<a class="reference external" href="http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.9/">http://scala-tools.org/repo-releases/org/scalariform/scalariform_2.8.0/0.0.9/</a></blockquote>
53 54 <p>If you&#8217;re using sbt, you can declare a dependency as follows:</p>
54   -<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">scalariform</span> <span class="k">=</span> <span class="s">&quot;org.scalariform&quot;</span> <span class="o">%%</span> <span class="s">&quot;scalariform&quot;</span> <span class="o">%</span> <span class="s">&quot;0.0.5&quot;</span>
  55 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">scalariform</span> <span class="k">=</span> <span class="s">&quot;org.scalariform&quot;</span> <span class="o">%%</span> <span class="s">&quot;scalariform&quot;</span> <span class="o">%</span> <span class="s">&quot;0.0.9&quot;</span>
55 56 </pre></div>
56 57 </div>
57 58 </div>
@@ -70,12 +71,41 @@
70 71 <p>To configure preferences, go to Window -&gt; Preferences -&gt; Scala -&gt; Formatter</p>
71 72 <p>It can also perform formatting as a save action (Window -&gt; Preferences -&gt; Java -&gt; Editor -&gt; Save Actions).</p>
72 73 </div>
73   -<div class="section" id="integration-with-ensime">
74   -<h2>Integration with ENSIME<a class="headerlink" href="#integration-with-ensime" title="Permalink to this headline">¶</a></h2>
75   -<p>&#8220;<a class="reference external" href="http://github.com/aemoncannon/ensime">ENSIME</a> uses the Scalariform library to format Scala sources. Type C-c f to format the current buffer.&#8221;</p>
  74 +<div class="section" id="integration-with-emacs-ensime">
  75 +<h2>Integration with Emacs/ENSIME<a class="headerlink" href="#integration-with-emacs-ensime" title="Permalink to this headline">¶</a></h2>
  76 +<p>&#8220;<a class="reference external" href="http://github.com/aemoncannon/ensime">ENSIME</a> uses the Scalariform library to format Scala sources. Type C-c C-v f to format the current buffer.&#8221;</p>
76 77 <blockquote>
77 78 <a class="reference external" href="http://aemon.com/file_dump/ensime_manual.html#tth_sEc4.8">http://aemon.com/file_dump/ensime_manual.html#tth_sEc4.8</a></blockquote>
78 79 </div>
  80 +<div class="section" id="integration-with-jedit">
  81 +<h2>Integration with jEdit<a class="headerlink" href="#integration-with-jedit" title="Permalink to this headline">¶</a></h2>
  82 +<p>See <a class="reference external" href="http://github.com/StefanE/ScalaSidekick">ScalaSidekick</a> by Stefan Ettrup:</p>
  83 +<p>Run Plugins -&gt; scalaSidekickPlugin -&gt; Format Scala File</p>
  84 +</div>
  85 +<div class="section" id="integration-with-maven">
  86 +<h2>Integration with Maven<a class="headerlink" href="#integration-with-maven" title="Permalink to this headline">¶</a></h2>
  87 +<p>There is a Maven plugin to run Scalariform contributed by <a class="reference external" href="https://github.com/jadamcrain">Adam
  88 +Crain</a> on scala-tools.</p>
  89 +<p>Usage:</p>
  90 +<div class="highlight-scala"><div class="highlight"><pre><span class="o">&lt;</span><span class="n">plugin</span><span class="o">&gt;</span>
  91 + <span class="o">&lt;</span><span class="n">groupId</span><span class="o">&gt;</span><span class="n">org</span><span class="o">.</span><span class="n">scalariform</span><span class="o">&lt;/</span><span class="n">groupId</span><span class="o">&gt;</span>
  92 + <span class="o">&lt;</span><span class="n">artifactId</span><span class="o">&gt;</span><span class="n">scalariform</span><span class="o">-</span><span class="n">maven</span><span class="o">-</span><span class="n">plugin</span><span class="o">&lt;/</span><span class="n">artifactId</span><span class="o">&gt;</span>
  93 + <span class="o">&lt;</span><span class="n">version</span><span class="o">&gt;</span><span class="mf">0.0</span><span class="o">.</span><span class="mi">9</span><span class="o">&lt;/</span><span class="n">version</span><span class="o">&gt;</span>
  94 + <span class="o">&lt;</span><span class="n">executions</span><span class="o">&gt;</span>
  95 + <span class="o">&lt;</span><span class="n">execution</span><span class="o">&gt;</span>
  96 + <span class="o">&lt;</span><span class="n">phase</span><span class="o">&gt;</span><span class="n">process</span><span class="o">-</span><span class="n">sources</span><span class="o">&lt;/</span><span class="n">phase</span><span class="o">&gt;</span>
  97 + <span class="o">&lt;</span><span class="n">goals</span><span class="o">&gt;</span>
  98 + <span class="o">&lt;</span><span class="n">goal</span><span class="o">&gt;</span><span class="n">format</span><span class="o">&lt;/</span><span class="n">goal</span><span class="o">&gt;</span>
  99 + <span class="o">&lt;/</span><span class="n">goals</span><span class="o">&gt;</span>
  100 + <span class="o">&lt;</span><span class="n">configuration</span><span class="o">&gt;</span>
  101 + <span class="o">&lt;</span><span class="n">rewriteArrowSymbols</span><span class="o">&gt;</span><span class="kc">true</span><span class="o">&lt;/</span><span class="n">rewriteArrowSymbols</span><span class="o">&gt;</span>
  102 + <span class="o">&lt;/</span><span class="n">configuration</span><span class="o">&gt;</span>
  103 + <span class="o">&lt;/</span><span class="n">execution</span><span class="o">&gt;</span>
  104 + <span class="o">&lt;/</span><span class="n">executions</span><span class="o">&gt;</span>
  105 +<span class="o">&lt;/</span><span class="n">plugin</span><span class="o">&gt;</span>
  106 +</pre></div>
  107 +</div>
  108 +</div>
79 109 <div class="section" id="integration-with-sbt">
80 110 <h2>Integration with sbt<a class="headerlink" href="#integration-with-sbt" title="Permalink to this headline">¶</a></h2>
81 111 <p><a class="reference external" href="http://github.com/olim7t/sbt-scalariform">sbt-scalariform</a>, written by Olivier Michallat, provides an sbt plugin contributing formatting actions.</p>
@@ -87,32 +117,50 @@
87 117 <a class="reference external" href="http://github.com/mads379/scala.tmbundle">http://github.com/mads379/scala.tmbundle</a></blockquote>
88 118 <p>Reformat using Ctrl-Shift-H.</p>
89 119 </div>
  120 +<div class="section" id="use-with-vim">
  121 +<h2>Use with Vim<a class="headerlink" href="#use-with-vim" title="Permalink to this headline">¶</a></h2>
  122 +<p>While there is no specific Vim integration at present, you can use
  123 +Scalariform as an external formatter for the <tt class="docutils literal"><span class="pre">gq</span></tt> command by adding
  124 +the following to <tt class="docutils literal"><span class="pre">.vimrc</span></tt></p>
  125 +<div class="highlight-scala"><div class="highlight"><pre><span class="n">au</span> <span class="nc">BufEnter</span> <span class="o">*.</span><span class="n">scala</span> <span class="n">setl</span> <span class="n">formatprg</span><span class="o">=</span><span class="n">scala</span><span class="o">\</span> <span class="o">-</span><span class="n">cp</span><span class="o">\</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">scalariform_2</span><span class="o">.</span><span class="mf">8.0</span><span class="o">-</span><span class="mf">0.0</span><span class="o">.</span><span class="mf">9.</span><span class="n">jar</span><span class="o">\</span> <span class="n">scalariform</span><span class="o">.</span><span class="n">commandline</span><span class="o">.</span><span class="nc">Main</span><span class="o">\</span> <span class="o">--</span><span class="n">forceOutput</span>
  126 +</pre></div>
  127 +</div>
  128 +</div>
90 129 <div class="section" id="command-line-tool">
91 130 <h2>Command line tool<a class="headerlink" href="#command-line-tool" title="Permalink to this headline">¶</a></h2>
92 131 <p>Scalariform includes a stand-alone command line utility. Sample script:</p>
93 132 <div class="highlight-scala"><pre>#!/bin/bash
94   -scala -cp /path/to/scalariform-0.0.5.jar scalariform.commandline.Main "$@"</pre>
  133 +scala -cp /path/to/scalariform-0.0.9.jar scalariform.commandline.Main "$@"</pre>
95 134 </div>
96 135 <p>Usage:</p>
97   -<div class="highlight-scala"><pre>scalariform [options] [files...]
  136 +<div class="highlight-scala"><pre>Usage: scalariform [options] [files...]
98 137
99 138 Options:
  139 + --encoding=&lt;encoding&gt; Set the encoding, e.g. UTF-8. If not set, defaults to the platform default encoding.
  140 + --fileList=&lt;path&gt;, -l=&lt;path&gt; Read the list of input file(s) from a text file (one per line)
100 141 --help, -h Show help
101 142 --inPlace, -i Replace the input file(s) in place with a formatted version.
102 143 --test, -t Check the input(s) to see if they are correctly formatted, return a non-zero error code if not.
103   - --fileList=&lt;path&gt;, -l=&lt;path&gt; Read the list of input file(s) from a text file (one per line)
104   - --verbose -v Verbose output
  144 + --forceOutput, -f Return the input unchanged if the file cannot be parsed correctly. (Only works for input on stdin)
  145 + --verbose, -v Verbose output
105 146 --version Show Scalariform version
106 147
107 148 Preferences:
108   - [+|-]alignParameters Enable/disable Align parameters on different lines in the same column
109   - [+|-]compactStringConcatenation Enable/disable Omit spaces when formatting a '+' operator on String literals
110   - [+|-]doubleIndentClassDeclaration Enable/disable Double indent either a class's parameters or its inheritance list
111   - [+|-]formatXml Enable/disable Format XML literals
112   - -indentSpaces=[1-10] Set Number of spaces to use for indentation
113   - [+|-]preserveSpaceBeforeArguments Enable/disable Preserve a space before a parenthesis argument
114   - [+|-]rewriteArrowSymbols Enable/disable Replace arrow tokens with unicode equivalents: =&gt; with ⇒, and &lt;- with ←
115   - [+|-]spaceBeforeColon Enable/disable Add a space before colons
  149 + [+|-]alignParameters Enable/disable Align parameters on different lines in the same column
  150 + [+|-]alignSingleLineCaseStatements Enable/disable Align the arrows of consecutive single-line case statements
  151 + [+|-]compactStringConcatenation Enable/disable Omit spaces when formatting a '+' operator on String literals
  152 + [+|-]doubleIndentClassDeclaration Enable/disable Double indent either a class's parameters or its inheritance list
  153 + [+|-]formatXml Enable/disable Format XML literals
  154 + [+|-]indentLocalDefs Enable/disable Indent local defs an extra level
  155 + [+|-]indentPackageBlocks Enable/disable Indent package blocks
  156 + [+|-]preserveDanglingCloseParenthesis Enable/disable Allow a newline before a ')' in an argument expression.
  157 + [+|-]preserveSpaceBeforeArguments Enable/disable Preserve a space before a parenthesis argument
  158 + [+|-]rewriteArrowSymbols Enable/disable Replace arrow tokens with unicode equivalents: =&gt; with ⇒, and &lt;- with ←
  159 + [+|-]spaceBeforeColon Enable/disable Add a space before colons
  160 + [+|-]spaceInsideBrackets Enable/disable Require a space after '[' and before ']'
  161 + [+|-]spaceInsideParentheses Enable/disable Require a space after '(' and before ')'
  162 + -alignSingleLineCaseStatements.maxArrowIndent=[1-100] Set Maximum number of spaces inserted before an arrow to align case statements
  163 + -indentSpaces=[1-10] Set Number of spaces to use for indentation
116 164
117 165 Examples:
118 166 scalariform +spaceBeforeColon -alignParameters -indentSpaces=2 --inPlace foo.scala
@@ -168,6 +216,40 @@
168 216 </pre></div>
169 217 </div>
170 218 </div>
  219 +<div class="section" id="alignsinglelinecasestatements">
  220 +<h3>alignSingleLineCaseStatements<a class="headerlink" href="#alignsinglelinecasestatements" title="Permalink to this headline">¶</a></h3>
  221 +<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
  222 +<p>Align the arrows of consecutive single-line case statements. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
  223 +<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
  224 + <span class="k">case</span> <span class="n">b</span> <span class="k">=&gt;</span> <span class="mi">1</span>
  225 + <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
  226 + <span class="k">case</span> <span class="n">dd</span> <span class="k">=&gt;</span> <span class="mi">3</span>
  227 +<span class="o">}</span>
  228 +</pre></div>
  229 +</div>
  230 +<p>Is reformatted as:</p>
  231 +<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
  232 + <span class="k">case</span> <span class="n">b</span> <span class="k">=&gt;</span> <span class="mi">1</span>
  233 + <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
  234 + <span class="k">case</span> <span class="n">dd</span> <span class="k">=&gt;</span> <span class="mi">3</span>
  235 +<span class="o">}</span>
  236 +</pre></div>
  237 +</div>
  238 +</div>
  239 +<div class="section" id="alignsinglelinecasestatements-maxarrowindent">
  240 +<h3>alignSingleLineCaseStatements.maxArrowIndent<a class="headerlink" href="#alignsinglelinecasestatements-maxarrowindent" title="Permalink to this headline">¶</a></h3>
  241 +<p>Default: <tt class="docutils literal"><span class="pre">40</span></tt></p>
  242 +<p>When using alignSingleLineCaseStatements == true, this is a limit on
  243 +the number of spaces that can be inserted before an arrow to align it
  244 +with other case statements. This can be used to avoid very large gaps,
  245 +e.g.:</p>
  246 +<div class="highlight-scala"><div class="highlight"><pre><span class="n">a</span> <span class="k">match</span> <span class="o">{</span>
  247 + <span class="k">case</span> <span class="nc">Some</span><span class="o">(</span><span class="n">wibble</span><span class="o">,</span> <span class="n">wobble</span><span class="o">)</span> <span class="k">if</span> <span class="n">wibble</span> <span class="o">+</span> <span class="n">wibble</span> <span class="o">&gt;</span> <span class="n">wobble</span> <span class="o">*</span> <span class="n">wibble</span> <span class="k">=&gt;</span> <span class="mi">1</span>
  248 + <span class="k">case</span> <span class="n">ccc</span> <span class="k">=&gt;</span> <span class="mi">2</span>
  249 +<span class="o">}</span>
  250 +</pre></div>
  251 +</div>
  252 +</div>
171 253 <div class="section" id="compactstringconcatenation">
172 254 <h3>compactStringConcatenation<a class="headerlink" href="#compactstringconcatenation" title="Permalink to this headline">¶</a></h3>
173 255 <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
@@ -224,11 +306,67 @@
224 306 <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
225 307 <p>Format embedded XML literals; if <tt class="docutils literal"><span class="pre">false</span></tt> they will be left untouched.</p>
226 308 </div>
  309 +<div class="section" id="indentlocaldefs">
  310 +<h3>indentLocalDefs<a class="headerlink" href="#indentlocaldefs" title="Permalink to this headline">¶</a></h3>
  311 +<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
  312 +<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, indent local methods an extra level, with the intention of distinguishing them from other statements. For example,:</p>
  313 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">class</span> <span class="nc">A</span> <span class="o">{</span>
  314 + <span class="k">def</span> <span class="n">find</span><span class="o">(...)</span> <span class="k">=</span> <span class="o">{</span>
  315 + <span class="k">val</span> <span class="n">x</span> <span class="k">=</span> <span class="o">...</span>
  316 + <span class="k">def</span> <span class="n">find0</span><span class="o">()</span> <span class="k">=</span> <span class="o">{</span>
  317 + <span class="o">...</span>
  318 + <span class="o">}</span>
  319 + <span class="n">find0</span><span class="o">(...)</span>
  320 + <span class="o">}</span>
  321 +<span class="o">}</span>
  322 +</pre></div>
  323 +</div>
  324 +</div>
  325 +<div class="section" id="indentpackageblocks">
  326 +<h3>indentPackageBlocks<a class="headerlink" href="#indentpackageblocks" title="Permalink to this headline">¶</a></h3>
  327 +<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
  328 +<p>Whether to indent package blocks. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>:</p>
  329 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">package</span> <span class="nn">foo</span> <span class="o">{</span>
  330 + <span class="k">package</span> <span class="nn">bar</span> <span class="o">{</span>
  331 + <span class="k">class</span> <span class="nc">Baz</span>
  332 + <span class="o">}</span>
  333 +<span class="o">}</span>
  334 +</pre></div>
  335 +</div>
  336 +<p>Else if <tt class="docutils literal"><span class="pre">false</span></tt>:</p>
  337 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">package</span> <span class="nn">foo</span> <span class="o">{</span>
  338 +<span class="k">package</span> <span class="nn">bar</span> <span class="o">{</span>
  339 +<span class="k">class</span> <span class="nc">Baz</span>
  340 +<span class="o">}</span>
  341 +<span class="o">}</span>
  342 +</pre></div>
  343 +</div>
  344 +</div>
227 345 <div class="section" id="indentspaces">
228 346 <h3>indentSpaces<a class="headerlink" href="#indentspaces" title="Permalink to this headline">¶</a></h3>
229 347 <p>Default: <tt class="docutils literal"><span class="pre">2</span></tt></p>
230 348 <p>The number of spaces to use for each level of indentation.</p>
231 349 </div>
  350 +<div class="section" id="preservedanglingcloseparenthesis">
  351 +<h3>preserveDanglingCloseParenthesis<a class="headerlink" href="#preservedanglingcloseparenthesis" title="Permalink to this headline">¶</a></h3>
  352 +<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
  353 +<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, it will keep a newline before a close parenthesis &#8216;)&#8217; in an
  354 +argument expression. For example:</p>
  355 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">book</span> <span class="k">=</span> <span class="nc">Book</span><span class="o">(</span>
  356 + <span class="n">name</span> <span class="k">=</span> <span class="s">&quot;Name&quot;</span><span class="o">,</span>
  357 + <span class="n">author</span> <span class="k">=</span> <span class="s">&quot;Author&quot;</span><span class="o">,</span>
  358 + <span class="n">rating</span> <span class="k">=</span> <span class="mi">5</span>
  359 +<span class="o">)</span>
  360 +</pre></div>
  361 +</div>
  362 +<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, the parenthesis will be joined to the end of the argument list:</p>
  363 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">val</span> <span class="n">book</span> <span class="k">=</span> <span class="nc">Book</span><span class="o">(</span>
  364 + <span class="n">name</span> <span class="k">=</span> <span class="s">&quot;Name&quot;</span><span class="o">,</span>
  365 + <span class="n">author</span> <span class="k">=</span> <span class="s">&quot;Author&quot;</span><span class="o">,</span>
  366 + <span class="n">rating</span> <span class="k">=</span> <span class="mi">5</span><span class="o">)</span>
  367 +</pre></div>
  368 +</div>
  369 +</div>
232 370 <div class="section" id="preservespacebeforearguments">
233 371 <h3>preserveSpaceBeforeArguments<a class="headerlink" href="#preservespacebeforearguments" title="Permalink to this headline">¶</a></h3>
234 372 <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
@@ -268,10 +406,34 @@
268 406 </pre></div>
269 407 </div>
270 408 </div>
  409 +<div class="section" id="spaceinsidebrackets">
  410 +<h3>spaceInsideBrackets<a class="headerlink" href="#spaceinsidebrackets" title="Permalink to this headline">¶</a></h3>
  411 +<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
  412 +<p>Whether to use a space inside type brackets. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
  413 +<div class="highlight-scala"><div class="highlight"><pre><span class="nc">Array</span><span class="o">[</span> <span class="kt">String</span> <span class="o">]</span>
  414 +</pre></div>
  415 +</div>
  416 +<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
  417 +<div class="highlight-scala"><div class="highlight"><pre><span class="nc">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">]</span>
  418 +</pre></div>
  419 +</div>
  420 +</div>
  421 +<div class="section" id="spaceinsideparentheses">
  422 +<h3>spaceInsideParentheses<a class="headerlink" href="#spaceinsideparentheses" title="Permalink to this headline">¶</a></h3>
  423 +<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
  424 +<p>Whether to use a space inside non-empty parentheses. For example, if <tt class="docutils literal"><span class="pre">true</span></tt>, then:</p>
  425 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">main</span><span class="o">(</span> <span class="n">args</span> <span class="k">:</span> <span class="kt">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">]</span> <span class="o">)</span>
  426 +</pre></div>
  427 +</div>
  428 +<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, then:</p>
  429 +<div class="highlight-scala"><div class="highlight"><pre><span class="k">def</span> <span class="n">main</span><span class="o">(</span><span class="n">args</span> <span class="k">:</span> <span class="kt">Array</span><span class="o">[</span><span class="kt">String</span><span class="o">])</span>
  430 +</pre></div>
  431 +</div>
  432 +</div>
271 433 <div class="section" id="id1">
272 434 <h3>Scala Style Guide<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
273   -<p>Scalariform is &#8220;compatible&#8221; with the <a class="reference external" href="http://davetron5000.github.com/scala-style/">Scala Style Guide</a> v1.1.0 in the
274   -sense that, given the right preference settings, source code that is
  435 +<p>Scalariform is compatible with the <a class="reference external" href="http://davetron5000.github.com/scala-style/">Scala Style Guide</a> in the sense
  436 +that, given the right preference settings, source code that is
275 437 initially compiliant with the Style Guide will not become uncompliant
276 438 after formatting. In a number of cases, running the formatter will
277 439 make uncompliant source more compliant.</p>
@@ -316,6 +478,14 @@
316 478 <td><tt class="docutils literal"><span class="pre">false</span></tt></td>
317 479 <td>&nbsp;</td>
318 480 </tr>
  481 +<tr><td>spaceInsideBrackets</td>
  482 +<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
  483 +<td>&nbsp;</td>
  484 +</tr>
  485 +<tr><td>spaceInsideParentheses</td>
  486 +<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
  487 +<td>&nbsp;</td>
  488 +</tr>
319 489 </tbody>
320 490 </table>
321 491 </div>
@@ -379,12 +549,12 @@
379 549 <li class="right" style="margin-right: 10px">
380 550 <a href="genindex.html" title="General Index"
381 551 >index</a></li>
382   - <li><a href="#">Scalariform v0.0.6 documentation</a> &raquo;</li>
  552 + <li><a href="#">Scalariform v0.1.0-SNAPSHOT documentation</a> &raquo;</li>
383 553 </ul>
384 554 </div>
385 555 <div class="footer">
386 556 &copy; Copyright 2010, Matt Russell.
387   - Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
  557 + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
388 558 </div>
389 559 </body>
390 560 </html>

0 comments on commit da5e992

Please sign in to comment.
Something went wrong with that request. Please try again.