yamlint 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +31 -9
  3. data/.serena/.gitignore +1 -0
  4. data/.serena/memories/project_overview.md +25 -0
  5. data/.serena/memories/style_and_conventions.md +7 -0
  6. data/.serena/memories/suggested_commands.md +17 -0
  7. data/.serena/memories/task_completion.md +5 -0
  8. data/.serena/project.yml +89 -0
  9. data/CHANGELOG.md +6 -2
  10. data/Gemfile +9 -7
  11. data/LICENSE.txt +1 -1
  12. data/README.md +155 -17
  13. data/Rakefile +10 -3
  14. data/docs/Yamlint/Cli.html +403 -0
  15. data/docs/Yamlint/Config.html +1034 -0
  16. data/docs/Yamlint/Formatter.html +433 -0
  17. data/docs/Yamlint/Linter.html +423 -0
  18. data/docs/Yamlint/Models/LintContext.html +993 -0
  19. data/docs/Yamlint/Models/Problem.html +951 -0
  20. data/docs/Yamlint/Models/Token.html +713 -0
  21. data/docs/Yamlint/Models.html +117 -0
  22. data/docs/Yamlint/Output/Base.html +290 -0
  23. data/docs/Yamlint/Output/Colored.html +293 -0
  24. data/docs/Yamlint/Output/Github.html +260 -0
  25. data/docs/Yamlint/Output/Parsable.html +258 -0
  26. data/docs/Yamlint/Output/Standard.html +270 -0
  27. data/docs/Yamlint/Output.html +208 -0
  28. data/docs/Yamlint/Parser/Comment.html +795 -0
  29. data/docs/Yamlint/Parser/CommentExtractor.html +287 -0
  30. data/docs/Yamlint/Parser/LineParser.html +423 -0
  31. data/docs/Yamlint/Parser/TokenParser/Handler.html +910 -0
  32. data/docs/Yamlint/Parser/TokenParser.html +291 -0
  33. data/docs/Yamlint/Parser.html +117 -0
  34. data/docs/Yamlint/Presets.html +266 -0
  35. data/docs/Yamlint/Rules/Anchors/AnchorHandler.html +678 -0
  36. data/docs/Yamlint/Rules/Anchors.html +314 -0
  37. data/docs/Yamlint/Rules/Base.html +968 -0
  38. data/docs/Yamlint/Rules/Braces.html +335 -0
  39. data/docs/Yamlint/Rules/Brackets.html +335 -0
  40. data/docs/Yamlint/Rules/Colons.html +313 -0
  41. data/docs/Yamlint/Rules/Commas.html +313 -0
  42. data/docs/Yamlint/Rules/CommentRule.html +298 -0
  43. data/docs/Yamlint/Rules/Comments.html +317 -0
  44. data/docs/Yamlint/Rules/CommentsIndentation.html +328 -0
  45. data/docs/Yamlint/Rules/DocumentEnd.html +332 -0
  46. data/docs/Yamlint/Rules/DocumentStart.html +332 -0
  47. data/docs/Yamlint/Rules/EmptyLines.html +300 -0
  48. data/docs/Yamlint/Rules/EmptyValues.html +273 -0
  49. data/docs/Yamlint/Rules/FloatValues.html +383 -0
  50. data/docs/Yamlint/Rules/Hyphens.html +337 -0
  51. data/docs/Yamlint/Rules/Indentation.html +329 -0
  52. data/docs/Yamlint/Rules/KeyDuplicates/DuplicateKeyHandler.html +716 -0
  53. data/docs/Yamlint/Rules/KeyDuplicates.html +258 -0
  54. data/docs/Yamlint/Rules/KeyOrdering/KeyOrderHandler.html +694 -0
  55. data/docs/Yamlint/Rules/KeyOrdering.html +258 -0
  56. data/docs/Yamlint/Rules/LineLength.html +251 -0
  57. data/docs/Yamlint/Rules/LineRule.html +304 -0
  58. data/docs/Yamlint/Rules/NewLineAtEndOfFile.html +308 -0
  59. data/docs/Yamlint/Rules/NewLines.html +310 -0
  60. data/docs/Yamlint/Rules/OctalValues.html +270 -0
  61. data/docs/Yamlint/Rules/QuotedStrings.html +381 -0
  62. data/docs/Yamlint/Rules/Registry.html +492 -0
  63. data/docs/Yamlint/Rules/TokenRule.html +298 -0
  64. data/docs/Yamlint/Rules/TrailingSpaces.html +321 -0
  65. data/docs/Yamlint/Rules/Truthy.html +288 -0
  66. data/docs/Yamlint/Rules.html +190 -0
  67. data/docs/Yamlint/Runner.html +551 -0
  68. data/docs/Yamlint.html +135 -0
  69. data/docs/_index.html +643 -0
  70. data/docs/class_list.html +54 -0
  71. data/docs/css/common.css +1 -0
  72. data/docs/css/full_list.css +58 -0
  73. data/docs/css/style.css +490 -0
  74. data/docs/file.README.html +276 -0
  75. data/docs/file_list.html +59 -0
  76. data/docs/frames.html +22 -0
  77. data/docs/index.html +276 -0
  78. data/docs/js/app.js +395 -0
  79. data/docs/js/full_list.js +244 -0
  80. data/docs/js/jquery.js +4 -0
  81. data/docs/method_list.html +1582 -0
  82. data/docs/top-level-namespace.html +110 -0
  83. data/exe/yamlint +7 -0
  84. data/lib/yamlint/cli.rb +162 -0
  85. data/lib/yamlint/config.rb +113 -0
  86. data/lib/yamlint/formatter.rb +140 -0
  87. data/lib/yamlint/linter.rb +130 -0
  88. data/lib/yamlint/models/lint_context.rb +43 -0
  89. data/lib/yamlint/models/problem.rb +44 -0
  90. data/lib/yamlint/models/token.rb +22 -0
  91. data/lib/yamlint/models.rb +9 -0
  92. data/lib/yamlint/output/base.rb +15 -0
  93. data/lib/yamlint/output/colored.rb +54 -0
  94. data/lib/yamlint/output/github.rb +20 -0
  95. data/lib/yamlint/output/parsable.rb +19 -0
  96. data/lib/yamlint/output/standard.rb +25 -0
  97. data/lib/yamlint/output.rb +26 -0
  98. data/lib/yamlint/parser/comment_extractor.rb +78 -0
  99. data/lib/yamlint/parser/line_parser.rb +30 -0
  100. data/lib/yamlint/parser/token_parser.rb +92 -0
  101. data/lib/yamlint/parser.rb +10 -0
  102. data/lib/yamlint/presets/default.rb +35 -0
  103. data/lib/yamlint/presets/relaxed.rb +34 -0
  104. data/lib/yamlint/presets.rb +19 -0
  105. data/lib/yamlint/rules/anchors.rb +133 -0
  106. data/lib/yamlint/rules/base.rb +102 -0
  107. data/lib/yamlint/rules/braces.rb +105 -0
  108. data/lib/yamlint/rules/brackets.rb +105 -0
  109. data/lib/yamlint/rules/colons.rb +73 -0
  110. data/lib/yamlint/rules/commas.rb +85 -0
  111. data/lib/yamlint/rules/comments.rb +77 -0
  112. data/lib/yamlint/rules/comments_indentation.rb +66 -0
  113. data/lib/yamlint/rules/document_end.rb +45 -0
  114. data/lib/yamlint/rules/document_start.rb +45 -0
  115. data/lib/yamlint/rules/empty_lines.rb +107 -0
  116. data/lib/yamlint/rules/empty_values.rb +43 -0
  117. data/lib/yamlint/rules/float_values.rb +67 -0
  118. data/lib/yamlint/rules/hyphens.rb +42 -0
  119. data/lib/yamlint/rules/indentation.rb +39 -0
  120. data/lib/yamlint/rules/key_duplicates.rb +127 -0
  121. data/lib/yamlint/rules/key_ordering.rb +126 -0
  122. data/lib/yamlint/rules/line_length.rb +57 -0
  123. data/lib/yamlint/rules/new_line_at_end_of_file.rb +31 -0
  124. data/lib/yamlint/rules/new_lines.rb +59 -0
  125. data/lib/yamlint/rules/octal_values.rb +62 -0
  126. data/lib/yamlint/rules/quoted_strings.rb +73 -0
  127. data/lib/yamlint/rules/registry.rb +48 -0
  128. data/lib/yamlint/rules/trailing_spaces.rb +31 -0
  129. data/lib/yamlint/rules/truthy.rb +48 -0
  130. data/lib/yamlint/rules.rb +41 -0
  131. data/lib/yamlint/runner.rb +80 -0
  132. data/lib/yamlint/version.rb +1 -1
  133. data/lib/yamlint.rb +11 -3
  134. metadata +131 -11
  135. data/CODE_OF_CONDUCT.md +0 -84
  136. data/sig/yamlint.rbs +0 -4
