rubocop-prose 0.1.0

data/docs/cops/markdown/code_block_style.md

@@ -0,0 +1,37 @@
+# Markdown/CodeBlockStyle
+
+Enforces fenced, indented, or consistent code blocks, including nested blocks. Consistent mode follows the first block.
+
+Autocorrection is limited to standalone root-level blocks with blank boundaries. Blocks with metadata, nested containers, empty fenced bodies, or leading/trailing blank content are report-only. Adjacent code blocks are not converted to indentation, to avoid merging them.
+
+## Configuration
+
+```yaml
+Markdown/CodeBlockStyle:
+  Enabled: false
+  EnforcedStyle: consistent # consistent, fenced or indented.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/CodeBlockStyle:
+  Enabled: true
+  EnforcedStyle: fenced
+```
+
+### Bad
+
+```markdown
+    puts 'hello'
+```
+
+### Good
+
+````markdown
+```ruby
+puts 'hello'
+```
+````

data/docs/cops/markdown/code_span_spacing.md

@@ -0,0 +1,26 @@
+# Markdown/CodeSpanSpacing
+
+Reports unnecessary padding inside inline code. All-space values and padding needed around literal backticks are accepted.
+
+Autocorrection removes a single redundant space from each edge of a single-line span: `` ` foo ` `` becomes `` `foo` ``. Other padding is report-only because removing it can change the code value.
+
+## Configuration
+
+```yaml
+Markdown/CodeSpanSpacing:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+Use ` code ` here.
+```
+
+### Good
+
+```markdown
+Use `code` here.
+```

data/docs/cops/markdown/compact_lists.md

@@ -0,0 +1,29 @@
+# Markdown/CompactLists
+
+Reports blank lines between sibling list items. Blank lines inside an item are not affected. Corrections remove the separator only when both adjacent items consist of a single paragraph; separators next to complex items are reported without correction.
+
+## Configuration
+
+```yaml
+Markdown/CompactLists:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+- First item.
+
+- Second item.
+```
+
+### Good
+
+```markdown
+- First item.
+- Second item.
+```
+
+Blank lines separating paragraphs, nested lists, or code within an item remain in place.

data/docs/cops/markdown/descriptive_link_text.md

@@ -0,0 +1,31 @@
+# Markdown/DescriptiveLinkText
+
+Reports links whose entire rendered label matches a configured generic label, ignoring case and repeated whitespace. Prefer descriptive text such as `[the installation guide](https://example.test)`.
+
+Matching is whole-label: `click here for installation` does not match `click here`. Images and autolinks are not checked. Report-only.
+
+## Configuration
+
+```yaml
+Markdown/DescriptiveLinkText:
+  Enabled: true
+  GenericLabels: # Customize for the project's language; an empty list permits every label.
+    - click here
+    - here
+    - link
+    - more
+```
+
+## Example
+
+### Bad
+
+```markdown
+[click here](/guide)
+```
+
+### Good
+
+```markdown
+[Read the installation guide](/guide)
+```

data/docs/cops/markdown/duplicate_headings.md

@@ -0,0 +1,35 @@
+# Markdown/DuplicateHeadings
+
+Reports duplicate heading text within the configured scope. Comparison is case-sensitive text without whitespace normalization, including inline code but ignoring emphasis.
+
+Sibling headings share a parent heading; root headings share a scope. Each new parent starts a fresh scope, even when its text repeats. Report-only: renaming headings can break links.
+
+## Configuration
+
+```yaml
+Markdown/DuplicateHeadings:
+  Enabled: true
+  Scope: siblings # Or document to compare headings across the entire document.
+```
+
+## Example
+
+### Bad
+
+```markdown
+# Guide
+
+## Usage
+
+## Usage
+```
+
+### Good
+
+```markdown
+# Guide
+
+## Usage
+
+## License
+```

data/docs/cops/markdown/emphasis_heading.md

