rubocop-prose 0.1.0

data/config/cops/markdown/bare_url.yml

@@ -0,0 +1,7 @@
+Markdown/BareUrl:
+  Description: 'Require Markdown links or autolinks around bare URLs.'
+  Enabled: false
+  Schemes:
+    - http
+    - https
+    - ftp

data/config/cops/markdown/blockquote_blank_lines.yml

@@ -0,0 +1,3 @@
+Markdown/BlockquoteBlankLines:
+  Description: Keep quote markers on blank lines between blockquotes.
+  Enabled: true

data/config/cops/markdown/blockquote_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/BlockquoteSpacing:
+  Description: Use one space after nonempty blockquote markers.
+  Enabled: true

data/config/cops/markdown/closed_heading_space.yml

@@ -0,0 +1,3 @@
+Markdown/ClosedHeadingSpace:
+  Description: 'Separate closing ATX heading hashes from text.'
+  Enabled: true

data/config/cops/markdown/closed_heading_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/ClosedHeadingSpacing:
+  Description: 'Use one space before closing ATX heading hashes.'
+  Enabled: true

data/config/cops/markdown/code_block_style.yml

@@ -0,0 +1,8 @@
+Markdown/CodeBlockStyle:
+  Description: Use fenced, indented, or consistently styled code blocks.
+  Enabled: false
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - consistent
+    - fenced
+    - indented

data/config/cops/markdown/code_span_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/CodeSpanSpacing:
+  Description: 'Avoid unnecessary padding inside inline code.'
+  Enabled: true

data/config/cops/markdown/compact_lists.yml

@@ -0,0 +1,3 @@
+Markdown/CompactLists:
+  Description: Avoid blank lines between simple list items.
+  Enabled: true

data/config/cops/markdown/descriptive_link_text.yml

@@ -0,0 +1,8 @@
+Markdown/DescriptiveLinkText:
+  Description: 'Require descriptive link text instead of generic labels.'
+  Enabled: true
+  GenericLabels:
+    - click here
+    - here
+    - link
+    - more

data/config/cops/markdown/duplicate_headings.yml

@@ -0,0 +1,4 @@
+Markdown/DuplicateHeadings:
+  Description: 'Avoid duplicate heading text.'
+  Enabled: true
+  Scope: siblings

data/config/cops/markdown/emphasis_heading.yml

@@ -0,0 +1,3 @@
+Markdown/EmphasisHeading:
+  Description: 'Avoid single-line emphasis-only paragraphs in place of headings.'
+  Enabled: false

data/config/cops/markdown/emphasis_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/EmphasisSpacing:
+  Description: 'Remove whitespace immediately inside emphasis delimiters.'
+  Enabled: true

data/config/cops/markdown/emphasis_style.yml

@@ -0,0 +1,4 @@
+Markdown/EmphasisStyle:
+  Description: 'Use a configured or consistent emphasis delimiter.'
+  Enabled: true
+  Style: consistent

data/config/cops/markdown/empty_link.yml

@@ -0,0 +1,3 @@
+Markdown/EmptyLink:
+  Description: 'Require a nonempty link destination.'
+  Enabled: true

data/config/cops/markdown/fence_blank_lines.yml

@@ -0,0 +1,6 @@
+Markdown/FenceBlankLines:
+  Description: Surround fenced code blocks with container-aware blank lines.
+  Enabled: true
+  LinesAbove: 1
+  LinesBelow: 1
+  ListItems: true

data/config/cops/markdown/fence_language.yml

@@ -0,0 +1,4 @@
+Markdown/FenceLanguage:
+  Description: Require a language and optionally restrict fence languages.
+  Enabled: true
+  AllowedLanguages: []

data/config/cops/markdown/fence_style.yml

@@ -0,0 +1,8 @@
+Markdown/FenceStyle:
+  Description: Use backtick, tilde, or consistently styled fences.
+  Enabled: true
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - consistent
+    - backtick
+    - tilde

data/config/cops/markdown/first_heading.yml

