MD060TableFormat

Struct MD060TableFormat 

Source
pub struct MD060TableFormat { /* private fields */ }
Expand description

Rule MD060: Table Column Alignment

See docs/md060.md for full documentation, configuration, and examples.

This rule enforces consistent column alignment in Markdown tables for improved readability in source form. When enabled, it ensures table columns are properly aligned with appropriate padding.

§Purpose

  • Readability: Aligned tables are significantly easier to read in source form
  • Maintainability: Properly formatted tables are easier to edit and review
  • Consistency: Ensures uniform table formatting throughout documents
  • Developer Experience: Makes working with tables in plain text more pleasant

§Configuration Options

The rule supports the following configuration options:

[MD013]
line-length = 100  # MD060 inherits this by default

[MD060]
enabled = false      # Default: opt-in for conservative adoption
style = "aligned"    # Can be "aligned", "compact", "tight", or "any"
max-width = 0        # Default: inherit from MD013's line-length

§Style Options

  • aligned: Columns are padded with spaces for visual alignment (default)
  • compact: Minimal spacing with single spaces
  • tight: No spacing, pipes directly adjacent to content
  • any: Preserve existing formatting style

§Max Width (auto-compact threshold)

Controls when tables automatically switch from aligned to compact formatting:

  • max-width = 0 (default): Smart inheritance from MD013
  • max-width = N: Explicit threshold, independent of MD013

When max-width = 0:

  • If MD013 is disabled → unlimited (no auto-compact)
  • If MD013.tables = false → unlimited (no auto-compact)
  • If MD013.line_length = 0 → unlimited (no auto-compact)
  • Otherwise → inherits MD013’s line-length

This matches the behavior of Prettier’s table formatting.

§Examples
# Inherit from MD013 (recommended)
[MD013]
line-length = 100

[MD060]
style = "aligned"
max-width = 0  # Tables exceeding 100 chars will be compacted
# Explicit threshold
[MD060]
style = "aligned"
max-width = 120  # Independent of MD013

§Examples

§Aligned Style (Good)

| Name  | Age | City      |
|-------|-----|-----------|
| Alice | 30  | Seattle   |
| Bob   | 25  | Portland  |

§Unaligned (Bad)

| Name | Age | City |
|---|---|---|
| Alice | 30 | Seattle |
| Bob | 25 | Portland |

§Unicode Support

This rule properly handles:

  • CJK Characters: Chinese, Japanese, Korean characters are correctly measured as double-width
  • Basic Emoji: Most emoji are handled correctly
  • Inline Code: Pipes in inline code blocks are properly masked

§Known Limitations

Complex Unicode Sequences: Tables containing certain Unicode characters are automatically skipped to prevent alignment corruption. These include:

  • Zero-Width Joiner (ZWJ) emoji: 👨‍👩‍👧‍👦, 👩‍💻
  • Zero-Width Space (ZWS): Invisible word break opportunities
  • Zero-Width Non-Joiner (ZWNJ): Ligature prevention marks
  • Word Joiner (WJ): Non-breaking invisible characters

These characters have inconsistent or zero display widths across terminals and fonts, making accurate alignment impossible. The rule preserves these tables as-is rather than risk corrupting them.

This is an honest limitation of terminal display technology, similar to what other tools like markdownlint experience.

§Fix Behavior

When applying automatic fixes, this rule:

  • Calculates proper display width for each column using Unicode width measurements
  • Pads cells with trailing spaces to align columns
  • Preserves cell content exactly (only spacing is modified)
  • Respects alignment indicators in delimiter rows (:---, :---:, ---:)
  • Automatically switches to compact mode for tables exceeding max_width
  • Skips tables with ZWJ emoji to prevent corruption

Implementations§

Source§

impl MD060TableFormat

Source

pub fn new(enabled: bool, style: String) -> Self

Source

pub fn from_config_struct( config: MD060Config, md013_config: MD013Config, md013_disabled: bool, ) -> Self

Trait Implementations§

Source§

impl Clone for MD060TableFormat

Source§

fn clone(&self) -> MD060TableFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MD060TableFormat

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MD060TableFormat

Source§

fn default() -> MD060TableFormat

Returns the “default value” for a type. Read more
Source§

impl Rule for MD060TableFormat

Source§

fn name(&self) -> &'static str

Source§

fn description(&self) -> &'static str

Source§

fn should_skip(&self, ctx: &LintContext<'_>) -> bool

Check if this rule should quickly skip processing based on content
Source§

fn check(&self, ctx: &LintContext<'_>) -> LintResult

Source§

fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>

Source§

fn as_any(&self) -> &dyn Any

Source§

fn default_config_section(&self) -> Option<(String, Value)>

Returns the rule name and default config table if the rule has config. If a rule implements this, it MUST be defined on the impl Rule for ... block, not just the inherent impl.
Source§

fn from_config(config: &Config) -> Box<dyn Rule>
where Self: Sized,

Factory: create a rule from config (if present), or use defaults.
Source§

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing
Source§

fn config_aliases(&self) -> Option<HashMap<String, String>>

Returns config key aliases for this rule This allows rules to accept alternative config key names for backwards compatibility
Source§

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule
Source§

fn cross_file_scope(&self) -> CrossFileScope

Declares cross-file analysis requirements for this rule Read more
Source§

fn contribute_to_index( &self, _ctx: &LintContext<'_>, _file_index: &mut FileIndex, )

Contribute data to the workspace index during linting Read more
Source§

fn cross_file_check( &self, _file_path: &Path, _file_index: &FileIndex, _workspace_index: &WorkspaceIndex, ) -> LintResult

Perform cross-file validation after all files have been linted Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more