yard-lint 1.5.1 → 1.6.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 (72) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +51 -0
  3. data/README.md +207 -8
  4. data/bin/yard-lint +45 -11
  5. data/lib/yard/lint/executor/in_process_registry.rb +38 -12
  6. data/lib/yard/lint/results/base.rb +3 -0
  7. data/lib/yard/lint/runner.rb +11 -3
  8. data/lib/yard/lint/templates/default_config.yml +40 -0
  9. data/lib/yard/lint/templates/strict_config.yml +39 -0
  10. data/lib/yard/lint/todo_generator.rb +6 -4
  11. data/lib/yard/lint/validators/base.rb +125 -0
  12. data/lib/yard/lint/validators/documentation/line_length/config.rb +21 -0
  13. data/lib/yard/lint/validators/documentation/line_length/messages_builder.rb +26 -0
  14. data/lib/yard/lint/validators/documentation/line_length/parser.rb +65 -0
  15. data/lib/yard/lint/validators/documentation/line_length/result.rb +26 -0
  16. data/lib/yard/lint/validators/documentation/line_length/validator.rb +59 -0
  17. data/lib/yard/lint/validators/documentation/line_length.rb +43 -0
  18. data/lib/yard/lint/validators/documentation/missing_return/config.rb +2 -1
  19. data/lib/yard/lint/validators/documentation/missing_return/parser.rb +0 -1
  20. data/lib/yard/lint/validators/documentation/missing_return/validator.rb +1 -0
  21. data/lib/yard/lint/validators/documentation/orphaned_doc_comment/config.rb +20 -0
  22. data/lib/yard/lint/validators/documentation/orphaned_doc_comment/messages_builder.rb +23 -0
  23. data/lib/yard/lint/validators/documentation/orphaned_doc_comment/parser.rb +38 -0
  24. data/lib/yard/lint/validators/documentation/orphaned_doc_comment/result.rb +24 -0
  25. data/lib/yard/lint/validators/documentation/orphaned_doc_comment/validator.rb +121 -0
  26. data/lib/yard/lint/validators/documentation/orphaned_doc_comment.rb +53 -0
  27. data/lib/yard/lint/validators/documentation/text_substitution/config.rb +24 -0
  28. data/lib/yard/lint/validators/documentation/text_substitution/messages_builder.rb +33 -0
  29. data/lib/yard/lint/validators/documentation/text_substitution/parser.rb +57 -0
  30. data/lib/yard/lint/validators/documentation/text_substitution/result.rb +24 -0
  31. data/lib/yard/lint/validators/documentation/text_substitution/validator.rb +72 -0
  32. data/lib/yard/lint/validators/documentation/text_substitution.rb +55 -0
  33. data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb +2 -1
  34. data/lib/yard/lint/validators/documentation/undocumented_boolean_methods/validator.rb +1 -0
  35. data/lib/yard/lint/validators/documentation/undocumented_method_arguments/config.rb +3 -1
  36. data/lib/yard/lint/validators/documentation/undocumented_method_arguments/validator.rb +3 -1
  37. data/lib/yard/lint/validators/documentation/undocumented_method_arguments.rb +1 -2
  38. data/lib/yard/lint/validators/documentation/undocumented_objects/config.rb +2 -1
  39. data/lib/yard/lint/validators/documentation/undocumented_objects/validator.rb +1 -0
  40. data/lib/yard/lint/validators/documentation/undocumented_options/config.rb +2 -1
  41. data/lib/yard/lint/validators/documentation/undocumented_options/validator.rb +1 -0
  42. data/lib/yard/lint/validators/documentation/undocumented_options.rb +1 -2
  43. data/lib/yard/lint/validators/tags/api_tags/result.rb +1 -0
  44. data/lib/yard/lint/validators/tags/api_tags/validator.rb +12 -0
  45. data/lib/yard/lint/validators/tags/collection_type/config.rb +1 -1
  46. data/lib/yard/lint/validators/tags/collection_type/validator.rb +1 -3
  47. data/lib/yard/lint/validators/tags/example_style/result.rb +1 -0
  48. data/lib/yard/lint/validators/tags/example_syntax/result.rb +1 -0
  49. data/lib/yard/lint/validators/tags/invalid_types/config.rb +1 -1
  50. data/lib/yard/lint/validators/tags/invalid_types/messages_builder.rb +14 -3
  51. data/lib/yard/lint/validators/tags/invalid_types/parser.rb +63 -3
  52. data/lib/yard/lint/validators/tags/invalid_types/validator.rb +31 -16
  53. data/lib/yard/lint/validators/tags/meaningless_tag/validator.rb +16 -1
  54. data/lib/yard/lint/validators/tags/missing_yield/config.rb +20 -0
  55. data/lib/yard/lint/validators/tags/missing_yield/messages_builder.rb +22 -0
  56. data/lib/yard/lint/validators/tags/missing_yield/parser.rb +39 -0
  57. data/lib/yard/lint/validators/tags/missing_yield/result.rb +24 -0
  58. data/lib/yard/lint/validators/tags/missing_yield/validator.rb +76 -0
  59. data/lib/yard/lint/validators/tags/missing_yield.rb +56 -0
  60. data/lib/yard/lint/validators/tags/non_ascii_type/config.rb +1 -1
  61. data/lib/yard/lint/validators/tags/non_ascii_type/validator.rb +1 -3
  62. data/lib/yard/lint/validators/tags/redundant_param_description/validator.rb +4 -2
  63. data/lib/yard/lint/validators/tags/redundant_param_description.rb +2 -1
  64. data/lib/yard/lint/validators/tags/type_syntax/config.rb +1 -1
  65. data/lib/yard/lint/validators/tags/type_syntax/validator.rb +1 -3
  66. data/lib/yard/lint/validators/tags/type_syntax.rb +1 -2
  67. data/lib/yard/lint/validators/warnings/duplicated_parameter_name/parser.rb +4 -4
  68. data/lib/yard/lint/validators/warnings/duplicated_parameter_name.rb +1 -2
  69. data/lib/yard/lint/validators/warnings/invalid_directive_format.rb +1 -2
  70. data/lib/yard/lint/version.rb +1 -1
  71. data/lib/yard/lint.rb +14 -4
  72. metadata +26 -2
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-lint
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.1
4
+ version: 1.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Maciej Mensfeld
@@ -91,6 +91,12 @@ files:
91
91
  - lib/yard/lint/validators/documentation/empty_comment_line/parser.rb