@@ -0,0 +1,26 @@
+# Markdown/EmphasisHeading
+
+Reports single-line paragraphs consisting entirely of italic or bold text, such as `**Overview**`, including in lists and blockquotes.
+
+Report-only: the paragraph may be intentional; otherwise, choose an appropriate heading level.
+
+## Configuration
+
+```yaml
+Markdown/EmphasisHeading:
+  Enabled: false
+```
+
+## Example
+
+### Bad
+
+```markdown
+*Installation*
+```
+
+### Good
+
+```markdown
+## Installation
+```

data/docs/cops/markdown/emphasis_spacing.md

@@ -0,0 +1,24 @@
+# Markdown/EmphasisSpacing
+
+Removes whitespace just inside matching emphasis delimiters on a single line, preserving the content and delimiter style. For example, `** two  words **` becomes `**two  words**`.
+
+## Configuration
+
+```yaml
+Markdown/EmphasisSpacing:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+Some * padded * text.
+```
+
+### Good
+
+```markdown
+Some *padded* text.
+```

data/docs/cops/markdown/emphasis_style.md

@@ -0,0 +1,34 @@
+# Markdown/EmphasisStyle
+
+Enforces a configured emphasis delimiter or follows the first one in consistent mode. Strong emphasis belongs to [Markdown/StrongStyle](strong_style.md).
+
+Autocorrection preserves content. Intraword asterisks are not changed to underscores when that would remove the emphasis.
+
+## Configuration
+
+```yaml
+Markdown/EmphasisStyle:
+  Enabled: true
+  Style: consistent # consistent, asterisk or underscore.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/EmphasisStyle:
+  Style: underscore
+```
+
+### Bad
+
+```markdown
+This is *important*.
+```
+
+### Good
+
+```markdown
+This is _important_.
+```

data/docs/cops/markdown/empty_link.md

@@ -0,0 +1,26 @@
+# Markdown/EmptyLink
+
+Reports links with an empty destination or just `#`, including reference links. Empty labels with real destinations and images are not checked.
+
+Report-only: supply the intended destination.
+
+## Configuration
+
+```yaml
+Markdown/EmptyLink:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+[Read the guide]()
+```
+
+### Good
+
+```markdown
+[Read the guide](/guide)
+```

data/docs/cops/markdown/fence_blank_lines.md

@@ -0,0 +1,43 @@
+# Markdown/FenceBlankLines
+
+Requires the configured minimum blank lines above and below fenced code blocks, preserving list and blockquote nesting. Set either count to zero to leave that boundary unchecked. Document boundaries and a preceding front-matter header do not require extra padding.
+
+A fence on a list marker's own line does not require a blank before it.
+
+Both counts must be nonnegative integers; `null` is invalid.
+
+[Prose/MultipleBlankLines](../prose/multiple_blank_lines.md) preserves these minimums at fence boundaries without relaxing its limit elsewhere.
+
+## Configuration
+
+```yaml
+Markdown/FenceBlankLines:
+  Enabled: true
+  LinesAbove: 1 # Nonnegative minimum; zero disables checks above fences.
+  LinesBelow: 1 # Nonnegative minimum; zero disables checks below fences.
+  ListItems: true # Set false to skip fences inside list items.
+```
+
+## Example
+
+### Bad
+
+````markdown
+Example:
+```ruby
+puts 1
+```
+More text.
+````
+
+### Good
+
+````markdown
+Example:
+
+```ruby
+puts 1
+```
+
+More text.
+````

data/docs/cops/markdown/fence_language.md

@@ -0,0 +1,31 @@
+# Markdown/FenceLanguage
+
+Requires a language on fenced code blocks, optionally restricted to an allowlist. Names are case-sensitive.
+
+Report-only: specify the appropriate language.
+
+## Configuration
+
+```yaml
+Markdown/FenceLanguage:
+  Enabled: true
+  AllowedLanguages: [] # Accept any nonempty language; otherwise allow only listed, case-sensitive names.
+```
+
+## Example
+
+### Bad
+
+````markdown
+```
+puts 1
+```
+````
+
+### Good
+
+````markdown
+```ruby
+puts 1
+```
+````

