rubocop-prose 0.1.0 → 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.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/AGENTS.md +10 -2
  3. data/CHANGELOG.md +20 -0
  4. data/CONTRIBUTING.md +17 -7
  5. data/DESIGN.md +13 -5
  6. data/README.md +37 -20
  7. data/RELEASING.md +8 -8
  8. data/UPGRADING.md +16 -0
  9. data/assets/README.md +1 -1
  10. data/config/cops/markdown/code_block_style.yml +1 -1
  11. data/config/cops/markdown/emphasis_style.yml +4 -0
  12. data/config/cops/markdown/fence_style.yml +1 -1
  13. data/config/cops/markdown/first_heading.yml +1 -2
  14. data/config/cops/markdown/front_matter_keys.yml +5 -0
  15. data/config/cops/markdown/front_matter_syntax.yml +3 -0
  16. data/config/cops/markdown/hard_break_style.yml +3 -0
  17. data/config/cops/markdown/hard_tabs.yml +1 -1
  18. data/config/cops/markdown/heading_capitalization.yml +31 -0
  19. data/config/cops/markdown/heading_style.yml +1 -1
  20. data/config/cops/markdown/{syntax.yml → kramdown_syntax.yml} +1 -1
  21. data/config/cops/markdown/list_item_capitalization.yml +32 -0
  22. data/config/cops/markdown/list_item_punctuation.yml +13 -0
  23. data/config/cops/markdown/list_marker_spacing.yml +6 -5
  24. data/config/cops/markdown/ordered_list_numbering.yml +1 -1
  25. data/config/cops/markdown/reference_definitions.yml +2 -3
  26. data/config/cops/markdown/strong_style.yml +4 -0
  27. data/config/cops/markdown/structural_line_length.yml +1 -4
  28. data/config/cops/markdown/table_pipes.yml +6 -0
  29. data/config/cops/markdown/table_spacing.yml +4 -0
  30. data/config/cops/markdown/trailing_whitespace.yml +1 -0
  31. data/config/cops/markdown/unordered_list_marker.yml +1 -1
  32. data/config/cops/prose/sentence_capitalization.yml +9 -0
  33. data/config/cops/text/hard_tabs.yml +3 -0
  34. data/config/cops/text/proper_names.yml +4 -0
  35. data/config/obsoletion.yml +45 -0
  36. data/docs/cops/markdown/blockquote_spacing.md +2 -0
  37. data/docs/cops/markdown/code_block_style.md +11 -2
  38. data/docs/cops/markdown/duplicate_headings.md +51 -0
  39. data/docs/cops/markdown/emphasis_style.md +5 -1
  40. data/docs/cops/markdown/fence_style.md +11 -2
  41. data/docs/cops/markdown/first_heading.md +29 -3
  42. data/docs/cops/markdown/front_matter_keys.md +57 -0
  43. data/docs/cops/markdown/front_matter_syntax.md +32 -0
  44. data/docs/cops/markdown/hard_break_style.md +10 -5
  45. data/docs/cops/markdown/hard_tabs.md +3 -3
  46. data/docs/cops/markdown/heading_capitalization.md +176 -0
  47. data/docs/cops/markdown/heading_style.md +11 -2
  48. data/docs/cops/markdown/{syntax.md → kramdown_syntax.md} +6 -2
  49. data/docs/cops/markdown/list_item_capitalization.md +115 -0
  50. data/docs/cops/markdown/list_item_punctuation.md +70 -0
  51. data/docs/cops/markdown/list_marker_spacing.md +57 -7
  52. data/docs/cops/markdown/ordered_list_numbering.md +10 -1
  53. data/docs/cops/markdown/proper_names.md +3 -3
  54. data/docs/cops/markdown/raw_html.md +99 -6
  55. data/docs/cops/markdown/reference_definitions.md +30 -4
  56. data/docs/cops/markdown/strong_style.md +5 -1
  57. data/docs/cops/markdown/structural_line_length.md +31 -7
  58. data/docs/cops/markdown/table_pipes.md +7 -1
  59. data/docs/cops/markdown/table_spacing.md +5 -1
  60. data/docs/cops/markdown/thematic_break_style.md +2 -0
  61. data/docs/cops/markdown/trailing_whitespace.md +29 -0
  62. data/docs/cops/markdown/unordered_list_marker.md +11 -2
  63. data/docs/cops/prose/multiple_blank_lines.md +2 -0
  64. data/docs/cops/prose/sentence_capitalization.md +46 -0
  65. data/docs/cops/text/hard_tabs.md +28 -0
  66. data/docs/cops/text/proper_names.md +36 -0
  67. data/docs/settings/files.md +1 -1
  68. data/docs/settings/front_matter.md +2 -2
  69. data/lib/rubocop/cop/markdown/code_block_style.rb +1 -1
  70. data/lib/rubocop/cop/markdown/code_span_spacing.rb +2 -2
  71. data/lib/rubocop/cop/markdown/duplicate_headings.rb +55 -5
  72. data/lib/rubocop/cop/markdown/emphasis_spacing.rb +1 -1
  73. data/lib/rubocop/cop/markdown/emphasis_style.rb +7 -0
  74. data/lib/rubocop/cop/markdown/fence_style.rb +1 -1
  75. data/lib/rubocop/cop/markdown/first_heading.rb +13 -2
  76. data/lib/rubocop/cop/markdown/front_matter_keys.rb +70 -0
  77. data/lib/rubocop/cop/markdown/front_matter_syntax.rb +26 -0
  78. data/lib/rubocop/cop/markdown/hard_tabs.rb +11 -7
  79. data/lib/rubocop/cop/markdown/heading_capitalization.rb +43 -0
  80. data/lib/rubocop/cop/markdown/heading_style.rb +1 -1
  81. data/lib/rubocop/cop/markdown/{syntax.rb → kramdown_syntax.rb} +1 -1
  82. data/lib/rubocop/cop/markdown/list_item_capitalization.rb +90 -0
  83. data/lib/rubocop/cop/markdown/list_item_punctuation.rb +64 -0
  84. data/lib/rubocop/cop/markdown/list_marker_spacing.rb +13 -4
  85. data/lib/rubocop/cop/markdown/ordered_list_numbering.rb +1 -1
  86. data/lib/rubocop/cop/markdown/outside_spacing.rb +6 -6
  87. data/lib/rubocop/cop/markdown/proper_names.rb +20 -31
  88. data/lib/rubocop/cop/markdown/raw_html.rb +62 -7
  89. data/lib/rubocop/cop/markdown/reference_definitions.rb +15 -5
  90. data/lib/rubocop/cop/markdown/strong_style.rb +7 -0
  91. data/lib/rubocop/cop/markdown/structural_line_length.rb +7 -6
  92. data/lib/rubocop/cop/markdown/table_blank_lines.rb +1 -1
  93. data/lib/rubocop/cop/markdown/table_columns.rb +1 -1
  94. data/lib/rubocop/cop/markdown/table_pipes.rb +8 -1
  95. data/lib/rubocop/cop/markdown/table_spacing.rb +8 -1
  96. data/lib/rubocop/cop/markdown/thematic_break_style.rb +4 -0
  97. data/lib/rubocop/cop/markdown/trailing_whitespace.rb +6 -0
  98. data/lib/rubocop/cop/markdown/unordered_list_marker.rb +1 -1
  99. data/lib/rubocop/cop/prose/sentence_capitalization.rb +100 -0
  100. data/lib/rubocop/cop/text/hard_tabs.rb +21 -0
  101. data/lib/rubocop/cop/text/proper_names.rb +20 -0
  102. data/lib/rubocop/prose/capitalization_rules.rb +189 -0
  103. data/lib/rubocop/prose/inline_rules.rb +17 -10
  104. data/lib/rubocop/prose/link_rules.rb +34 -13
  105. data/lib/rubocop/prose/markdown_document.rb +30 -8
  106. data/lib/rubocop/prose/proper_name_rules.rb +31 -0
  107. data/lib/rubocop/prose/structural_blank_lines.rb +1 -1
  108. data/lib/rubocop/prose/table_rules.rb +1 -1
  109. data/lib/rubocop/prose/version.rb +1 -1
  110. data/lib/rubocop-prose.rb +3 -0
  111. metadata +32 -4
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubocop-prose
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel (dB.) Doubrovkine
@@ -86,6 +86,7 @@ files:
86
86
  - LICENSE.txt