@@ -0,0 +1,6 @@
+Markdown/FirstHeading:
+  Description: 'Begin documents with a heading or front-matter title.'
+  Enabled: false
+  Level: 1
+  FrontMatterTitle: true
+  TitleKey: title

data/config/cops/markdown/front_matter.yml

@@ -0,0 +1,2 @@
+Markdown:
+  IgnoreFrontMatter: true

data/config/cops/markdown/hard_break_style.yml

@@ -0,0 +1,4 @@
+Markdown/HardBreakStyle:
+  Description: 'Use a configured Markdown hard-break syntax.'
+  Enabled: true
+  Style: backslash

data/config/cops/markdown/hard_tabs.yml

@@ -0,0 +1,5 @@
+Markdown/HardTabs:
+  Description: 'Disallow hard tabs with code-language exceptions.'
+  Enabled: true
+  CodeBlocks: false
+  AllowedCodeLanguages: []

data/config/cops/markdown/heading_blank_lines.yml

@@ -0,0 +1,5 @@
+Markdown/HeadingBlankLines:
+  Description: 'Surround headings with blank lines.'
+  Enabled: true
+  LinesAbove: 1
+  LinesBelow: 1

data/config/cops/markdown/heading_increment.yml

@@ -0,0 +1,3 @@
+Markdown/HeadingIncrement:
+  Description: 'Increase heading levels without skipping levels.'
+  Enabled: true

data/config/cops/markdown/heading_indentation.yml

@@ -0,0 +1,3 @@
+Markdown/HeadingIndentation:
+  Description: 'Avoid leading indentation before headings.'
+  Enabled: true

data/config/cops/markdown/heading_punctuation.yml

@@ -0,0 +1,4 @@
+Markdown/HeadingPunctuation:
+  Description: 'Avoid configured trailing heading punctuation.'
+  Enabled: false
+  Punctuation: '.,;:!?'

data/config/cops/markdown/heading_structure.yml

@@ -0,0 +1,4 @@
+Markdown/HeadingStructure:
+  Description: 'Match a configured exact heading outline.'
+  Enabled: false
+  Headings: []

data/config/cops/markdown/heading_style.yml

@@ -0,0 +1,9 @@
+Markdown/HeadingStyle:
+  Description: 'Use a consistent heading syntax.'
+  Enabled: false
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - consistent
+    - atx
+    - atx_closed
+    - setext

data/config/cops/markdown/image_alt_text.yml

@@ -0,0 +1,3 @@
+Markdown/ImageAltText:
+  Description: 'Require nonblank Markdown image alternative text.'
+  Enabled: true

data/config/cops/markdown/image_path_separators.yml

@@ -0,0 +1,3 @@
+Markdown/ImagePathSeparators:
+  Description: 'Use forward slashes in local image destinations.'
+  Enabled: true

data/config/cops/markdown/link_fragment.yml

@@ -0,0 +1,6 @@
+Markdown/LinkFragment:
+  Description: 'Validate local fragments using configurable heading anchors.'
+  Enabled: false
+  Renderer: github
+  AdditionalAnchors: []
+  AllowEmptyFragment: true

data/config/cops/markdown/link_style.yml

@@ -0,0 +1,10 @@
+Markdown/LinkStyle:
+  Description: 'Configure permitted link and image styles independently.'
+  Enabled: false
+  AllowedLinkStyles:
+    - inline
+    - reference
+    - autolink
+  AllowedImageStyles:
+    - inline
+    - reference

data/config/cops/markdown/link_text_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/LinkTextSpacing:
+  Description: 'Remove leading and trailing whitespace from link text.'
+  Enabled: true

data/config/cops/markdown/list_blank_lines.yml

@@ -0,0 +1,3 @@
+Markdown/ListBlankLines:
+  Description: Surround parsed lists with blank lines.
+  Enabled: true

data/config/cops/markdown/list_continuation_indentation.yml

@@ -0,0 +1,3 @@
+Markdown/ListContinuationIndentation:
+  Description: Indent list continuation text to its item's content column.
+  Enabled: true

data/config/cops/markdown/list_indentation.yml

@@ -0,0 +1,3 @@
+Markdown/ListIndentation:
+  Description: Keep sibling list markers consistently indented.
+  Enabled: true

