MD038NoSpaceInCode

Struct MD038NoSpaceInCode 

Source
pub struct MD038NoSpaceInCode {
    pub enabled: bool,
    pub allow_intentional_spaces: bool,
    pub allow_single_char_spaces: bool,
    pub allow_command_spaces: bool,
}
Expand description

Rule MD038: No space inside code span markers

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

MD038: Spaces inside code span elements

This rule is triggered when there are spaces inside code span elements.

For example:

` some text`
`some text `
` some text `

To fix this issue, remove the leading and trailing spaces within the code span markers:

`some text`

Note: Code spans containing backticks (e.g., `backticks` inside) are not flagged to avoid breaking nested backtick structures used to display backticks in documentation.

Fields§

§enabled: bool§allow_intentional_spaces: bool

Allow leading/trailing spaces in code spans when they improve readability

§allow_single_char_spaces: bool

Allow spaces around single characters (e.g., y for visibility)

§allow_command_spaces: bool

Allow spaces in command examples (heuristic: contains common shell indicators)

Implementations§

Source§

impl MD038NoSpaceInCode

Source

pub fn new() -> Self

Source

pub fn strict() -> Self

Trait Implementations§

Source§

impl Clone for MD038NoSpaceInCode

Source§

fn clone(&self) -> MD038NoSpaceInCode

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 MD038NoSpaceInCode

Source§

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

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

impl Default for MD038NoSpaceInCode

Source§

fn default() -> Self

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

impl DocumentStructureExtensions for MD038NoSpaceInCode

Source§

fn has_relevant_elements( &self, ctx: &LintContext<'_>, _doc_structure: &DocumentStructure, ) -> bool

Check if content contains elements relevant to this rule
Source§

fn should_process_line( &self, line_num: usize, doc_structure: &DocumentStructure, ) -> bool

Check if a rule should operate on a given line
Source§

impl Rule for MD038NoSpaceInCode

Source§

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

Check if content is likely to have code spans

Source§

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

Source§

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

Source§

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing
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 as_maybe_document_structure(&self) -> Option<&dyn MaybeDocumentStructure>

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 check_with_structure( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, ) -> LintResult

Enhanced check method using document structure By default, calls the regular check method if not overridden
Source§

fn check_with_ast( &self, ctx: &LintContext<'_>, _ast: &MarkdownAst, ) -> LintResult

AST-based check method for rules that can benefit from shared AST parsing By default, calls the regular check method if not overridden
Source§

fn check_with_structure_and_ast( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, _ast: &MarkdownAst, ) -> LintResult

Combined check method using both document structure and AST By default, calls the regular check method if not overridden
Source§

fn uses_ast(&self) -> bool

Check if this rule can benefit from AST parsing
Source§

fn uses_document_structure(&self) -> bool

Check if this rule can benefit from document structure
Source§

fn as_maybe_ast(&self) -> Option<&dyn MaybeAst>

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

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> MaybeDocumentStructure for T
where T: Rule + DocumentStructureExtensions + 'static,

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,