rubocop-prose 0.1.0

data/docs/cops/markdown/table_blank_lines.md

@@ -0,0 +1,34 @@
+# Markdown/TableBlankLines
+
+Adds blank lines around Markdown tables without changing their rows or blockquote nesting. Document boundaries need no padding; empty blockquote lines count as blank.
+
+## Configuration
+
+```yaml
+Markdown/TableBlankLines:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+Before.
+| A | B |
+| --- | --- |
+| one | two |
+After.
+```
+
+### Good
+
+```markdown
+Before.
+
+| A | B |
+| --- | --- |
+| one | two |
+
+After.
+```

data/docs/cops/markdown/table_columns.md

@@ -0,0 +1,30 @@
+# Markdown/TableColumns
+
+Requires delimiter and body rows to have the same number of cells as the header. Empty cells count; escaped pipes and pipes inside inline code are cell content.
+
+Report-only: adding or removing cells can lose content.
+
+## Configuration
+
+```yaml
+Markdown/TableColumns:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+| A | B |
+| --- | --- |
+| one |
+```
+
+### Good
+
+```markdown
+| A | B |
+| --- | --- |
+| one | two |
+```

data/docs/cops/markdown/table_pipes.md

@@ -0,0 +1,38 @@
+# Markdown/TablePipes
+
+Enforces leading and trailing table pipes. Consistent mode follows each table's header.
+
+Autocorrection preserves cell contents. Removing pipes from single-column tables or empty boundary cells is report-only when it could change the table's meaning.
+
+## Configuration
+
+```yaml
+Markdown/TablePipes:
+  Enabled: true
+  Style: consistent # consistent, leading_and_trailing, leading_only, trailing_only or no_leading_or_trailing.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/TablePipes:
+  Style: leading_and_trailing
+```
+
+### Bad
+
+```markdown
+A | B
+--- | ---
+one | two
+```
+
+### Good
+
+```markdown
+| A | B |
+| --- | --- |
+| one | two |
+```

data/docs/cops/markdown/table_spacing.md

@@ -0,0 +1,38 @@
+# Markdown/TableSpacing
+
+Formats table padding without changing cell contents: `aligned` pads columns to their widest source cell, `compact` uses one space beside pipes, and `tight` removes padding.
+
+Alignment counts source characters, not display width. Empty cells stay empty.
+
+## Configuration
+
+```yaml
+Markdown/TableSpacing:
+  Enabled: true
+  Style: aligned # aligned, compact or tight.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/TableSpacing:
+  Style: compact
+```
+
+### Bad
+
+```markdown
+|A|B|
+|---|---|
+|one|two|
+```
+
+### Good
+
+```markdown
+| A | B |
+| --- | --- |
+| one | two |
+```

data/docs/cops/markdown/thematic_break_blank_lines.md

@@ -0,0 +1,31 @@
+# Markdown/ThematicBreakBlankLines
+
+Requires one blank line above and below each parsed thematic break. Document boundaries and a preceding front-matter header do not require padding. Blockquote markers and list indentation are retained on inserted blank lines.
+
+For counts above one, also raise [Prose/MultipleBlankLines](../prose/multiple_blank_lines.md)'s `Max` to permit them.
+
+## Configuration
+
+```yaml
+Markdown/ThematicBreakBlankLines:
+  Enabled: true
+  LinesAbove: 1 # Nonnegative minimum; zero disables checks above breaks.
+  LinesBelow: 1 # Nonnegative minimum; zero disables checks below breaks.
+```
+
+## Example
+
+### Bad
+
+```markdown
+***
+After.
+```
+
+### Good
+
+```markdown
+***
+
+After.
+```

data/docs/cops/markdown/thematic_break_style.md

@@ -0,0 +1,48 @@
+# Markdown/ThematicBreakStyle
+
+Enforces one configured thematic-break spelling, permits a configured list of spellings, or follows the first break's exact spelling in consistent mode. Autocorrection preserves indentation and blockquote nesting; when a list permits multiple spellings, invalid breaks are reported without correction because their intended meaning is ambiguous.
+
+## Configuration
+
+```yaml
+Markdown/ThematicBreakStyle:
+  Enabled: true
+  Style: consistent
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/ThematicBreakStyle:
+  Style:
+    - '---'
+    - '-----'
+```
+
+### Incorrect
+
+```markdown
+Before.
+
+***
+
+After.
+```
+
+### Correct
+
+```markdown
+Before.
+
+---
+
+Between.
+
+-----
+
+After.
+```
+
+Both configured spellings are accepted. A disallowed spelling is reported but not automatically replaced when multiple alternatives are configured.

