yard-lint 0.2.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 +7 -0
- data/.coditsu/ci.yml +3 -0
- data/CHANGELOG.md +28 -0
- data/LICENSE.txt +21 -0
- data/README.md +454 -0
- data/bin/console +11 -0
- data/bin/setup +8 -0
- data/bin/yard-lint +109 -0
- data/lib/yard/lint/command_cache.rb +77 -0
- data/lib/yard/lint/config.rb +255 -0
- data/lib/yard/lint/config_loader.rb +198 -0
- data/lib/yard/lint/errors.rb +17 -0
- data/lib/yard/lint/formatters/progress.rb +50 -0
- data/lib/yard/lint/parsers/base.rb +23 -0
- data/lib/yard/lint/parsers/one_line_base.rb +35 -0
- data/lib/yard/lint/parsers/two_line_base.rb +45 -0
- data/lib/yard/lint/result_builder.rb +130 -0
- data/lib/yard/lint/results/aggregate.rb +86 -0
- data/lib/yard/lint/results/base.rb +156 -0
- data/lib/yard/lint/runner.rb +125 -0
- data/lib/yard/lint/validators/base.rb +120 -0
- data/lib/yard/lint/validators/config.rb +30 -0
- data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb +20 -0
- data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/parser.rb +43 -0
- data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/result.rb +26 -0
- data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/validator.rb +48 -0
- data/lib/yard/lint/validators/documentation/undocumented_boolean_methods.rb +13 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments/config.rb +20 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments/messages_builder.rb +24 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments/parser.rb +45 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments/result.rb +25 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments/validator.rb +55 -0
- data/lib/yard/lint/validators/documentation/undocumented_method_arguments.rb +13 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects/config.rb +21 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects/messages_builder.rb +23 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects/parser.rb +39 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects/result.rb +25 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects/validator.rb +39 -0
- data/lib/yard/lint/validators/documentation/undocumented_objects.rb +14 -0
- data/lib/yard/lint/validators/semantic/abstract_methods/config.rb +24 -0
- data/lib/yard/lint/validators/semantic/abstract_methods/messages_builder.rb +25 -0
- data/lib/yard/lint/validators/semantic/abstract_methods/parser.rb +45 -0
- data/lib/yard/lint/validators/semantic/abstract_methods/result.rb +42 -0
- data/lib/yard/lint/validators/semantic/abstract_methods/validator.rb +65 -0
- data/lib/yard/lint/validators/semantic/abstract_methods.rb +13 -0
- data/lib/yard/lint/validators/tags/api_tags/config.rb +21 -0
- data/lib/yard/lint/validators/tags/api_tags/messages_builder.rb +29 -0
- data/lib/yard/lint/validators/tags/api_tags/parser.rb +50 -0
- data/lib/yard/lint/validators/tags/api_tags/result.rb +42 -0
- data/lib/yard/lint/validators/tags/api_tags/validator.rb +69 -0
- data/lib/yard/lint/validators/tags/api_tags.rb +13 -0
- data/lib/yard/lint/validators/tags/invalid_types/config.rb +22 -0
- data/lib/yard/lint/validators/tags/invalid_types/messages_builder.rb +24 -0
- data/lib/yard/lint/validators/tags/invalid_types/parser.rb +16 -0
- data/lib/yard/lint/validators/tags/invalid_types/result.rb +25 -0
- data/lib/yard/lint/validators/tags/invalid_types/validator.rb +106 -0
- data/lib/yard/lint/validators/tags/invalid_types.rb +13 -0
- data/lib/yard/lint/validators/tags/option_tags/config.rb +21 -0
- data/lib/yard/lint/validators/tags/option_tags/messages_builder.rb +24 -0
- data/lib/yard/lint/validators/tags/option_tags/parser.rb +45 -0
- data/lib/yard/lint/validators/tags/option_tags/result.rb +42 -0
- data/lib/yard/lint/validators/tags/option_tags/validator.rb +61 -0
- data/lib/yard/lint/validators/tags/option_tags.rb +13 -0
- data/lib/yard/lint/validators/tags/order/config.rb +33 -0
- data/lib/yard/lint/validators/tags/order/messages_builder.rb +30 -0
- data/lib/yard/lint/validators/tags/order/parser.rb +66 -0
- data/lib/yard/lint/validators/tags/order/result.rb +26 -0
- data/lib/yard/lint/validators/tags/order/validator.rb +89 -0
- data/lib/yard/lint/validators/tags/order.rb +13 -0
- data/lib/yard/lint/validators/warnings/duplicated_parameter_name/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/duplicated_parameter_name/parser.rb +22 -0
- data/lib/yard/lint/validators/warnings/duplicated_parameter_name/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/duplicated_parameter_name/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/duplicated_parameter_name.rb +14 -0
- data/lib/yard/lint/validators/warnings/invalid_directive_format/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/invalid_directive_format/parser.rb +22 -0
- data/lib/yard/lint/validators/warnings/invalid_directive_format/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/invalid_directive_format/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/invalid_directive_format.rb +14 -0
- data/lib/yard/lint/validators/warnings/invalid_tag_format/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/invalid_tag_format/parser.rb +22 -0
- data/lib/yard/lint/validators/warnings/invalid_tag_format/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/invalid_tag_format/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/invalid_tag_format.rb +14 -0
- data/lib/yard/lint/validators/warnings/unknown_directive/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/unknown_directive/parser.rb +22 -0
- data/lib/yard/lint/validators/warnings/unknown_directive/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/unknown_directive/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/unknown_directive.rb +14 -0
- data/lib/yard/lint/validators/warnings/unknown_parameter_name/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/unknown_parameter_name/parser.rb +22 -0
- data/lib/yard/lint/validators/warnings/unknown_parameter_name/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/unknown_parameter_name/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/unknown_parameter_name.rb +14 -0
- data/lib/yard/lint/validators/warnings/unknown_tag/config.rb +22 -0
- data/lib/yard/lint/validators/warnings/unknown_tag/parser.rb +24 -0
- data/lib/yard/lint/validators/warnings/unknown_tag/result.rb +25 -0
- data/lib/yard/lint/validators/warnings/unknown_tag/validator.rb +33 -0
- data/lib/yard/lint/validators/warnings/unknown_tag.rb +14 -0
- data/lib/yard/lint/version.rb +8 -0
- data/lib/yard/lint.rb +76 -0
- data/lib/yard-lint.rb +11 -0
- data/renovate.json +22 -0
- metadata +178 -0
metadata
ADDED
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: yard-lint
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.2.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Maciej Mensfeld
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: yard
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '0.9'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '0.9'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: zeitwerk
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '2.6'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '2.6'
|
|
40
|
+
description: A comprehensive linter for YARD documentation that checks for undocumented
|
|
41
|
+
code, invalid tags, incorrect tag ordering, and more.
|
|
42
|
+
email:
|
|
43
|
+
- maciej@mensfeld.pl
|
|
44
|
+
executables:
|
|
45
|
+
- console
|
|
46
|
+
- setup
|
|
47
|
+
- yard-lint
|
|
48
|
+
extensions: []
|
|
49
|
+
extra_rdoc_files: []
|
|
50
|
+
files:
|
|
51
|
+
- ".coditsu/ci.yml"
|
|
52
|
+
- CHANGELOG.md
|
|
53
|
+
- LICENSE.txt
|
|
54
|
+
- README.md
|
|
55
|
+
- bin/console
|
|
56
|
+
- bin/setup
|
|
57
|
+
- bin/yard-lint
|
|
58
|
+
- lib/yard-lint.rb
|
|
59
|
+
- lib/yard/lint.rb
|
|
60
|
+
- lib/yard/lint/command_cache.rb
|
|
61
|
+
- lib/yard/lint/config.rb
|
|
62
|
+
- lib/yard/lint/config_loader.rb
|
|
63
|
+
- lib/yard/lint/errors.rb
|
|
64
|
+
- lib/yard/lint/formatters/progress.rb
|
|
65
|
+
- lib/yard/lint/parsers/base.rb
|
|
66
|
+
- lib/yard/lint/parsers/one_line_base.rb
|
|
67
|
+
- lib/yard/lint/parsers/two_line_base.rb
|
|
68
|
+
- lib/yard/lint/result_builder.rb
|
|
69
|
+
- lib/yard/lint/results/aggregate.rb
|
|
70
|
+
- lib/yard/lint/results/base.rb
|
|
71
|
+
- lib/yard/lint/runner.rb
|
|
72
|
+
- lib/yard/lint/validators/base.rb
|
|
73
|
+
- lib/yard/lint/validators/config.rb
|
|
74
|
+
- lib/yard/lint/validators/documentation/undocumented_boolean_methods.rb
|
|
75
|
+
- lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb
|
|
76
|
+
- lib/yard/lint/validators/documentation/undocumented_boolean_methods/parser.rb
|
|
77
|
+
- lib/yard/lint/validators/documentation/undocumented_boolean_methods/result.rb
|
|
78
|
+
- lib/yard/lint/validators/documentation/undocumented_boolean_methods/validator.rb
|
|
79
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments.rb
|
|
80
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments/config.rb
|
|
81
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments/messages_builder.rb
|
|
82
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments/parser.rb
|
|
83
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments/result.rb
|
|
84
|
+
- lib/yard/lint/validators/documentation/undocumented_method_arguments/validator.rb
|
|
85
|
+
- lib/yard/lint/validators/documentation/undocumented_objects.rb
|
|
86
|
+
- lib/yard/lint/validators/documentation/undocumented_objects/config.rb
|
|
87
|
+
- lib/yard/lint/validators/documentation/undocumented_objects/messages_builder.rb
|
|
88
|
+
- lib/yard/lint/validators/documentation/undocumented_objects/parser.rb
|
|
89
|
+
- lib/yard/lint/validators/documentation/undocumented_objects/result.rb
|
|
90
|
+
- lib/yard/lint/validators/documentation/undocumented_objects/validator.rb
|
|
91
|
+
- lib/yard/lint/validators/semantic/abstract_methods.rb
|
|
92
|
+
- lib/yard/lint/validators/semantic/abstract_methods/config.rb
|
|
93
|
+
- lib/yard/lint/validators/semantic/abstract_methods/messages_builder.rb
|
|
94
|
+
- lib/yard/lint/validators/semantic/abstract_methods/parser.rb
|
|
95
|
+
- lib/yard/lint/validators/semantic/abstract_methods/result.rb
|
|
96
|
+
- lib/yard/lint/validators/semantic/abstract_methods/validator.rb
|
|
97
|
+
- lib/yard/lint/validators/tags/api_tags.rb
|
|
98
|
+
- lib/yard/lint/validators/tags/api_tags/config.rb
|
|
99
|
+
- lib/yard/lint/validators/tags/api_tags/messages_builder.rb
|
|
100
|
+
- lib/yard/lint/validators/tags/api_tags/parser.rb
|
|
101
|
+
- lib/yard/lint/validators/tags/api_tags/result.rb
|
|
102
|
+
- lib/yard/lint/validators/tags/api_tags/validator.rb
|
|
103
|
+
- lib/yard/lint/validators/tags/invalid_types.rb
|
|
104
|
+
- lib/yard/lint/validators/tags/invalid_types/config.rb
|
|
105
|
+
- lib/yard/lint/validators/tags/invalid_types/messages_builder.rb
|
|
106
|
+
- lib/yard/lint/validators/tags/invalid_types/parser.rb
|
|
107
|
+
- lib/yard/lint/validators/tags/invalid_types/result.rb
|
|
108
|
+
- lib/yard/lint/validators/tags/invalid_types/validator.rb
|
|
109
|
+
- lib/yard/lint/validators/tags/option_tags.rb
|
|
110
|
+
- lib/yard/lint/validators/tags/option_tags/config.rb
|
|
111
|
+
- lib/yard/lint/validators/tags/option_tags/messages_builder.rb
|
|
112
|
+
- lib/yard/lint/validators/tags/option_tags/parser.rb
|
|
113
|
+
- lib/yard/lint/validators/tags/option_tags/result.rb
|
|
114
|
+
- lib/yard/lint/validators/tags/option_tags/validator.rb
|
|
115
|
+
- lib/yard/lint/validators/tags/order.rb
|
|
116
|
+
- lib/yard/lint/validators/tags/order/config.rb
|
|
117
|
+
- lib/yard/lint/validators/tags/order/messages_builder.rb
|
|
118
|
+
- lib/yard/lint/validators/tags/order/parser.rb
|
|
119
|
+
- lib/yard/lint/validators/tags/order/result.rb
|
|
120
|
+
- lib/yard/lint/validators/tags/order/validator.rb
|
|
121
|
+
- lib/yard/lint/validators/warnings/duplicated_parameter_name.rb
|
|
122
|
+
- lib/yard/lint/validators/warnings/duplicated_parameter_name/config.rb
|
|
123
|
+
- lib/yard/lint/validators/warnings/duplicated_parameter_name/parser.rb
|
|
124
|
+
- lib/yard/lint/validators/warnings/duplicated_parameter_name/result.rb
|
|
125
|
+
- lib/yard/lint/validators/warnings/duplicated_parameter_name/validator.rb
|
|
126
|
+
- lib/yard/lint/validators/warnings/invalid_directive_format.rb
|
|
127
|
+
- lib/yard/lint/validators/warnings/invalid_directive_format/config.rb
|
|
128
|
+
- lib/yard/lint/validators/warnings/invalid_directive_format/parser.rb
|
|
129
|
+
- lib/yard/lint/validators/warnings/invalid_directive_format/result.rb
|
|
130
|
+
- lib/yard/lint/validators/warnings/invalid_directive_format/validator.rb
|
|
131
|
+
- lib/yard/lint/validators/warnings/invalid_tag_format.rb
|
|
132
|
+
- lib/yard/lint/validators/warnings/invalid_tag_format/config.rb
|
|
133
|
+
- lib/yard/lint/validators/warnings/invalid_tag_format/parser.rb
|
|
134
|
+
- lib/yard/lint/validators/warnings/invalid_tag_format/result.rb
|
|
135
|
+
- lib/yard/lint/validators/warnings/invalid_tag_format/validator.rb
|
|
136
|
+
- lib/yard/lint/validators/warnings/unknown_directive.rb
|
|
137
|
+
- lib/yard/lint/validators/warnings/unknown_directive/config.rb
|
|
138
|
+
- lib/yard/lint/validators/warnings/unknown_directive/parser.rb
|
|
139
|
+
- lib/yard/lint/validators/warnings/unknown_directive/result.rb
|
|
140
|
+
- lib/yard/lint/validators/warnings/unknown_directive/validator.rb
|
|
141
|
+
- lib/yard/lint/validators/warnings/unknown_parameter_name.rb
|
|
142
|
+
- lib/yard/lint/validators/warnings/unknown_parameter_name/config.rb
|
|
143
|
+
- lib/yard/lint/validators/warnings/unknown_parameter_name/parser.rb
|
|
144
|
+
- lib/yard/lint/validators/warnings/unknown_parameter_name/result.rb
|
|
145
|
+
- lib/yard/lint/validators/warnings/unknown_parameter_name/validator.rb
|
|
146
|
+
- lib/yard/lint/validators/warnings/unknown_tag.rb
|
|
147
|
+
- lib/yard/lint/validators/warnings/unknown_tag/config.rb
|
|
148
|
+
- lib/yard/lint/validators/warnings/unknown_tag/parser.rb
|
|
149
|
+
- lib/yard/lint/validators/warnings/unknown_tag/result.rb
|
|
150
|
+
- lib/yard/lint/validators/warnings/unknown_tag/validator.rb
|
|
151
|
+
- lib/yard/lint/version.rb
|
|
152
|
+
- renovate.json
|
|
153
|
+
homepage: https://github.com/mensfeld/yard-lint
|
|
154
|
+
licenses:
|
|
155
|
+
- MIT
|
|
156
|
+
metadata:
|
|
157
|
+
homepage_uri: https://github.com/mensfeld/yard-lint
|
|
158
|
+
source_code_uri: https://github.com/mensfeld/yard-lint
|
|
159
|
+
changelog_uri: https://github.com/mensfeld/yard-lint/blob/master/CHANGELOG.md
|
|
160
|
+
rubygems_mfa_required: 'true'
|
|
161
|
+
rdoc_options: []
|
|
162
|
+
require_paths:
|
|
163
|
+
- lib
|
|
164
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
165
|
+
requirements:
|
|
166
|
+
- - ">="
|
|
167
|
+
- !ruby/object:Gem::Version
|
|
168
|
+
version: 3.2.0
|
|
169
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
170
|
+
requirements:
|
|
171
|
+
- - ">="
|
|
172
|
+
- !ruby/object:Gem::Version
|
|
173
|
+
version: '0'
|
|
174
|
+
requirements: []
|
|
175
|
+
rubygems_version: 3.6.9
|
|
176
|
+
specification_version: 4
|
|
177
|
+
summary: YARD documentation linter and validator
|
|
178
|
+
test_files: []
|