data/docs/cops/markdown/fence_style.md

@@ -0,0 +1,38 @@
+# Markdown/FenceStyle
+
+Enforces backtick, tilde, or consistent code fences. Consistent mode follows the first fence.
+
+Autocorrection preserves contents, language metadata, and nesting. Conversion to backticks is report-only if the information string contains backticks.
+
+## Configuration
+
+```yaml
+Markdown/FenceStyle:
+  Enabled: true
+  EnforcedStyle: consistent # consistent, backtick or tilde.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/FenceStyle:
+  EnforcedStyle: backtick
+```
+
+### Bad
+
+```markdown
+~~~ruby
+puts 1
+~~~
+```
+
+### Good
+
+````markdown
+```ruby
+puts 1
+```
+````

data/docs/cops/markdown/first_heading.md

@@ -0,0 +1,31 @@
+# Markdown/FirstHeading
+
+Requires the first content line to be a heading at the configured level, unless a configured front-matter title qualifies. Empty documents are accepted.
+
+Front-matter titles must be strings; YAML aliases are not accepted. Report-only: adding or moving a heading changes structure.
+
+## Configuration
+
+```yaml
+Markdown/FirstHeading:
+  Enabled: false
+  Level: 1
+  FrontMatterTitle: true # Accept a nonempty front-matter title instead of a heading.
+  TitleKey: title # Exact top-level YAML key, not a regular expression.
+```
+
+## Example
+
+### Bad
+
+```markdown
+An introduction to the project.
+```
+
+### Good
+
+```markdown
+# Introduction
+
+An introduction to the project.
+```

data/docs/cops/markdown/hard_break_style.md

@@ -0,0 +1,50 @@
+# Markdown/HardBreakStyle
+
+Requires Markdown paragraph hard breaks to use the configured backslash or trailing-space syntax. The default backslash style is enabled automatically.
+
+On files whose line endings cannot be preserved by RuboCop's source buffer, this cop reports style violations without autocorrecting them.
+
+## Configuration
+
+```yaml
+Markdown/HardBreakStyle:
+  Enabled: true
+  Style: backslash # backslash or spaces.
+```
+
+## Example
+
+### Bad: trailing spaces
+
+```markdown
+First line.  
+Second line.
+```
+
+### Good: backslash
+
+```markdown
+First line.\
+Second line.
+```
+
+For this configuration:
+
+```yaml
+Markdown/HardBreakStyle:
+  Style: spaces
+```
+
+### Bad: backslash
+
+```markdown
+First line.\
+Second line.
+```
+
+### Good: trailing spaces
+
+```markdown
+First line.  
+Second line.
+```

data/docs/cops/markdown/hard_tabs.md

@@ -0,0 +1,30 @@
+# Markdown/HardTabs
+
+Reports hard tabs, with configurable code-language exceptions.
+
+Report-only: replacing tabs can change embedded code or Makefiles.
+
+## Configuration
+
+```yaml
+Markdown/HardTabs:
+  Enabled: true
+  CodeBlocks: false # Preserve tabs in code examples; set true to inspect code.
+  AllowedCodeLanguages: [] # Case-insensitive fenced languages to exempt, such as make.
+```
+
+## Example
+
+Inputs are shown as Ruby strings so tabs, trailing spaces, and newline characters are visible.
+
+### Bad
+
+```ruby
+"A\tparagraph.\n"
+```
+
+### Good
+
+```ruby
+"A paragraph.\n"
+```

data/docs/cops/markdown/heading_blank_lines.md

