summaryrefslogtreecommitdiffstats
path: root/doc/ft-ruby-indent.txt
blob: 5e27496560b78b3692e066d3acfd43a47e77ee9f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'ruby') == -1

RUBY							*ft-ruby-indent*
							*vim-ruby-indent*

    Ruby: Access modifier indentation	|ruby-access-modifier-indentation|
    Ruby: Block style indentation	|ruby-block-style-indentation|
    Ruby: Assignment style indentation	|ruby-assignment-style-indentation|
    Ruby: Hanging element indentation	|ruby-hanging-element-indentation|

					*ruby-access-modifier-indentation*
					*g:ruby_indent_access_modifier_style*
 Ruby: Access modifier indentation ~

Different access modifier indentation styles can be used by setting: >

	:let g:ruby_indent_access_modifier_style = 'normal'
	:let g:ruby_indent_access_modifier_style = 'indent'
	:let g:ruby_indent_access_modifier_style = 'outdent'
<
By default, the "normal" access modifier style is used.

Access modifier style "normal":
>
  class Indent
    private :method
    protected :method
    private
    def method; end
    protected
    def method; end
    public
    def method; end
  end
<
Access modifier style "indent":
>
  class Indent
    private :method
    protected :method
    private
      def method; end
    protected
      def method; end
    public
    def method; end
  end
<
Access modifier style "outdent":
>
  class Indent
    private :method
    protected :method
  private
    def method; end
  protected
    def method; end
  public
    def method; end
  end
<
					*ruby-block-style-indentation*
					*g:ruby_indent_block_style*
    Ruby: Block style indentation ~

Different block indentation styles can be used by setting: >

    :let g:ruby_indent_block_style = 'expression'
    :let g:ruby_indent_block_style = 'do'
<
By default, the "do" block indent style is used.

Block indent style "expression":
>
    first
      .second do |x|
      something
    end
<
Block indent style "do":
>
    first
      .second do |x|
        something
      end
<

					*ruby-assignment-style-indentation*
					*g:ruby_indent_assignment_style*
    Ruby: Assignment style indentation ~

Different styles of indenting assignment for multiline expressions:
>
    :let g:ruby_indent_assignment_style = 'hanging'
    :let g:ruby_indent_assignment_style = 'variable'
<
By default, the "hanging" style is used.

Assignment indent style "hanging":
>
    x = if condition
          something
        end
<
Assignment indent style "variable":
>
    x = if condition
      something
    end
<

					*ruby-hanging-element-indentation*
					*g:ruby_indent_hanging_elements*
    Ruby: Hanging element indentation ~

Elements of multiline collections -- such as arrays, hashes, and method
argument lists -- can have hanging indentation enabled or disabled with the
following setting.
>
    :let g:ruby_indent_hanging_elements = 1
    :let g:ruby_indent_hanging_elements = 0
<
By default, this setting is "1" (true) meaning that hanging indentation is
enabled in some cases.

Here is an example method call when the setting is true (non-zero):
>
    render('product/show',
           product: product,
           on_sale: true,
          )
<
And the same method call when the setting is false (zero):
>
    render('product/show',
      product: product,
      on_sale: true,
    )
<
Note that, even if the setting is turned on, you can still get non-hanging
indentation by putting each argument on a separate line:
>
    render(
      'product/show',
      product: product,
      on_sale: true,
    )
<

 vim:tw=78:sw=4:ts=8:ft=help:norl:

endif