data/config/cops/markdown/list_marker_spacing.yml

@@ -0,0 +1,7 @@
+Markdown/ListMarkerSpacing:
+  Description: Configure spaces after ordered and unordered list markers.
+  Enabled: true
+  UnorderedSingle: 1
+  OrderedSingle: 1
+  UnorderedMulti: 1
+  OrderedMulti: 1

data/config/cops/markdown/ordered_list_numbering.yml

@@ -0,0 +1,7 @@
+Markdown/OrderedListNumbering:
+  Description: Use sequential numbers or repeated ones in ordered lists.
+  Enabled: false
+  EnforcedStyle: sequential
+  SupportedStyles:
+    - sequential
+    - ones

data/config/cops/markdown/outside_spacing.yml

@@ -0,0 +1,3 @@
+Markdown/OutsideSpacing:
+  Description: 'Report inline formatting directly adjacent to prose words.'
+  Enabled: true

data/config/cops/markdown/proper_names.yml

@@ -0,0 +1,5 @@
+Markdown/ProperNames:
+  Description: 'Use configured capitalization for proper names.'
+  Enabled: false
+  Names: []
+  CodeBlocks: false

data/config/cops/markdown/raw_html.yml

@@ -0,0 +1,4 @@
+Markdown/RawHtml:
+  Description: 'Disallow raw HTML except explicitly allowed elements.'
+  Enabled: false
+  AllowedElements: []

data/config/cops/markdown/reference_definitions.yml

@@ -0,0 +1,8 @@
+Markdown/ReferenceDefinitions:
+  Description: 'Report unused and duplicate reference definitions.'
+  Enabled: true
+  CheckUnused: false
+  CheckDuplicates: true
+  AllowIdenticalDuplicates: false
+  IgnoredDefinitions:
+    - '//'

data/config/cops/markdown/reversed_link.yml

@@ -0,0 +1,3 @@
+Markdown/ReversedLink:
+  Description: 'Report reversed Markdown link delimiters.'
+  Enabled: true

data/config/cops/markdown/shell_prompts.yml

@@ -0,0 +1,13 @@
+Markdown/ShellPrompts:
+  Description: Omit configured shell prompts in examples without output.
+  Enabled: true
+  Prompts:
+    - '$'
+    - '%'
+  ShellLanguages:
+    - bash
+    - console
+    - ksh
+    - sh
+    - shell
+    - zsh

data/config/cops/markdown/single_top_level_heading.yml

@@ -0,0 +1,4 @@
+Markdown/SingleTopLevelHeading:
+  Description: 'Allow at most one top-level heading.'
+  Enabled: false
+  Level: 1

data/config/cops/markdown/strong_style.yml

@@ -0,0 +1,4 @@
+Markdown/StrongStyle:
+  Description: 'Use a configured or consistent strong delimiter.'
+  Enabled: true
+  Style: consistent

data/config/cops/markdown/structural_line_length.yml

@@ -0,0 +1,9 @@
+Markdown/StructuralLineLength:
+  Description: Report overlong heading, code-block, and table source lines without reflowing them.
+  Enabled: false
+  Max: 80
+  Headings: true
+  HeadingMax:
+  CodeBlocks: false
+  CodeBlockMax:
+  Tables: false

data/config/cops/markdown/syntax.yml

@@ -0,0 +1,3 @@
+Markdown/Syntax:
+  Description: 'Report native Markdown parser diagnostics.'
+  Enabled: true

data/config/cops/markdown/table_blank_lines.yml

@@ -0,0 +1,3 @@
+Markdown/TableBlankLines:
+  Description: 'Surround Markdown tables with blank lines.'
+  Enabled: true

data/config/cops/markdown/table_columns.yml

@@ -0,0 +1,3 @@
+Markdown/TableColumns:
+  Description: 'Match table body column counts to the header.'
+  Enabled: true

data/config/cops/markdown/table_pipes.yml

@@ -0,0 +1,4 @@
+Markdown/TablePipes:
+  Description: 'Use consistent leading and trailing table pipes.'
+  Enabled: true
+  Style: consistent

