Struct MD054LinkImageStyle 

pub struct MD054LinkImageStyle { /* private fields */ }

Rule MD054: Link and image style should be consistent

This rule is triggered when different link or image styles are used in the same document. Markdown supports various styles for links and images, and this rule enforces consistency.

Supported Link Styles

• Autolink: <https://example.com>
• Inline: [link text](https://example.com)
• URL Inline: Special case of inline links where the URL itself is also the link text: [https://example.com](https://example.com)
• Shortcut: [link text] (requires a reference definition elsewhere in the document)
• Collapsed: [link text][] (requires a reference definition with the same name)
• Full: [link text][reference] (requires a reference definition for the reference)

Configuration Options

You can configure which link styles are allowed. By default, all styles are allowed:

MD054:
  autolink: true    # Allow autolink style
  inline: true      # Allow inline style
  url_inline: true  # Allow URL inline style
  shortcut: true    # Allow shortcut style
  collapsed: true   # Allow collapsed style
  full: true        # Allow full style

To enforce a specific style, set only that style to true and all others to false.

Unicode Support

This rule fully supports Unicode characters in link text and URLs, including:

• Combining characters (e.g., café)
• Zero-width joiners (e.g., family emojis: 👨‍👩‍👧‍👦)
• Right-to-left text (e.g., Arabic, Hebrew)
• Emojis and other special characters

Rationale

Consistent link styles improve document readability and maintainability. Different link styles have different advantages (e.g., inline links are self-contained, reference links keep the content cleaner), but mixing styles can create confusion.

Implementations

impl MD054LinkImageStyle

pub fn new( autolink: bool, collapsed: bool, full: bool, inline: bool, shortcut: bool, url_inline: bool, ) -> Self

pub fn from_config_struct(config: MD054Config) -> Self

Trait Implementations

impl Clone for MD054LinkImageStyle

fn clone(&self) -> MD054LinkImageStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MD054LinkImageStyle

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

Formats the value using the given formatter.

impl Default for MD054LinkImageStyle

fn default() -> MD054LinkImageStyle

Returns the “default value” for a type.

impl Rule for MD054LinkImageStyle

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

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

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

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

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule

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

Check if this rule should quickly skip processing based on content

fn as_any(&self) -> &dyn Any

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.

fn from_config(config: &Config) -> Box<dyn Rule>

where Self: Sized,

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

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

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