87
87
  - README.md
88
88
  - RELEASING.md
89
+ - UPGRADING.md
89
90
  - assets/README.md
90
91
  - assets/RUBOCOP-LICENSE
91
92
  - assets/logo.gif
@@ -113,9 +114,12 @@ files:
113
114
  - config/cops/markdown/fence_style.yml
114
115
  - config/cops/markdown/first_heading.yml
115
116
  - config/cops/markdown/front_matter.yml
117
+ - config/cops/markdown/front_matter_keys.yml
118
+ - config/cops/markdown/front_matter_syntax.yml
116
119
  - config/cops/markdown/hard_break_style.yml
117
120
  - config/cops/markdown/hard_tabs.yml
118
121
  - config/cops/markdown/heading_blank_lines.yml
122
+ - config/cops/markdown/heading_capitalization.yml
119
123
  - config/cops/markdown/heading_increment.yml
120
124
  - config/cops/markdown/heading_indentation.yml
121
125
  - config/cops/markdown/heading_punctuation.yml
@@ -123,12 +127,15 @@ files:
123
127
  - config/cops/markdown/heading_style.yml
124
128
  - config/cops/markdown/image_alt_text.yml
125
129
  - config/cops/markdown/image_path_separators.yml
130
+ - config/cops/markdown/kramdown_syntax.yml
126
131
  - config/cops/markdown/link_fragment.yml