data/config/cops/markdown/table_spacing.yml

@@ -0,0 +1,4 @@
+Markdown/TableSpacing:
+  Description: 'Use configured spacing around table cell content.'
+  Enabled: true
+  Style: aligned

data/config/cops/markdown/thematic_break_blank_lines.yml

@@ -0,0 +1,5 @@
+Markdown/ThematicBreakBlankLines:
+  Description: Surround parsed thematic breaks with container-aware blank lines.
+  Enabled: true
+  LinesAbove: 1
+  LinesBelow: 1

data/config/cops/markdown/thematic_break_style.yml

@@ -0,0 +1,4 @@
+Markdown/ThematicBreakStyle:
+  Description: 'Use configured or consistent thematic breaks.'
+  Enabled: true
+  Style: consistent

data/config/cops/markdown/trailing_whitespace.yml

@@ -0,0 +1,5 @@
+Markdown/TrailingWhitespace:
+  Description: 'Remove trailing whitespace while retaining Markdown hard breaks.'
+  Enabled: true
+  HardBreakSpaces: 2
+  CodeBlocks: false

data/config/cops/markdown/unclosed_fenced_code_block.yml

@@ -0,0 +1,3 @@
+Markdown/UnclosedFencedCodeBlock:
+  Description: Require an explicit closing fence for fenced code blocks.
+  Enabled: true

data/config/cops/markdown/undefined_reference.yml

@@ -0,0 +1,4 @@
+Markdown/UndefinedReference:
+  Description: 'Require definitions for link and image references.'
+  Enabled: true
+  ShortcutSyntax: false

data/config/cops/markdown/unordered_list_indentation.yml

@@ -0,0 +1,4 @@
+Markdown/UnorderedListIndentation:
+  Description: Use a configured indentation width for unordered lists.
+  Enabled: true
+  Indent: 2

data/config/cops/markdown/unordered_list_marker.yml

@@ -0,0 +1,9 @@
+Markdown/UnorderedListMarker:
+  Description: Use a configured or consistent unordered list marker.
+  Enabled: true
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - consistent
+    - asterisk
+    - plus
+    - dash

data/config/cops/prose/max_length.yml

@@ -0,0 +1,5 @@
+Prose/MaxLength:
+  Description: 'Wrap or unwrap prose paragraphs in Markdown and plain text.'
+  Enabled: true
+  Max: false
+  IgnoreURLs: true

data/config/cops/prose/multiple_blank_lines.yml

@@ -0,0 +1,4 @@
+Prose/MultipleBlankLines:
+  Description: 'Limit consecutive blank lines in prose, including Markdown blockquotes.'
+  Enabled: true
+  Max: 1

data/config/cops/prose/trailing_newline.yml

@@ -0,0 +1,3 @@
+Prose/TrailingNewline:
+  Description: 'Require exactly one final newline.'
+  Enabled: true

data/config/cops/text/trailing_whitespace.yml

@@ -0,0 +1,3 @@
+Text/TrailingWhitespace:
+  Description: Remove all trailing spaces and tabs from plain-text lines.
+  Enabled: true

data/config/default.yml

@@ -0,0 +1,16 @@
+Markdown:
+  Include:
+    - '**/*.[mM][dD]'
+    - '**/*.[mM][aA][rR][kK][dD][oO][wW][nN]'
+    - '**/*.[mM][dD][oO][wW][nN]'
+    - '**/*.[mM][dD][wW][nN]'
+    - '**/*.[mM][kK][dD]'
+    - '**/*.[mM][kK][dD][nN]'
+    - '**/*.[mM][kK][dD][oO][wW][nN]'
+    - '**/*.[lL][iI][vV][eE][mM][dD]'
+    - '**/*.[rR][oO][nN][nN]'
+    - '**/*.[sS][cC][dD]'
+    - '**/*.[wW][oO][rR][kK][bB][oO][oO][kK]'
+Text:
+  Include:
+    - '**/*.[tT][xX][tT]'

data/docs/cops/markdown/atx_heading_space.md