data/docs/cops/markdown/trailing_whitespace.md

@@ -0,0 +1,30 @@
+# Markdown/TrailingWhitespace
+
+Trims trailing whitespace while preserving paragraph hard breaks at the configured width. Hard-break width must be positive.
+
+When [Markdown/HardBreakStyle](hard_break_style.md) is enabled, that cop selects the hard-break syntax and this cop avoids overlapping corrections.
+
+## Configuration
+
+```yaml
+Markdown/TrailingWhitespace:
+  Enabled: true
+  HardBreakSpaces: 2 # Must be an integer of at least 2.
+  CodeBlocks: false # When true, code whitespace is report-only to preserve embedded strings.
+```
+
+## Example
+
+Inputs are shown as Ruby strings so tabs, trailing spaces, and newline characters are visible.
+
+### Bad
+
+```ruby
+"A paragraph. \n"
+```
+
+### Good
+
+```ruby
+"A paragraph.\n"
+```

data/docs/cops/markdown/unclosed_fenced_code_block.md

@@ -0,0 +1,29 @@
+# Markdown/UnclosedFencedCodeBlock
+
+Reports fenced code blocks that reach the end of the document without an explicit closing fence. End-of-file termination is valid Markdown, but an explicit closer can prevent later content from being swallowed after an editing mistake.
+
+This cop is report-only and points to the opening fence; it does not guess where a closing fence belongs.
+
+## Configuration
+
+```yaml
+Markdown/UnclosedFencedCodeBlock:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+````markdown
+```ruby
+puts 'hello'
+````
+
+### Good
+
+````markdown
+```ruby
+puts 'hello'
+```
+````

data/docs/cops/markdown/undefined_reference.md

@@ -0,0 +1,29 @@
+# Markdown/UndefinedReference
+
+Reports undefined full `[text][id]` and collapsed `[id][]` link or image references. Definitions can appear anywhere; IDs ignore case and repeated whitespace.
+
+Optional shortcut checking may flag ordinary bracketed prose. Task-list markers and footnotes are not references. Report-only.
+
+## Configuration
+
+```yaml
+Markdown/UndefinedReference:
+  Enabled: true
+  ShortcutSyntax: false # Set true to check unresolved [word] references too.
+```
+
+## Example
+
+### Bad
+
+```markdown
+[Read the guide][missing]
+```
+
+### Good
+
+```markdown
+[Read the guide][docs]
+
+[docs]: /guide
+```

data/docs/cops/markdown/unordered_list_indentation.md

@@ -0,0 +1,45 @@
+# Markdown/UnorderedListIndentation
+
+Requires top-level unordered markers at zero indentation and nested markers at the configured offset from their parent. Under an ordered parent, the offset is at least the width of the parent's marker and following spacing, so the child can align with its content. A deeper blockquote starts a fresh baseline.
+
+Indentation counts source characters, not tab stops. Report-only: moving a list can change its continuation blocks.
+
+## Configuration
+
+```yaml
+Markdown/UnorderedListIndentation:
+  Enabled: true
+  Indent: 2 # Characters beyond the parent marker, or its content offset if wider and ordered.
+```
+
+## Example
+
+### Bad
+
+```markdown
+- Parent
+   - Child
+
+1. Ordered parent
+
+    - Child
+
+10. Wider ordered parent
+
+     - Child
+```
+
+### Good
+
+```markdown
+- Parent
+  - Child
+
+1. Ordered parent
+
+   - Child
+
+10. Wider ordered parent
+
+    - Child
+```

data/docs/cops/markdown/unordered_list_marker.md