127
132
  - config/cops/markdown/link_style.yml
128
133
  - config/cops/markdown/link_text_spacing.yml
129
134
  - config/cops/markdown/list_blank_lines.yml
130
135
  - config/cops/markdown/list_continuation_indentation.yml
131
136
  - config/cops/markdown/list_indentation.yml
137
+ - config/cops/markdown/list_item_capitalization.yml
138
+ - config/cops/markdown/list_item_punctuation.yml
132
139
  - config/cops/markdown/list_marker_spacing.yml
133
140
  - config/cops/markdown/ordered_list_numbering.yml
134
141
  - config/cops/markdown/outside_spacing.yml
@@ -140,7 +147,6 @@ files:
140
147
  - config/cops/markdown/single_top_level_heading.yml
141
148
  - config/cops/markdown/strong_style.yml
142
149
  - config/cops/markdown/structural_line_length.yml
143
- - config/cops/markdown/syntax.yml
144
150
  - config/cops/markdown/table_blank_lines.yml
145
151
  - config/cops/markdown/table_columns.yml
146
152
  - config/cops/markdown/table_pipes.yml
@@ -154,9 +160,13 @@ files:
154
160
  - config/cops/markdown/unordered_list_marker.yml
155
161
  - config/cops/prose/max_length.yml
156
162
  - config/cops/prose/multiple_blank_lines.yml
163
+ - config/cops/prose/sentence_capitalization.yml
157
164
  - config/cops/prose/trailing_newline.yml
165
+ - config/cops/text/hard_tabs.yml
166
+ - config/cops/text/proper_names.yml
158
167
  - config/cops/text/trailing_whitespace.yml
159
168
  - config/default.yml
169
+ - config/obsoletion.yml
160
170
  - docs/cops/markdown/atx_heading_space.md
161
171
  - docs/cops/markdown/atx_heading_spacing.md
162
172
  - docs/cops/markdown/bare_url.md
@@ -177,9 +187,12 @@ files:
177
187
  - docs/cops/markdown/fence_language.md
178
188
  - docs/cops/markdown/fence_style.md
179
189
  - docs/cops/markdown/first_heading.md
190
+ - docs/cops/markdown/front_matter_keys.md
191
+ - docs/cops/markdown/front_matter_syntax.md
180
192
  - docs/cops/markdown/hard_break_style.md
181
193
  - docs/cops/markdown/hard_tabs.md
182
194
  - docs/cops/markdown/heading_blank_lines.md
195
+ - docs/cops/markdown/heading_capitalization.md
183
196
  - docs/cops/markdown/heading_increment.md
184
197
  - docs/cops/markdown/heading_indentation.md
185
198
  - docs/cops/markdown/heading_punctuation.md
@@ -187,12 +200,15 @@ files:
187
200
  - docs/cops/markdown/heading_style.md
188
201
  - docs/cops/markdown/image_alt_text.md
189
202
  - docs/cops/markdown/image_path_separators.md
203
+ - docs/cops/markdown/kramdown_syntax.md
190
204
  - docs/cops/markdown/link_fragment.md
191
205
  - docs/cops/markdown/link_style.md
192
206
  - docs/cops/markdown/link_text_spacing.md
193
207
  - docs/cops/markdown/list_blank_lines.md
194
208
  - docs/cops/markdown/list_continuation_indentation.md
195
209
  - docs/cops/markdown/list_indentation.md
210
+ - docs/cops/markdown/list_item_capitalization.md
211
+ - docs/cops/markdown/list_item_punctuation.md
196
212
  - docs/cops/markdown/list_marker_spacing.md
197
213
  - docs/cops/markdown/ordered_list_numbering.md
198
214
  - docs/cops/markdown/outside_spacing.md
@@ -204,7 +220,6 @@ files:
204
220
  - docs/cops/markdown/single_top_level_heading.md
205
221
  - docs/cops/markdown/strong_style.md
206
222
  - docs/cops/markdown/structural_line_length.md
207
- - docs/cops/markdown/syntax.md
208
223
  - docs/cops/markdown/table_blank_lines.md
209
224
  - docs/cops/markdown/table_columns.md
210
225
  - docs/cops/markdown/table_pipes.md
@@ -218,7 +233,10 @@ files:
218
233
  - docs/cops/markdown/unordered_list_marker.md
