Struct MD059LinkText 

pub struct MD059LinkText { /* private fields */ }

Rule MD059: Link text should be descriptive

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

This rule enforces that markdown links use meaningful, descriptive text rather than generic phrases. It triggers when link text matches prohibited terms like “click here,” “here,” “link,” or “more.”

Rationale

Descriptive link text is crucial for accessibility. Screen readers often present links without surrounding context, making generic text problematic for users relying on assistive technologies.

Examples

<!-- Bad -->
[click here](docs.md)
[link](api.md)
[more](details.md)

<!-- Good -->
[API documentation](docs.md)
[Installation guide](install.md)
[Full details](details.md)

Configuration

[MD059]
prohibited_texts = ["click here", "here", "link", "more"]

For non-English content, customize the prohibited texts:

[MD059]
prohibited_texts = ["hier klicken", "hier", "link", "mehr"]

Implementations

impl MD059LinkText

pub fn new(prohibited_texts: Vec<String>) -> Self

pub fn from_config_struct(config: MD059Config) -> Self

Trait Implementations

impl Clone for MD059LinkText

fn clone(&self) -> MD059LinkText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MD059LinkText

fn default() -> Self

Returns the “default value” for a type.

impl Rule for MD059LinkText

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

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

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

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 config_schema(&self) -> Option<(String, Value)>

Returns the rule name and every config key the rule accepts, for validation.

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

where Self: Sized,

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

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule

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

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

fn skippable_by_category(&self) -> bool

Whether the content-category prefilter may skip this rule.

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

fn polymorphic_config_keys(&self) -> &'static [&'static str]

Returns the list of config keys whose deserializer accepts more than one TOML type (e.g. either a scalar or a list). The schema is built from a serialized default that can only encode one variant, so the validator would reject the alternative form. The registry replaces the schema entry for each listed key with a polymorphic sentinel so type checking is skipped while the key name is still validated. The registry rewrites Rule::config_schema, so default_config_section() keeps returning the clean user-facing default.

fn cross_file_scope(&self) -> CrossFileScope

Declares cross-file analysis requirements for this rule

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

Contribute data to the workspace index during linting

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

fn observes_suppressions(&self) -> bool

Whether this rule reports on the inline comments that suppressed warnings

fn check_suppressions( &self, _ctx: &LintContext<'_>, _report: &SuppressionReport, ) -> LintResult

Report on a document’s inline disable comments