@@ -0,0 +1,26 @@
+# Markdown/AtxHeadingSpace
+
+Reports a missing separator after one to six opening heading hashes, such as `##Title`, including in lists and blockquotes. A space or tab is accepted.
+
+Report-only: inserting a space could turn intentional text into a heading.
+
+## Configuration
+
+```yaml
+Markdown/AtxHeadingSpace:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+#Title
+```
+
+### Good
+
+```markdown
+# Title
+```

data/docs/cops/markdown/atx_heading_spacing.md

@@ -0,0 +1,24 @@
+# Markdown/AtxHeadingSpacing
+
+Replaces multiple spaces or tabs after opening heading hashes with one space. Empty headings and a single separating tab are accepted.
+
+## Configuration
+
+```yaml
+Markdown/AtxHeadingSpacing:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+#  Title
+```
+
+### Good
+
+```markdown
+# Title
+```

data/docs/cops/markdown/bare_url.md

@@ -0,0 +1,30 @@
+# Markdown/BareUrl
+
+Reports bare URLs in prose. Use `<https://example.test/docs>` or `[the documentation](https://example.test/docs)` instead.
+
+Report-only: choose an autolink or descriptive label when fixing the URL.
+
+## Configuration
+
+```yaml
+Markdown/BareUrl:
+  Enabled: false
+  Schemes: # An empty list disables URL matching.
+    - http
+    - https
+    - ftp
+```
+
+## Example
+
+### Bad
+
+```markdown
+Visit https://example.test/guide.
+```
+
+### Good
+
+```markdown
+Visit [the guide](https://example.test/guide).
+```

data/docs/cops/markdown/blockquote_blank_lines.md

@@ -0,0 +1,30 @@
+# Markdown/BlockquoteBlankLines
+
+Adds quote markers to blank lines between adjacent blockquotes, preserving nesting and indentation.
+
+This treats adjacent quotes as one quotation. Separate them with other content if they should remain distinct.
+
+## Configuration
+
+```yaml
+Markdown/BlockquoteBlankLines:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+> First paragraph.
+
+> Second paragraph.
+```
+
+### Good
+
+```markdown
+> First paragraph.
+>
+> Second paragraph.
+```

data/docs/cops/markdown/blockquote_spacing.md

@@ -0,0 +1,30 @@
+# Markdown/BlockquoteSpacing
+
+Requires one space after each nonempty blockquote marker, including nested markers, and replaces multiple spaces or tabs with one space. This cop is enabled by default.
+
+Empty quote lines and indentation inside quoted lists and code are preserved. Missing separators are autocorrected only when reparsing confirms the Markdown structure is unchanged; otherwise, the offense is report-only.
+
+## Configuration
+
+```yaml
+Markdown/BlockquoteSpacing:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+>A quotation.
+>  A quotation.
+>>A nested quotation.
+```
+
+### Good
+
+```markdown
+> A quotation.
+> A quotation.
+> > A nested quotation.
+```

data/docs/cops/markdown/closed_heading_space.md

@@ -0,0 +1,26 @@
+# Markdown/ClosedHeadingSpace
+
+Reports hashes attached to the end of heading text, such as `# Title#`. Missing opening separators belong to [Markdown/AtxHeadingSpace](atx_heading_space.md).
+
+Report-only: suffixes such as `# C#` may be intentional, and adding a space changes the heading's rendered text.
+
+## Configuration
+
+```yaml
+Markdown/ClosedHeadingSpace:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+# Title#
+```
+
+### Good
+
+```markdown
+# Title #
+```

data/docs/cops/markdown/closed_heading_spacing.md

@@ -0,0 +1,24 @@
+# Markdown/ClosedHeadingSpacing
+
+Replaces multiple spaces or tabs before closing heading hashes with one space, leaving the hashes intact. A single separating tab is accepted.
+
+## Configuration
+
+```yaml
+Markdown/ClosedHeadingSpacing:
+  Enabled: true
+```
+
+## Example
+
+### Bad
+
+```markdown
+# Title  #
+```
+
+### Good
+
+```markdown
+# Title #
+```