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.
- checksums.yaml +4 -4
- data/.rubocop.yml +31 -9
- data/.serena/.gitignore +1 -0
- data/.serena/memories/project_overview.md +25 -0
- data/.serena/memories/style_and_conventions.md +7 -0
- data/.serena/memories/suggested_commands.md +17 -0
- data/.serena/memories/task_completion.md +5 -0
- data/.serena/project.yml +89 -0
- data/CHANGELOG.md +6 -2
- data/Gemfile +9 -7
- data/LICENSE.txt +1 -1
- data/README.md +155 -17
- data/Rakefile +10 -3
- data/docs/Yamlint/Cli.html +403 -0
- data/docs/Yamlint/Config.html +1034 -0
- data/docs/Yamlint/Formatter.html +433 -0
- data/docs/Yamlint/Linter.html +423 -0
- data/docs/Yamlint/Models/LintContext.html +993 -0
- data/docs/Yamlint/Models/Problem.html +951 -0
- data/docs/Yamlint/Models/Token.html +713 -0
- data/docs/Yamlint/Models.html +117 -0
- data/docs/Yamlint/Output/Base.html +290 -0
- data/docs/Yamlint/Output/Colored.html +293 -0
- data/docs/Yamlint/Output/Github.html +260 -0
- data/docs/Yamlint/Output/Parsable.html +258 -0
- data/docs/Yamlint/Output/Standard.html +270 -0
- data/docs/Yamlint/Output.html +208 -0
- data/docs/Yamlint/Parser/Comment.html +795 -0
- data/docs/Yamlint/Parser/CommentExtractor.html +287 -0
- data/docs/Yamlint/Parser/LineParser.html +423 -0
- data/docs/Yamlint/Parser/TokenParser/Handler.html +910 -0
- data/docs/Yamlint/Parser/TokenParser.html +291 -0
- data/docs/Yamlint/Parser.html +117 -0
- data/docs/Yamlint/Presets.html +266 -0
- data/docs/Yamlint/Rules/Anchors/AnchorHandler.html +678 -0
- data/docs/Yamlint/Rules/Anchors.html +314 -0
- data/docs/Yamlint/Rules/Base.html +968 -0
- data/docs/Yamlint/Rules/Braces.html +335 -0
- data/docs/Yamlint/Rules/Brackets.html +335 -0
- data/docs/Yamlint/Rules/Colons.html +313 -0
- data/docs/Yamlint/Rules/Commas.html +313 -0
- data/docs/Yamlint/Rules/CommentRule.html +298 -0
- data/docs/Yamlint/Rules/Comments.html +317 -0
- data/docs/Yamlint/Rules/CommentsIndentation.html +328 -0
- data/docs/Yamlint/Rules/DocumentEnd.html +332 -0
- data/docs/Yamlint/Rules/DocumentStart.html +332 -0
- data/docs/Yamlint/Rules/EmptyLines.html +300 -0
- data/docs/Yamlint/Rules/EmptyValues.html +273 -0
- data/docs/Yamlint/Rules/FloatValues.html +383 -0
- data/docs/Yamlint/Rules/Hyphens.html +337 -0
- data/docs/Yamlint/Rules/Indentation.html +329 -0
- data/docs/Yamlint/Rules/KeyDuplicates/DuplicateKeyHandler.html +716 -0
- data/docs/Yamlint/Rules/KeyDuplicates.html +258 -0
- data/docs/Yamlint/Rules/KeyOrdering/KeyOrderHandler.html +694 -0
- data/docs/Yamlint/Rules/KeyOrdering.html +258 -0
- data/docs/Yamlint/Rules/LineLength.html +251 -0
- data/docs/Yamlint/Rules/LineRule.html +304 -0
- data/docs/Yamlint/Rules/NewLineAtEndOfFile.html +308 -0
- data/docs/Yamlint/Rules/NewLines.html +310 -0
- data/docs/Yamlint/Rules/OctalValues.html +270 -0
- data/docs/Yamlint/Rules/QuotedStrings.html +381 -0
- data/docs/Yamlint/Rules/Registry.html +492 -0
- data/docs/Yamlint/Rules/TokenRule.html +298 -0
- data/docs/Yamlint/Rules/TrailingSpaces.html +321 -0
- data/docs/Yamlint/Rules/Truthy.html +288 -0
- data/docs/Yamlint/Rules.html +190 -0
- data/docs/Yamlint/Runner.html +551 -0
- data/docs/Yamlint.html +135 -0
- data/docs/_index.html +643 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +490 -0
- data/docs/file.README.html +276 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +276 -0
- data/docs/js/app.js +395 -0
- data/docs/js/full_list.js +244 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1582 -0
- data/docs/top-level-namespace.html +110 -0
- data/exe/yamlint +7 -0
- data/lib/yamlint/cli.rb +162 -0
- data/lib/yamlint/config.rb +113 -0
- data/lib/yamlint/formatter.rb +140 -0
- data/lib/yamlint/linter.rb +130 -0
- data/lib/yamlint/models/lint_context.rb +43 -0
- data/lib/yamlint/models/problem.rb +44 -0
- data/lib/yamlint/models/token.rb +22 -0
- data/lib/yamlint/models.rb +9 -0
- data/lib/yamlint/output/base.rb +15 -0
- data/lib/yamlint/output/colored.rb +54 -0
- data/lib/yamlint/output/github.rb +20 -0
- data/lib/yamlint/output/parsable.rb +19 -0
- data/lib/yamlint/output/standard.rb +25 -0
- data/lib/yamlint/output.rb +26 -0
- data/lib/yamlint/parser/comment_extractor.rb +78 -0
- data/lib/yamlint/parser/line_parser.rb +30 -0
- data/lib/yamlint/parser/token_parser.rb +92 -0
- data/lib/yamlint/parser.rb +10 -0
- data/lib/yamlint/presets/default.rb +35 -0
- data/lib/yamlint/presets/relaxed.rb +34 -0
- data/lib/yamlint/presets.rb +19 -0
- data/lib/yamlint/rules/anchors.rb +133 -0
- data/lib/yamlint/rules/base.rb +102 -0
- data/lib/yamlint/rules/braces.rb +105 -0
- data/lib/yamlint/rules/brackets.rb +105 -0
- data/lib/yamlint/rules/colons.rb +73 -0
- data/lib/yamlint/rules/commas.rb +85 -0
- data/lib/yamlint/rules/comments.rb +77 -0
- data/lib/yamlint/rules/comments_indentation.rb +66 -0
- data/lib/yamlint/rules/document_end.rb +45 -0
- data/lib/yamlint/rules/document_start.rb +45 -0
- data/lib/yamlint/rules/empty_lines.rb +107 -0
- data/lib/yamlint/rules/empty_values.rb +43 -0
- data/lib/yamlint/rules/float_values.rb +67 -0
- data/lib/yamlint/rules/hyphens.rb +42 -0
- data/lib/yamlint/rules/indentation.rb +39 -0
- data/lib/yamlint/rules/key_duplicates.rb +127 -0
- data/lib/yamlint/rules/key_ordering.rb +126 -0
- data/lib/yamlint/rules/line_length.rb +57 -0
- data/lib/yamlint/rules/new_line_at_end_of_file.rb +31 -0
- data/lib/yamlint/rules/new_lines.rb +59 -0
- data/lib/yamlint/rules/octal_values.rb +62 -0
- data/lib/yamlint/rules/quoted_strings.rb +73 -0
- data/lib/yamlint/rules/registry.rb +48 -0
- data/lib/yamlint/rules/trailing_spaces.rb +31 -0
- data/lib/yamlint/rules/truthy.rb +48 -0
- data/lib/yamlint/rules.rb +41 -0
- data/lib/yamlint/runner.rb +80 -0
- data/lib/yamlint/version.rb +1 -1
- data/lib/yamlint.rb +11 -3
- metadata +131 -11
- data/CODE_OF_CONDUCT.md +0 -84
- data/sig/yamlint.rbs +0 -4
|
@@ -0,0 +1,304 @@
|
|
|
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::LineRule
|
|
8
|
+
|
|
9
|
+
— 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::LineRule";
|
|
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 (L)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Yamlint.html" title="Yamlint (module)">Yamlint</a></span></span> » <span class='title'><span class='object_link'><a href="../Rules.html" title="Yamlint::Rules (module)">Rules</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">LineRule</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::LineRule
|
|
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::LineRule</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/base.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<div id="subclasses">
|
|
105
|
+
<h2>Direct Known Subclasses</h2>
|
|
106
|
+
<p class="children"><span class='object_link'><a href="Braces.html" title="Yamlint::Rules::Braces (class)">Braces</a></span>, <span class='object_link'><a href="Brackets.html" title="Yamlint::Rules::Brackets (class)">Brackets</a></span>, <span class='object_link'><a href="Colons.html" title="Yamlint::Rules::Colons (class)">Colons</a></span>, <span class='object_link'><a href="Commas.html" title="Yamlint::Rules::Commas (class)">Commas</a></span>, <span class='object_link'><a href="Comments.html" title="Yamlint::Rules::Comments (class)">Comments</a></span>, <span class='object_link'><a href="EmptyValues.html" title="Yamlint::Rules::EmptyValues (class)">EmptyValues</a></span>, <span class='object_link'><a href="FloatValues.html" title="Yamlint::Rules::FloatValues (class)">FloatValues</a></span>, <span class='object_link'><a href="Hyphens.html" title="Yamlint::Rules::Hyphens (class)">Hyphens</a></span>, <span class='object_link'><a href="Indentation.html" title="Yamlint::Rules::Indentation (class)">Indentation</a></span>, <span class='object_link'><a href="LineLength.html" title="Yamlint::Rules::LineLength (class)">LineLength</a></span>, <span class='object_link'><a href="OctalValues.html" title="Yamlint::Rules::OctalValues (class)">OctalValues</a></span>, <span class='object_link'><a href="QuotedStrings.html" title="Yamlint::Rules::QuotedStrings (class)">QuotedStrings</a></span>, <span class='object_link'><a href="TrailingSpaces.html" title="Yamlint::Rules::TrailingSpaces (class)">TrailingSpaces</a></span>, <span class='object_link'><a href="Truthy.html" title="Yamlint::Rules::Truthy (class)">Truthy</a></span></p>
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<h2>Instance Attribute Summary</h2>
|
|
115
|
+
|
|
116
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
|
|
117
|
+
<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>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>
|
|
122
|
+
Instance Method Summary
|
|
123
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
124
|
+
</h2>
|
|
125
|
+
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#check-instance_method" title="#check (instance method)">#<strong>check</strong>(context) ⇒ Object </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
146
|
+
|
|
147
|
+
</li>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<li class="public ">
|
|
151
|
+
<span class="summary_signature">
|
|
152
|
+
|
|
153
|
+
<a href="#check_line-instance_method" title="#check_line (instance method)">#<strong>check_line</strong>(_line, _line_number, _context) ⇒ Object </a>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</span>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
168
|
+
|
|
169
|
+
</li>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</ul>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Yamlint::Rules::Base (class)">Base</a></span></h3>
|
|
185
|
+
<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#fixable%3F-instance_method" title="Yamlint::Rules::Base#fixable? (method)">#fixable?</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>
|
|
186
|
+
<div id="constructor_details" class="method_details_list">
|
|
187
|
+
<h2>Constructor Details</h2>
|
|
188
|
+
|
|
189
|
+
<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>
|
|
190
|
+
|
|
191
|
+
</div>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<div id="instance_method_details" class="method_details_list">
|
|
195
|
+
<h2>Instance Method Details</h2>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<div class="method_details first">
|
|
199
|
+
<h3 class="signature first" id="check-instance_method">
|
|
200
|
+
|
|
201
|
+
#<strong>check</strong>(context) ⇒ <tt>Object</tt>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</h3><table class="source_code">
|
|
208
|
+
<tr>
|
|
209
|
+
<td>
|
|
210
|
+
<pre class="lines">
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
57
|
|
214
|
+
58
|
|
215
|
+
59
|
|
216
|
+
60
|
|
217
|
+
61
|
|
218
|
+
62
|
|
219
|
+
63
|
|
220
|
+
64
|
|
221
|
+
65</pre>
|
|
222
|
+
</td>
|
|
223
|
+
<td>
|
|
224
|
+
<pre class="code"><span class="info file"># File 'lib/yamlint/rules/base.rb', line 57</span>
|
|
225
|
+
|
|
226
|
+
<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>
|
|
227
|
+
<span class='id identifier rubyid_problems'>problems</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
228
|
+
<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>
|
|
229
|
+
<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>
|
|
230
|
+
<span class='id identifier rubyid_line_problems'>line_problems</span> <span class='op'>=</span> <span class='id identifier rubyid_check_line'>check_line</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='id identifier rubyid_line_number'>line_number</span><span class='comma'>,</span> <span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
|
|
231
|
+
<span class='id identifier rubyid_problems'>problems</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_line_problems'>line_problems</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
232
|
+
<span class='kw'>end</span>
|
|
233
|
+
<span class='id identifier rubyid_problems'>problems</span>
|
|
234
|
+
<span class='kw'>end</span></pre>
|
|
235
|
+
</td>
|
|
236
|
+
</tr>
|
|
237
|
+
</table>
|
|
238
|
+
</div>
|
|
239
|
+
|
|
240
|
+
<div class="method_details ">
|
|
241
|
+
<h3 class="signature " id="check_line-instance_method">
|
|
242
|
+
|
|
243
|
+
#<strong>check_line</strong>(_line, _line_number, _context) ⇒ <tt>Object</tt>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</h3><div class="docstring">
|
|
250
|
+
<div class="discussion">
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</div>
|
|
254
|
+
</div>
|
|
255
|
+
<div class="tags">
|
|
256
|
+
|
|
257
|
+
<p class="tag_title">Raises:</p>
|
|
258
|
+
<ul class="raise">
|
|
259
|
+
|
|
260
|
+
<li>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<span class='type'>(<tt>NotImplementedError</tt>)</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</li>
|
|
268
|
+
|
|
269
|
+
</ul>
|
|
270
|
+
|
|
271
|
+
</div><table class="source_code">
|
|
272
|
+
<tr>
|
|
273
|
+
<td>
|
|
274
|
+
<pre class="lines">
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
67
|
|
278
|
+
68
|
|
279
|
+
69</pre>
|
|
280
|
+
</td>
|
|
281
|
+
<td>
|
|
282
|
+
<pre class="code"><span class="info file"># File 'lib/yamlint/rules/base.rb', line 67</span>
|
|
283
|
+
|
|
284
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_line'>check_line</span><span class='lparen'>(</span><span class='id identifier rubyid__line'>_line</span><span class='comma'>,</span> <span class='id identifier rubyid__line_number'>_line_number</span><span class='comma'>,</span> <span class='id identifier rubyid__context'>_context</span><span class='rparen'>)</span>
|
|
285
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>#check_line must be implemented</span><span class='tstring_end'>"</span></span>
|
|
286
|
+
<span class='kw'>end</span></pre>
|
|
287
|
+
</td>
|
|
288
|
+
</tr>
|
|
289
|
+
</table>
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
<div id="footer">
|
|
297
|
+
Generated on Sun Jan 25 08:00:08 2026 by
|
|
298
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
299
|
+
0.9.38 (ruby-4.0.0).
|
|
300
|
+
</div>
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
</body>
|
|
304
|
+
</html>
|
|
@@ -0,0 +1,308 @@
|
|
|
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::NewLineAtEndOfFile
|
|
8
|
+
|
|
9
|
+
— 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::NewLineAtEndOfFile";
|
|
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 (N)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Yamlint.html" title="Yamlint (module)">Yamlint</a></span></span> » <span class='title'><span class='object_link'><a href="../Rules.html" title="Yamlint::Rules (module)">Rules</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">NewLineAtEndOfFile</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::NewLineAtEndOfFile
|
|
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::NewLineAtEndOfFile</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/new_line_at_end_of_file.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) ⇒ 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> ⇒ 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) ⇒ <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</pre>
|
|
222
|
+
</td>
|
|
223
|
+
<td>
|
|
224
|
+
<pre class="code"><span class="info file"># File 'lib/yamlint/rules/new_line_at_end_of_file.rb', line 10</span>
|
|
225
|
+
|
|
226
|
+
<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>
|
|
227
|
+
<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>
|
|
228
|
+
|
|
229
|
+
<span class='id identifier rubyid_last_char'>last_char</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
|
|
230
|
+
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_last_char'>last_char</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
|
231
|
+
|
|
232
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_problem'>problem</span><span class='lparen'>(</span>
|
|
233
|
+
<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>
|
|
234
|
+
<span class='label'>column:</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='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='op'>&.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>||</span> <span class='int'>0</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='int'>1</span><span class='comma'>,</span>
|
|
235
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>no new line character at the end of file</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
236
|
+
<span class='label'>fixable:</span> <span class='kw'>true</span>
|
|
237
|
+
<span class='rparen'>)</span><span class='rbracket'>]</span>
|
|
238
|
+
<span class='kw'>end</span></pre>
|
|
239
|
+
</td>
|
|
240
|
+
</tr>
|
|
241
|
+
</table>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
<div class="method_details ">
|
|
245
|
+
<h3 class="signature " id="fixable?-instance_method">
|
|
246
|
+
|
|
247
|
+
#<strong>fixable?</strong> ⇒ <tt>Boolean</tt>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</h3><div class="docstring">
|
|
254
|
+
<div class="discussion">
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</div>
|
|
258
|
+
</div>
|
|
259
|
+
<div class="tags">
|
|
260
|
+
|
|
261
|
+
<p class="tag_title">Returns:</p>
|
|
262
|
+
<ul class="return">
|
|
263
|
+
|
|
264
|
+
<li>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
</ul>
|
|
274
|
+
|
|
275
|
+
</div><table class="source_code">
|
|
276
|
+
<tr>
|
|
277
|
+
<td>
|
|
278
|
+
<pre class="lines">
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
24
|
|
282
|
+
25
|
|
283
|
+
26</pre>
|
|
284
|
+
</td>
|
|
285
|
+
<td>
|
|
286
|
+
<pre class="code"><span class="info file"># File 'lib/yamlint/rules/new_line_at_end_of_file.rb', line 24</span>
|
|
287
|
+
|
|
288
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_fixable?'>fixable?</span>
|
|
289
|
+
<span class='kw'>true</span>
|
|
290
|
+
<span class='kw'>end</span></pre>
|
|
291
|
+
</td>
|
|
292
|
+
</tr>
|
|
293
|
+
</table>
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
<div id="footer">
|
|
301
|
+
Generated on Sun Jan 25 08:00:08 2026 by
|
|
302
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
303
|
+
0.9.38 (ruby-4.0.0).
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
</body>
|
|
308
|
+
</html>
|