@@ -0,0 +1,36 @@
+# Markdown/HeadingBlankLines
+
+Requires the configured blank lines around headings, measuring below the underline for Setext headings. Document boundaries and the end of front matter do not require padding; empty blockquote lines count as blank.
+
+Report-only: inserting blank lines can change surrounding lists and blockquotes.
+
+[Prose/MultipleBlankLines](../prose/multiple_blank_lines.md) preserves these minimums at heading boundaries without relaxing its limit elsewhere.
+
+## Configuration
+
+```yaml
+Markdown/HeadingBlankLines:
+  Enabled: true
+  LinesAbove: 1 # Minimum blank lines before a heading; 0 disables this requirement.
+  LinesBelow: 1 # Minimum blank lines after a heading; 0 disables this requirement.
+```
+
+## Example
+
+### Bad
+
+```markdown
+Introduction.
+## Usage
+Follow these steps.
+```
+
+### Good
+
+```markdown
+Introduction.
+
+## Usage
+
+Follow these steps.
+```

data/docs/cops/markdown/heading_increment.md

@@ -0,0 +1,30 @@
+# Markdown/HeadingIncrement
+
+Reports skipped heading levels, such as `# Title` followed by `### Detail`. The first heading can have any level, and decreases are unrestricted.
+
+Report-only: choose the appropriate heading level.
+
+## Configuration
+
+```yaml
+Markdown/HeadingIncrement:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+# Guide
+
+### Usage
+```
+
+### Good
+
+```markdown
+# Guide
+
+## Usage
+```

data/docs/cops/markdown/heading_indentation.md

@@ -0,0 +1,26 @@
+# Markdown/HeadingIndentation
+
+Reports indentation before headings or their outermost container marker; `> # Title` is accepted only without leading spaces. For Setext headings, only the text line's indentation is checked.
+
+Report-only: removing indentation can change the surrounding structure.
+
+## Configuration
+
+```yaml
+Markdown/HeadingIndentation:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+ # Title
+```
+
+### Good
+
+```markdown
+# Title
+```

data/docs/cops/markdown/heading_punctuation.md

@@ -0,0 +1,27 @@
+# Markdown/HeadingPunctuation
+
+Reports configured punctuation at the end of rendered heading text, including inline code. Closing heading hashes do not count as punctuation.
+
+Report-only: punctuation may be meaningful.
+
+## Configuration
+
+```yaml
+Markdown/HeadingPunctuation:
+  Enabled: false
+  Punctuation: ".,;:!?" # Forbidden final characters; accepts Unicode. Use '' to disable.
+```
+
+## Example
+
+### Bad
+
+```markdown
+# Installation!
+```
+
+### Good
+
+```markdown
+# Installation
+```

data/docs/cops/markdown/heading_structure.md

@@ -0,0 +1,41 @@
+# Markdown/HeadingStructure
+
+Requires an exact heading outline, in order. Write each entry as one to six hashes, a space, and the expected heading text; ATX and Setext headings are equivalent when their level and text match.
+
+Missing, extra, and mismatched headings are reported without correction.
+
+## Configuration
+
+```yaml
+Markdown/HeadingStructure:
+  Enabled: false
+  Headings: [] # Exact ordered outline; an empty list disables checks.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/HeadingStructure:
+  Enabled: true
+  Headings:
+    - "# Guide"
+    - "## Usage"
+```
+
+### Bad
+
+```markdown
+# Guide
+
+## Installation
+```
+
+### Good
+
+```markdown
+# Guide
+
+## Usage
+```

data/docs/cops/markdown/heading_style.md

@@ -0,0 +1,36 @@
+# Markdown/HeadingStyle
+
+Enforces ATX, closed ATX, Setext, or consistent headings. Consistent mode follows the first heading. Setext supports only levels one and two.
+
+Report-only: changing syntax can alter heading levels or surrounding structure.
+
+## Configuration
+
+```yaml
+Markdown/HeadingStyle:
+  Enabled: false
+  EnforcedStyle: consistent # consistent, atx, atx_closed or setext.
+```
+
+## Example
+
+For this configuration:
+
+```yaml
+Markdown/HeadingStyle:
+  Enabled: true
+  EnforcedStyle: atx
+```
+
+### Bad
+
+```markdown
+Title
+=====
+```
+
+### Good
+
+```markdown
+# Title
+```