Skip to content

table-pipe-alignment.md

Latest commit

 

History

History
144 lines (101 loc) · 4.6 KB

table-pipe-alignment.md

File metadata and controls

144 lines (101 loc) · 4.6 KB
pageClass rule-details
sidebarDepth 0
title markdown-preferences/table-pipe-alignment
description enforce consistent alignment of table pipes
since v0.25.0

markdown-preferences/table-pipe-alignment

enforce consistent alignment of table pipes

  • ⚙️ This rule is included in plugin.configs.standard.
  • 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

📖 Rule Details

This rule enforces consistent alignment of pipes (|) in Markdown tables. It ensures that the vertical bars separating table columns are aligned according to the specified style, improving readability and consistency. Misaligned pipes, such as those with inconsistent spacing or jagged columns, will be reported as problems. The rule can automatically fix many alignment issues using the --fix option.

<!-- eslint markdown-preferences/table-pipe-alignment: 'error' -->

<!-- ✓ GOOD -->

| User Name | Date Of Birth | Favorite Color |
| --------- | ------------- | -------------- |
| Alice     | 2000-01-01    | Blue           |
| Bob       | 1995-05-23    | Green          |

<!-- ✗ BAD -->

| User Name | Date Of Birth | Favorite Color |
| --- | --- | --- |
| Alice | 2000-01-01 | Blue |
| Bob | 1995-05-23 | Green |

🔧 Options

{
  "markdown-preferences/table-pipe-alignment": [
    "error",
    {
      "column": "minimum",
      "delimiterMinLength": 3
    }
  ]
}
  • column: Specifies the alignment style for table pipes. Possible values are:
    • "minimum" (default): Aligns pipes to the minimum necessary positions based on the content.
    • "consistent": Ensures that all pipes in a column are aligned consistently, based on the first row's alignment. However, if there are cells longer than the first row, they will be adjusted accordingly.
  • delimiterMinLength: Specifies the minimum length for table delimiter markers. Possible values are:
    • number (default: 3): Forces all delimiters to be at least this length. If you want to use a value less than 3, please use the object format.
    • "minimum": Uses the minimum required length for each delimiter type (----: 1, :---: 2, ---:: 2, :--:: 3).
    • object: Allows fine-grained control per delimiter type:
      • defaultDelimiter: Length for default delimiters (----).
      • leftAlignmentDelimiter: Length for left-aligned delimiters (:---).
      • centerAlignmentDelimiter: Length for center-aligned delimiters (:--:).
      • rightAlignmentDelimiter: Length for right-aligned delimiters (---:).

Examples for delimiterMinLength Option

Number Value

<!-- eslint markdown-preferences/table-pipe-alignment: ['error', { delimiterMinLength: 3 }] -->

<!-- ✓ GOOD -->

| No  | Header 1 | Header 2 |
| --- | -------- | -------- |
| 1   | Value 1  | Value 2  |
| 2   | Value 3  | Value 4  |

<!-- ✗ BAD -->

| No | Header 1 | Header 2 |
| -- | -------- | -------- |
| 1  | Value 1  | Value 2  |
| 2  | Value 3  | Value 4  |

Object Value

<!-- eslint markdown-preferences/table-pipe-alignment: ['error', { delimiterMinLength: { defaultDelimiter: 5, centerAlignmentDelimiter: 7, rightAlignmentDelimiter: 2 } }] -->

<!-- ✓ GOOD -->

| L     | C       | R  |
| ----- | :-----: | -: |
| A     | B       | C  |

<!-- ✗ BAD -->

| L    | C      | R   |
| ---- | :----: | --: |
| A    | B      | C   |

📚 Further Reading

👫 Related Rules

🚀 Version

This rule was introduced in eslint-plugin-markdown-preferences v0.25.0

🔍 Implementation