92
92
  - lib/yard/lint/validators/documentation/empty_comment_line/result.rb
93
93
  - lib/yard/lint/validators/documentation/empty_comment_line/validator.rb
94
+ - lib/yard/lint/validators/documentation/line_length.rb
95
+ - lib/yard/lint/validators/documentation/line_length/config.rb
96
+ - lib/yard/lint/validators/documentation/line_length/messages_builder.rb
97
+ - lib/yard/lint/validators/documentation/line_length/parser.rb
98
+ - lib/yard/lint/validators/documentation/line_length/result.rb
99
+ - lib/yard/lint/validators/documentation/line_length/validator.rb
94
100
  - lib/yard/lint/validators/documentation/markdown_syntax.rb
95
101
  - lib/yard/lint/validators/documentation/markdown_syntax/config.rb
96
102
  - lib/yard/lint/validators/documentation/markdown_syntax/messages_builder.rb
@@ -103,6 +109,18 @@ files:
103
109
  - lib/yard/lint/validators/documentation/missing_return/parser.rb
104
110
  - lib/yard/lint/validators/documentation/missing_return/result.rb
105
111
  - lib/yard/lint/validators/documentation/missing_return/validator.rb
112
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment.rb
113
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment/config.rb
114
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment/messages_builder.rb
115
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment/parser.rb
116
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment/result.rb
117
+ - lib/yard/lint/validators/documentation/orphaned_doc_comment/validator.rb
118
+ - lib/yard/lint/validators/documentation/text_substitution.rb
119
+ - lib/yard/lint/validators/documentation/text_substitution/config.rb
120
+ - lib/yard/lint/validators/documentation/text_substitution/messages_builder.rb
121
+ - lib/yard/lint/validators/documentation/text_substitution/parser.rb
122
+ - lib/yard/lint/validators/documentation/text_substitution/result.rb
123
+ - lib/yard/lint/validators/documentation/text_substitution/validator.rb
106
124
  - lib/yard/lint/validators/documentation/undocumented_boolean_methods.rb
107
125
  - lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb
108
126
  - lib/yard/lint/validators/documentation/undocumented_boolean_methods/parser.rb
@@ -181,6 +199,12 @@ files:
181
199
  - lib/yard/lint/validators/tags/meaningless_tag/parser.rb
182
200
  - lib/yard/lint/validators/tags/meaningless_tag/result.rb
183
201
  - lib/yard/lint/validators/tags/meaningless_tag/validator.rb
202
+ - lib/yard/lint/validators/tags/missing_yield.rb
203
+ - lib/yard/lint/validators/tags/missing_yield/config.rb
204
+ - lib/yard/lint/validators/tags/missing_yield/messages_builder.rb
205
+ - lib/yard/lint/validators/tags/missing_yield/parser.rb
206
+ - lib/yard/lint/validators/tags/missing_yield/result.rb
207
+ - lib/yard/lint/validators/tags/missing_yield/validator.rb
184
208
  - lib/yard/lint/validators/tags/non_ascii_type.rb
185
209
  - lib/yard/lint/validators/tags/non_ascii_type/config.rb
186
210
  - lib/yard/lint/validators/tags/non_ascii_type/messages_builder.rb
@@ -278,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
278
302
  - !ruby/object:Gem::Version
279
303
  version: '0'
280
304
  requirements: []
281
- rubygems_version: 4.0.6
305
+ rubygems_version: 4.0.10
282
306
  specification_version: 4
283
307
  summary: YARD documentation linter and validator
284
308
  test_files: []