|
1 | | -# stylish-haskell configuration file |
2 | | -# ================================== |
3 | | - |
4 | | -# The stylish-haskell tool is mainly configured by specifying steps. These steps |
5 | | -# are a list, so they have an order, and one specific step may appear more than |
6 | | -# once (if needed). Each file is processed by these steps in the given order. |
7 | 1 | steps: |
8 | | - # Convert some ASCII sequences to their Unicode equivalents. This is disabled |
9 | | - # by default. |
10 | | - # - unicode_syntax: |
11 | | - # # In order to make this work, we also need to insert the UnicodeSyntax |
12 | | - # # language pragma. If this flag is set to true, we insert it when it's |
13 | | - # # not already present. You may want to disable it if you configure |
14 | | - # # language extensions using some other method than pragmas. Default: |
15 | | - # # true. |
16 | | - # add_language_pragma: true |
17 | | - |
18 | | - # Align the right hand side of some elements. This is quite conservative |
19 | | - # and only applies to statements where each element occupies a single |
20 | | - # line. |
21 | | - - simple_align: |
22 | | - cases: true |
23 | | - top_level_patterns: true |
24 | | - records: true |
25 | | - |
26 | | - # Import cleanup |
27 | 2 | - imports: |
28 | | - # There are different ways we can align names and lists. |
29 | | - # |
30 | | - # - global: Align the import names and import list throughout the entire |
31 | | - # file. |
32 | | - # |
33 | | - # - file: Like global, but don't add padding when there are no qualified |
34 | | - # imports in the file. |
35 | | - # |
36 | | - # - group: Only align the imports per group (a group is formed by adjacent |
37 | | - # import lines). |
38 | | - # |
39 | | - # - none: Do not perform any alignment. |
40 | | - # |
41 | | - # Default: global. |
42 | | - align: global |
43 | | - |
44 | | - # The following options affect only import list alignment. |
45 | | - # |
46 | | - # List align has following options: |
47 | | - # |
48 | | - # - after_alias: Import list is aligned with end of import including |
49 | | - # 'as' and 'hiding' keywords. |
50 | | - # |
51 | | - # > import qualified Data.List as List (concat, foldl, foldr, head, |
52 | | - # > init, last, length) |
53 | | - # |
54 | | - # - with_alias: Import list is aligned with start of alias or hiding. |
55 | | - # |
56 | | - # > import qualified Data.List as List (concat, foldl, foldr, head, |
57 | | - # > init, last, length) |
58 | | - # |
59 | | - # - new_line: Import list starts always on new line. |
60 | | - # |
61 | | - # > import qualified Data.List as List |
62 | | - # > (concat, foldl, foldr, head, init, last, length) |
63 | | - # |
64 | | - # Default: after_alias |
65 | | - list_align: after_alias |
66 | | - |
67 | | - # Right-pad the module names to align imports in a group: |
68 | | - # |
69 | | - # - true: a little more readable |
70 | | - # |
71 | | - # > import qualified Data.List as List (concat, foldl, foldr, |
72 | | - # > init, last, length) |
73 | | - # > import qualified Data.List.Extra as List (concat, foldl, foldr, |
74 | | - # > init, last, length) |
75 | | - # |
76 | | - # - false: diff-safe |
77 | | - # |
78 | | - # > import qualified Data.List as List (concat, foldl, foldr, init, |
79 | | - # > last, length) |
80 | | - # > import qualified Data.List.Extra as List (concat, foldl, foldr, |
81 | | - # > init, last, length) |
82 | | - # |
83 | | - # Default: true |
84 | | - pad_module_names: true |
85 | | - |
86 | | - # Long list align style takes effect when import is too long. This is |
87 | | - # determined by 'columns' setting. |
88 | | - # |
89 | | - # - inline: This option will put as much specs on same line as possible. |
90 | | - # |
91 | | - # - new_line: Import list will start on new line. |
92 | | - # |
93 | | - # - new_line_multiline: Import list will start on new line when it's |
94 | | - # short enough to fit to single line. Otherwise it'll be multiline. |
95 | | - # |
96 | | - # - multiline: One line per import list entry. |
97 | | - # Type with constructor list acts like single import. |
98 | | - # |
99 | | - # > import qualified Data.Map as M |
100 | | - # > ( empty |
101 | | - # > , singleton |
102 | | - # > , ... |
103 | | - # > , delete |
104 | | - # > ) |
105 | | - # |
106 | | - # Default: inline |
107 | | - long_list_align: inline |
108 | | - |
109 | | - # Align empty list (importing instances) |
110 | | - # |
111 | | - # Empty list align has following options |
112 | | - # |
113 | | - # - inherit: inherit list_align setting |
114 | | - # |
115 | | - # - right_after: () is right after the module name: |
116 | | - # |
117 | | - # > import Vector.Instances () |
118 | | - # |
119 | | - # Default: inherit |
| 3 | + align: none |
| 4 | + list_align: with_module_name |
| 5 | + pad_module_names: false |
| 6 | + long_list_align: new_line_multiline |
120 | 7 | empty_list_align: inherit |
121 | | - |
122 | | - # List padding determines indentation of import list on lines after import. |
123 | | - # This option affects 'long_list_align'. |
124 | | - # |
125 | | - # - <integer>: constant value |
126 | | - # |
127 | | - # - module_name: align under start of module name. |
128 | | - # Useful for 'file' and 'group' align settings. |
129 | | - list_padding: 4 |
130 | | - |
131 | | - # Separate lists option affects formatting of import list for type |
132 | | - # or class. The only difference is single space between type and list |
133 | | - # of constructors, selectors and class functions. |
134 | | - # |
135 | | - # - true: There is single space between Foldable type and list of it's |
136 | | - # functions. |
137 | | - # |
138 | | - # > import Data.Foldable (Foldable (fold, foldl, foldMap)) |
139 | | - # |
140 | | - # - false: There is no space between Foldable type and list of it's |
141 | | - # functions. |
142 | | - # |
143 | | - # > import Data.Foldable (Foldable(fold, foldl, foldMap)) |
144 | | - # |
145 | | - # Default: true |
146 | | - separate_lists: true |
147 | | - |
148 | | - # Space surround option affects formatting of import lists on a single |
149 | | - # line. The only difference is single space after the initial |
150 | | - # parenthesis and a single space before the terminal parenthesis. |
151 | | - # |
152 | | - # - true: There is single space associated with the enclosing |
153 | | - # parenthesis. |
154 | | - # |
155 | | - # > import Data.Foo ( foo ) |
156 | | - # |
157 | | - # - false: There is no space associated with the enclosing parenthesis |
158 | | - # |
159 | | - # > import Data.Foo (foo) |
160 | | - # |
161 | | - # Default: false |
| 8 | + list_padding: 7 # length "import " |
| 9 | + separate_lists: false |
162 | 10 | space_surround: false |
163 | | - |
164 | | - # Language pragmas |
165 | 11 | - language_pragmas: |
166 | | - # We can generate different styles of language pragma lists. |
167 | | - # |
168 | | - # - vertical: Vertical-spaced language pragmas, one per line. |
169 | | - # |
170 | | - # - compact: A more compact style. |
171 | | - # |
172 | | - # - compact_line: Similar to compact, but wrap each line with |
173 | | - # `{-#LANGUAGE #-}'. |
174 | | - # |
175 | | - # Default: vertical. |
176 | 12 | style: vertical |
177 | | - |
178 | | - # Align affects alignment of closing pragma brackets. |
179 | | - # |
180 | | - # - true: Brackets are aligned in same column. |
181 | | - # |
182 | | - # - false: Brackets are not aligned together. There is only one space |
183 | | - # between actual import and closing bracket. |
184 | | - # |
185 | | - # Default: true |
186 | | - align: true |
187 | | - |
188 | | - # stylish-haskell can detect redundancy of some language pragmas. If this |
189 | | - # is set to true, it will remove those redundant pragmas. Default: true. |
| 13 | + align: false |
190 | 14 | remove_redundant: true |
191 | | - |
192 | | - # Replace tabs by spaces. This is disabled by default. |
193 | | - # - tabs: |
194 | | - # # Number of spaces to use for each tab. Default: 8, as specified by the |
195 | | - # # Haskell report. |
196 | | - # spaces: 8 |
197 | | - |
198 | | - # Remove trailing whitespace |
| 15 | + - simple_align: |
| 16 | + cases: false |
| 17 | + top_level_patterns: false |
| 18 | + records: false |
199 | 19 | - trailing_whitespace: {} |
200 | | - |
201 | | -# A common setting is the number of columns (parts of) code will be wrapped |
202 | | -# to. Different steps take this into account. Default: 80. |
203 | | -columns: 80 |
204 | | - |
205 | | -# By default, line endings are converted according to the OS. You can override |
206 | | -# preferred format here. |
207 | | -# |
208 | | -# - native: Native newline format. CRLF on Windows, LF on other OSes. |
209 | | -# |
210 | | -# - lf: Convert to LF ("\n"). |
211 | | -# |
212 | | -# - crlf: Convert to CRLF ("\r\n"). |
213 | | -# |
214 | | -# Default: native. |
215 | | -newline: native |
216 | | - |
217 | | -# Sometimes, language extensions are specified in a cabal file or from the |
218 | | -# command line instead of using language pragmas in the file. stylish-haskell |
219 | | -# needs to be aware of these, so it can parse the file correctly. |
220 | | -# |
221 | | -# No language extensions are enabled by default. |
222 | | -# language_extensions: |
223 | | - # - TemplateHaskell |
224 | | - # - QuasiQuotes |
0 commit comments