data/docs/Yamlint/Rules/CommentsIndentation.html ADDED
@@ -0,0 +1,328 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Yamlint::Rules::CommentsIndentation
8
+
9
+ &mdash; Documentation by YARD 0.9.38
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Yamlint::Rules::CommentsIndentation";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Yamlint.html" title="Yamlint (module)">Yamlint</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Rules.html" title="Yamlint::Rules (module)">Rules</a></span></span>
41
+ &raquo;
42
+ <span class="title">CommentsIndentation</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Yamlint::Rules::CommentsIndentation
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next">Yamlint::Rules::CommentsIndentation</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/yamlint/rules/comments_indentation.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary</h2>
111
+
112
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
113
+ <p class="inherited"><span class='object_link'><a href="Base.html#config-instance_method" title="Yamlint::Rules::Base#config (method)">#config</a></span>, <span class='object_link'><a href="Base.html#level-instance_method" title="Yamlint::Rules::Base#level (method)">#level</a></span></p>
114
+
115
+
116
+
117
+ <h2>
118
+ Instance Method Summary
119
+ <small><a href="#" class="summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#check-instance_method" title="#check (instance method)">#<strong>check</strong>(context) &#x21d2; Object </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'></div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#fixable%3F-instance_method" title="#fixable? (instance method)">#<strong>fixable?</strong> &#x21d2; Boolean </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'></div></span>
164
+
165
+ </li>
166
+
167
+
168
+ </ul>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
181
+ <p class="inherited"><span class='object_link'><a href="Base.html#defaults-class_method" title="Yamlint::Rules::Base.defaults (method)">defaults</a></span>, <span class='object_link'><a href="Base.html#desc-class_method" title="Yamlint::Rules::Base.desc (method)">desc</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="Yamlint::Rules::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="Yamlint::Rules::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#rule_id-class_method" title="Yamlint::Rules::Base.rule_id (method)">rule_id</a></span></p>
182
+ <div id="constructor_details" class="method_details_list">
183
+ <h2>Constructor Details</h2>
184
+
185
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Yamlint::Rules::Base#initialize (method)">Yamlint::Rules::Base</a></span></p>
186
+
187
+ </div>
188
+
189
+
190
+ <div id="instance_method_details" class="method_details_list">
191
+ <h2>Instance Method Details</h2>
192
+
193
+
194
+ <div class="method_details first">
195
+ <h3 class="signature first" id="check-instance_method">
196
+
197
+ #<strong>check</strong>(context) &#x21d2; <tt>Object</tt>
198
+
199
+
200
+
201
+
202
+
203
+ </h3><table class="source_code">
204
+ <tr>
205
+ <td>
206
+ <pre class="lines">
207
+
208
+
209
+ 10
210
+ 11
211
+ 12
212
+ 13
213
+ 14
214
+ 15
215
+ 16
216
+ 17
217
+ 18
218
+ 19
219
+ 20
220
+ 21
221
+ 22
222
+ 23
223
+ 24
224
+ 25
225
+ 26
226
+ 27
227
+ 28
228
+ 29
229
+ 30
230
+ 31
231
+ 32</pre>
232
+ </td>
233
+ <td>
234
+ <pre class="code"><span class="info file"># File 'lib/yamlint/rules/comments_indentation.rb', line 10</span>
235
+
236
+ <span class='kw'>def</span> <span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
237
+ <span class='id identifier rubyid_problems'>problems</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
238
+
239
+ <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
240
+ <span class='id identifier rubyid_line_number'>line_number</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span> <span class='op'>+</span> <span class='int'>1</span>
241
+
242
+ <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
243
+
244
+ <span class='id identifier rubyid_current_indent'>current_indent</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span><span class='lbracket'>[</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A *</span><span class='regexp_end'>/</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
245
+ <span class='id identifier rubyid_expected_indent'>expected_indent</span> <span class='op'>=</span> <span class='id identifier rubyid_expected_indent_for_comment'>expected_indent_for_comment</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
246
+
247
+ <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_expected_indent'>expected_indent</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_current_indent'>current_indent</span> <span class='op'>!=</span> <span class='id identifier rubyid_expected_indent'>expected_indent</span>
248
+
249
+ <span class='id identifier rubyid_problems'>problems</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_problem'>problem</span><span class='lparen'>(</span>
250
+ <span class='label'>line:</span> <span class='id identifier rubyid_line_number'>line_number</span><span class='comma'>,</span>
251
+ <span class='label'>column:</span> <span class='int'>1</span><span class='comma'>,</span>
252
+ <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>comment not indented correctly (expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_expected_indent'>expected_indent</span><span class='embexpr_end'>}</span><span class='tstring_content'>, found </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_indent'>current_indent</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
253
+ <span class='label'>fixable:</span> <span class='kw'>true</span>
254
+ <span class='rparen'>)</span>
255
+ <span class='kw'>end</span>
256
+
257
+ <span class='id identifier rubyid_problems'>problems</span>
258
+ <span class='kw'>end</span></pre>
259
+ </td>
260
+ </tr>
261
+ </table>
262
+ </div>
263
+
264
+ <div class="method_details ">
265
+ <h3 class="signature " id="fixable?-instance_method">
266
+
267
+ #<strong>fixable?</strong> &#x21d2; <tt>Boolean</tt>
268
+
269
+
270
+
271
+
272
+
273
+ </h3><div class="docstring">
274
+ <div class="discussion">
275
+
276
+
277
+ </div>
278
+ </div>
279
+ <div class="tags">
280
+
281
+ <p class="tag_title">Returns:</p>
282
+ <ul class="return">
283
+
284
+ <li>
285
+
286
+
287
+ <span class='type'>(<tt>Boolean</tt>)</span>
288
+
289
+
290
+
291
+ </li>
292
+
293
+ </ul>
294
+
295
+ </div><table class="source_code">
296
+ <tr>
297
+ <td>
298
+ <pre class="lines">
299
+
300
+
301
+ 34
302
+ 35
303
+ 36</pre>
304
+ </td>
305
+ <td>
306
+ <pre class="code"><span class="info file"># File 'lib/yamlint/rules/comments_indentation.rb', line 34</span>
307
+
308
+ <span class='kw'>def</span> <span class='id identifier rubyid_fixable?'>fixable?</span>
309
+ <span class='kw'>true</span>
310
+ <span class='kw'>end</span></pre>
311
+ </td>
312
+ </tr>
313
+ </table>
314
+ </div>
315
+
316
+ </div>
317
+
318
+ </div>
319
+
320
+ <div id="footer">
321
+ Generated on Sun Jan 25 08:00:08 2026 by
322
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
323
+ 0.9.38 (ruby-4.0.0).
324
+ </div>
325
+
326
+ </div>
327
+ </body>
328
+ </html>
data/docs/Yamlint/Rules/DocumentEnd.html ADDED
@@ -0,0 +1,332 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Yamlint::Rules::DocumentEnd
8
+
9
+ &mdash; Documentation by YARD 0.9.38
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Yamlint::Rules::DocumentEnd";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (D)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Yamlint.html" title="Yamlint (module)">Yamlint</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Rules.html" title="Yamlint::Rules (module)">Rules</a></span></span>
41
+ &raquo;
42
+ <span class="title">DocumentEnd</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Yamlint::Rules::DocumentEnd
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next">Yamlint::Rules::DocumentEnd</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/yamlint/rules/document_end.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary</h2>
111
+
112
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
113
+ <p class="inherited"><span class='object_link'><a href="Base.html#config-instance_method" title="Yamlint::Rules::Base#config (method)">#config</a></span>, <span class='object_link'><a href="Base.html#level-instance_method" title="Yamlint::Rules::Base#level (method)">#level</a></span></p>
114
+
115
+
116
+
117
+ <h2>
118
+ Instance Method Summary
119
+ <small><a href="#" class="summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#check-instance_method" title="#check (instance method)">#<strong>check</strong>(context) &#x21d2; Object </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'></div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#fixable%3F-instance_method" title="#fixable? (instance method)">#<strong>fixable?</strong> &#x21d2; Boolean </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'></div></span>
164
+
165
+ </li>
166
+
167
+
168
+ </ul>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
181
+ <p class="inherited"><span class='object_link'><a href="Base.html#defaults-class_method" title="Yamlint::Rules::Base.defaults (method)">defaults</a></span>, <span class='object_link'><a href="Base.html#desc-class_method" title="Yamlint::Rules::Base.desc (method)">desc</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="Yamlint::Rules::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="Yamlint::Rules::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#rule_id-class_method" title="Yamlint::Rules::Base.rule_id (method)">rule_id</a></span></p>
182
+ <div id="constructor_details" class="method_details_list">
183
+ <h2>Constructor Details</h2>
184
+
185
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Yamlint::Rules::Base#initialize (method)">Yamlint::Rules::Base</a></span></p>
186
+
187
+ </div>
188
+
189
+
190
+ <div id="instance_method_details" class="method_details_list">
191
+ <h2>Instance Method Details</h2>
192
+
193
+
194
+ <div class="method_details first">
195
+ <h3 class="signature first" id="check-instance_method">
196
+
197
+ #<strong>check</strong>(context) &#x21d2; <tt>Object</tt>
198
+
199
+
200
+
201
+
202
+
203
+ </h3><table class="source_code">
204
+ <tr>
205
+ <td>
206
+ <pre class="lines">
207
+
208
+
209
+ 12
210
+ 13
211
+ 14
212
+ 15
213
+ 16
214
+ 17
215
+ 18
216
+ 19
217
+ 20
218
+ 21
219
+ 22
220
+ 23
221
+ 24
222
+ 25
223
+ 26
224
+ 27
225
+ 28
226
+ 29
227
+ 30
228
+ 31
229
+ 32
230
+ 33
231
+ 34
232
+ 35
233
+ 36</pre>
234
+ </td>
235
+ <td>
236
+ <pre class="code"><span class="info file"># File 'lib/yamlint/rules/document_end.rb', line 12</span>
237
+
238
+ <span class='kw'>def</span> <span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
239
+ <span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
240
+
241
+ <span class='id identifier rubyid_has_end'>has_end</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>...</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
242
+ <span class='id identifier rubyid_required'>required</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:present</span><span class='rbracket'>]</span>
243
+
244
+ <span class='kw'>if</span> <span class='id identifier rubyid_required'>required</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_has_end'>has_end</span>
245
+ <span class='lbracket'>[</span><span class='id identifier rubyid_problem'>problem</span><span class='lparen'>(</span>
246
+ <span class='label'>line:</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_line_count'>line_count</span><span class='comma'>,</span>
247
+ <span class='label'>column:</span> <span class='int'>1</span><span class='comma'>,</span>
248
+ <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>missing document end &quot;...&quot;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
249
+ <span class='label'>fixable:</span> <span class='kw'>true</span>
250
+ <span class='rparen'>)</span><span class='rbracket'>]</span>
251
+ <span class='kw'>elsif</span> <span class='op'>!</span><span class='id identifier rubyid_required'>required</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_has_end'>has_end</span>
252
+ <span class='id identifier rubyid_line_number'>line_number</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>...</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span> <span class='op'>+</span> <span class='int'>1</span>
253
+ <span class='lbracket'>[</span><span class='id identifier rubyid_problem'>problem</span><span class='lparen'>(</span>
254
+ <span class='label'>line:</span> <span class='id identifier rubyid_line_number'>line_number</span><span class='comma'>,</span>
255
+ <span class='label'>column:</span> <span class='int'>1</span><span class='comma'>,</span>
256
+ <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>found forbidden document end &quot;...&quot;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
257
+ <span class='label'>fixable:</span> <span class='kw'>true</span>
258
+ <span class='rparen'>)</span><span class='rbracket'>]</span>
259
+ <span class='kw'>else</span>
260
+ <span class='lbracket'>[</span><span class='rbracket'>]</span>
261
+ <span class='kw'>end</span>
262
+ <span class='kw'>end</span></pre>
263
+ </td>
264
+ </tr>
265
+ </table>
266
+ </div>
267
+
268
+ <div class="method_details ">
269
+ <h3 class="signature " id="fixable?-instance_method">
270
+
271
+ #<strong>fixable?</strong> &#x21d2; <tt>Boolean</tt>
272
+
273
+
274
+
275
+
276
+
277
+ </h3><div class="docstring">
278
+ <div class="discussion">
279
+
280
+
281
+ </div>
282
+ </div>
283
+ <div class="tags">
284
+
285
+ <p class="tag_title">Returns:</p>
286
+ <ul class="return">
287
+
288
+ <li>
289
+
290
+
291
+ <span class='type'>(<tt>Boolean</tt>)</span>
292
+
293
+
294
+
295
+ </li>
296
+
297
+ </ul>
298
+
299
+ </div><table class="source_code">
300
+ <tr>
301
+ <td>
302
+ <pre class="lines">
303
+
304
+
305
+ 38
306
+ 39
307
+ 40</pre>
308
+ </td>
309
+ <td>
310
+ <pre class="code"><span class="info file"># File 'lib/yamlint/rules/document_end.rb', line 38</span>
311
+
312
+ <span class='kw'>def</span> <span class='id identifier rubyid_fixable?'>fixable?</span>
313
+ <span class='kw'>true</span>
314
+ <span class='kw'>end</span></pre>
315
+ </td>
316
+ </tr>
317
+ </table>
318
+ </div>
319
+
320
+ </div>
321
+
322
+ </div>
323
+
324
+ <div id="footer">
325
+ Generated on Sun Jan 25 08:00:08 2026 by
326
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
327
+ 0.9.38 (ruby-4.0.0).
328
+ </div>
329
+
330
+ </div>
331
+ </body>
332
+ </html>