@@ -0,0 +1,36 @@
+# Markdown/UnorderedListMarker
+
+Enforces a configured unordered list marker or follows the first marker in consistent mode, including nested lists and blockquotes.
+
+Autocorrection changes only the marker and is withheld if it could create a thematic break.
+
+## Configuration
+
+```yaml
+Markdown/UnorderedListMarker:
+  Enabled: true
+  EnforcedStyle: consistent # consistent, asterisk, plus or dash.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/UnorderedListMarker:
+  EnforcedStyle: dash
+```
+
+### Bad
+
+```markdown
+* one
+* two
+```
+
+### Good
+
+```markdown
+- one
+- two
+```

data/docs/cops/prose/max_length.md

@@ -0,0 +1,33 @@
+# Prose/MaxLength
+
+Wraps or unwraps Markdown and plain-text paragraphs. Markdown formatting preserves nesting, hard breaks, and inline syntax; headings, tables, and code blocks are not reformatted.
+
+See [To Wrap or Not to Wrap in Markdown](https://code.dblock.org/2021/06/07/to-wrap-or-not-to-wrap-in-markdown.html) for the rationale behind unwrapped Markdown paragraphs.
+
+`Max: false` joins soft line breaks with one space, retaining paragraph boundaries and Markdown hard breaks, including `<br>`. Plain text treats markup literally. Indented text paragraphs and unbreakable overlong tokens can report without correction.
+
+Use [Markdown/StructuralLineLength](../markdown/structural_line_length.md) for heading, code-block, and table limits.
+
+## Configuration
+
+```yaml
+Prose/MaxLength:
+  Enabled: true
+  Max: false # One source line per paragraph; a positive character count wraps, including container prefixes.
+  IgnoreURLs: true # Ignore paragraph lines containing only one URL.
+```
+
+## Example
+
+### Bad
+
+```markdown
+A paragraph split
+across two source lines.
+```
+
+### Good
+
+```markdown
+A paragraph split across two source lines.
+```

data/docs/cops/prose/multiple_blank_lines.md

@@ -0,0 +1,50 @@
+# Prose/MultipleBlankLines
+
+Removes excess consecutive blank lines while preserving paragraph separation. In Markdown, marker-only blank lines inside one parsed blockquote count toward the same limit; code blocks and ignored metadata are left alone. Plain text is checked literally without interpreting quote-looking lines as Markdown.
+
+[Markdown/BlockquoteBlankLines](../markdown/blockquote_blank_lines.md) handles the separate case of adding markers between adjacent blockquotes.
+
+At Markdown structural boundaries, the effective limit is at least the minimum required by the enabled [heading](../markdown/heading_blank_lines.md), [fence](../markdown/fence_blank_lines.md), [list](../markdown/list_blank_lines.md), or [table](../markdown/table_blank_lines.md) spacing cop in that file's configuration. Shared boundaries use the largest minimum, not their sum. `Max` still applies elsewhere, including document edges where no structural padding is required.
+
+## Configuration
+
+```yaml
+Prose/MultipleBlankLines:
+  Enabled: true
+  Max: 1 # Non-negative integer; 0 is report-only to preserve paragraph separation.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Prose/MultipleBlankLines:
+  Max: 1
+```
+
+### Bad
+
+```markdown
+First paragraph.
+
+
+Second paragraph.
+
+> First paragraph.
+>
+>
+> Second paragraph.
+```
+
+### Good
+
+```markdown
+First paragraph.
+
+Second paragraph.
+
+> First paragraph.
+>
+> Second paragraph.
+```

data/docs/cops/prose/trailing_newline.md

@@ -0,0 +1,26 @@
+# Prose/TrailingNewline
+
+Ensures nonempty documents end in exactly one newline, inserting a missing newline or removing trailing blank lines. Empty files are accepted; internal content is unchanged.
+
+## Configuration
+
+```yaml
+Prose/TrailingNewline:
+  Enabled: true
+```
+
+## Example
+
+Inputs are shown as Ruby strings so tabs, trailing spaces, and newline characters are visible.
+
+### Bad
+
+```ruby
+"A paragraph."
+```
+
+### Good
+
+```ruby
+"A paragraph.\n"
+```

data/docs/cops/text/trailing_whitespace.md

@@ -0,0 +1,26 @@
+# Text/TrailingWhitespace
+
+Removes all trailing spaces and tabs from plain-text lines, including whitespace-only lines.
+
+## Configuration
+
+```yaml
+Text/TrailingWhitespace:
+  Enabled: true
+```
+
+## Example
+
+Inputs are shown as Ruby strings so trailing whitespace and newline characters are visible.
+
+### Bad
+
+```ruby
+"A paragraph.  \n"
+```
+
+### Good
+
+```ruby
+"A paragraph.\n"
+```

data/docs/settings/files.md

@@ -0,0 +1,33 @@
+# File selection
+
+`Markdown/Include` and `Text/Include` select files using RuboCop's normal filename and glob patterns.
+
+## Example
+
+```yaml
+Markdown:
+  Include:
+    - '**/*.md'
+    - '**/*.markdown'
+    - '**/*.notes'
+Text:
+  Include:
+    - '**/*.txt'
+    - '**/*.text'
+```
+
+Lists replace the inherited patterns for their format; omit a list to inherit it, or use `[]` to disable that format. Per-directory configuration and `--config` work as usual.
+
+The [default patterns](../../config/default.yml) recognize common Markdown extensions and `.txt`, including uppercase variants. Custom patterns are case-sensitive. A file matching both formats is a configuration error.
+
+Matching files are discovered automatically, without `AllCops/Include`. Use exclusions to skip files:
+
+```yaml
+AllCops:
+  Exclude:
+    - '**/LICENSE.txt'
+```
+
+Pass `--force-exclusion` to apply exclusions to explicitly named command-line files too.
+
+File patterns select the format, not which cops are enabled. `Prose/*` cops support both formats; `Markdown/*` and `Text/*` inspect only their own.

data/docs/settings/front_matter.md

@@ -0,0 +1,12 @@
+# Front matter
+
+By default, Markdown checks ignore a leading header opened with `---` and closed with `---` or `...`. Unclosed headers and delimiters elsewhere remain ordinary Markdown.
+
+Set `IgnoreFrontMatter: false` to inspect the header as Markdown, not validate its YAML. RuboCop directives inside metadata remain ignored, and this setting does not change Ruby snippet extraction.
+
+## Example
+
+```yaml
+Markdown:
+  IgnoreFrontMatter: true
+```

data/lib/rubocop/cop/markdown/atx_heading_space.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../../prose/heading_rules'
+
+module RuboCop
+  module Cop
+    module Markdown
+      class AtxHeadingSpace < Base
+        include RuboCop::Prose::HeadingRules
+
+        def investigate_document
+          heading_candidates.each do |match, number|
+            next if match[:rest].empty? || match[:rest].match?(/\A[ \t]/)
+
+            prose_offense(document.line_range(number),
+                          message: 'Separate opening heading hashes from text with a space.')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/markdown/atx_heading_spacing.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../prose/heading_rules'
+
+module RuboCop
+  module Cop
+    module Markdown
+      class AtxHeadingSpacing < Base
+        extend AutoCorrector
+        include RuboCop::Prose::HeadingRules
+
+        def investigate_document
+          heading_entries.each do |heading|
+            opening = heading[:opening]
+            next unless opening && (spacing = /\A[ \t]{2,}(?=\S)/.match(opening[:rest]))
+
+            column = opening.begin(:rest)
+            range = document.range(heading[:line], column, heading[:line], column + spacing[0].length)
+            prose_offense(range, message: 'Use one space after opening heading hashes.') do |corrector|
+              corrector.replace(processed_range(range), ' ')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/markdown/bare_url.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../../prose/link_rules'
+
+module RuboCop
+  module Cop
+    module Markdown
+      class BareUrl < Base
+        MSG = 'Use an autolink or a Markdown link instead of a bare URL.'
+
+        private
+
+        def investigate_document
+          scanner = document.link_rules
+          scanner.bare_urls(cop_config.fetch('Schemes', %w[http https ftp])).each do |first, last|
+            prose_offense(scanner.range(first, last))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/markdown/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Markdown
+      class Base < Prose::Base
+        exclude_from_registry
+
+        private
+
+        def applicable_document?
+          processed_source.prose_format == :markdown
+        end
+      end
+    end
+  end
+end