219
234
  - docs/cops/prose/max_length.md
220
235
  - docs/cops/prose/multiple_blank_lines.md
236
+ - docs/cops/prose/sentence_capitalization.md
221
237
  - docs/cops/prose/trailing_newline.md
238
+ - docs/cops/text/hard_tabs.md
239
+ - docs/cops/text/proper_names.md
222
240
  - docs/cops/text/trailing_whitespace.md
223
241
  - docs/settings/files.md
224
242
  - docs/settings/front_matter.md
@@ -244,9 +262,12 @@ files:
244
262
  - lib/rubocop/cop/markdown/fence_language.rb
245
263
  - lib/rubocop/cop/markdown/fence_style.rb
246
264
  - lib/rubocop/cop/markdown/first_heading.rb
265
+ - lib/rubocop/cop/markdown/front_matter_keys.rb
266
+ - lib/rubocop/cop/markdown/front_matter_syntax.rb
247
267
  - lib/rubocop/cop/markdown/hard_break_style.rb
248
268
  - lib/rubocop/cop/markdown/hard_tabs.rb
249
269
  - lib/rubocop/cop/markdown/heading_blank_lines.rb
270
+ - lib/rubocop/cop/markdown/heading_capitalization.rb
250
271
  - lib/rubocop/cop/markdown/heading_increment.rb
251
272
  - lib/rubocop/cop/markdown/heading_indentation.rb
252
273
  - lib/rubocop/cop/markdown/heading_punctuation.rb
@@ -254,12 +275,15 @@ files:
254
275
  - lib/rubocop/cop/markdown/heading_style.rb
255
276
  - lib/rubocop/cop/markdown/image_alt_text.rb
256
277
  - lib/rubocop/cop/markdown/image_path_separators.rb
278
+ - lib/rubocop/cop/markdown/kramdown_syntax.rb
257
279
  - lib/rubocop/cop/markdown/link_fragment.rb
258
280
  - lib/rubocop/cop/markdown/link_style.rb
259
281
  - lib/rubocop/cop/markdown/link_text_spacing.rb
260
282
  - lib/rubocop/cop/markdown/list_blank_lines.rb
261
283
  - lib/rubocop/cop/markdown/list_continuation_indentation.rb
262
284
  - lib/rubocop/cop/markdown/list_indentation.rb
285
+ - lib/rubocop/cop/markdown/list_item_capitalization.rb
286
+ - lib/rubocop/cop/markdown/list_item_punctuation.rb
263
287
  - lib/rubocop/cop/markdown/list_marker_spacing.rb
264
288
  - lib/rubocop/cop/markdown/ordered_list_numbering.rb
265
289
  - lib/rubocop/cop/markdown/outside_spacing.rb
@@ -271,7 +295,6 @@ files:
271
295
  - lib/rubocop/cop/markdown/single_top_level_heading.rb
272
296
  - lib/rubocop/cop/markdown/strong_style.rb
273
297
  - lib/rubocop/cop/markdown/structural_line_length.rb
274
- - lib/rubocop/cop/markdown/syntax.rb
275
298
  - lib/rubocop/cop/markdown/table_blank_lines.rb
276
299
  - lib/rubocop/cop/markdown/table_columns.rb
277
300
  - lib/rubocop/cop/markdown/table_pipes.rb
@@ -286,9 +309,13 @@ files:
286
309
  - lib/rubocop/cop/prose/base.rb
287
310
  - lib/rubocop/cop/prose/max_length.rb
288
311
  - lib/rubocop/cop/prose/multiple_blank_lines.rb
312
+ - lib/rubocop/cop/prose/sentence_capitalization.rb
289
313
  - lib/rubocop/cop/prose/trailing_newline.rb
290
314
  - lib/rubocop/cop/text/base.rb
315
+ - lib/rubocop/cop/text/hard_tabs.rb
316
+ - lib/rubocop/cop/text/proper_names.rb
291
317
  - lib/rubocop/cop/text/trailing_whitespace.rb
318
+ - lib/rubocop/prose/capitalization_rules.rb
292
319
  - lib/rubocop/prose/code_rules.rb
293
320
  - lib/rubocop/prose/document.rb
294
321
  - lib/rubocop/prose/file_types.rb
@@ -299,6 +326,7 @@ files:
299
326
  - lib/rubocop/prose/markdown_document.rb
300
327
  - lib/rubocop/prose/parser.rb
301
328
  - lib/rubocop/prose/plugin.rb
329
+ - lib/rubocop/prose/proper_name_rules.rb
302
330
  - lib/rubocop/prose/runner.rb
303
331
  - lib/rubocop/prose/source.rb
304
332
  - lib/rubocop/prose/structural_blank_lines.rb