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§
Trait Implementations§
Source§impl Clone for MD038NoSpaceInCode
impl Clone for MD038NoSpaceInCode
Source§fn clone(&self) -> MD038NoSpaceInCode
fn clone(&self) -> MD038NoSpaceInCode
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MD038NoSpaceInCode
impl Debug for MD038NoSpaceInCode
Source§impl Default for MD038NoSpaceInCode
impl Default for MD038NoSpaceInCode
Source§impl DocumentStructureExtensions for MD038NoSpaceInCode
impl DocumentStructureExtensions for MD038NoSpaceInCode
Source§fn has_relevant_elements(
&self,
ctx: &LintContext<'_>,
_doc_structure: &DocumentStructure,
) -> bool
fn has_relevant_elements( &self, ctx: &LintContext<'_>, _doc_structure: &DocumentStructure, ) -> bool
Source§fn should_process_line(
&self,
line_num: usize,
doc_structure: &DocumentStructure,
) -> bool
fn should_process_line( &self, line_num: usize, doc_structure: &DocumentStructure, ) -> bool
Source§impl Rule for MD038NoSpaceInCode
impl Rule for MD038NoSpaceInCode
Source§fn should_skip(&self, ctx: &LintContext<'_>) -> bool
fn should_skip(&self, ctx: &LintContext<'_>) -> bool
Check if content is likely to have code spans
fn name(&self) -> &'static str
fn description(&self) -> &'static str
Source§fn category(&self) -> RuleCategory
fn category(&self) -> RuleCategory
fn check(&self, ctx: &LintContext<'_>) -> LintResult
fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>
fn as_any(&self) -> &dyn Any
fn as_maybe_document_structure(&self) -> Option<&dyn MaybeDocumentStructure>
Source§fn default_config_section(&self) -> Option<(String, Value)>
fn default_config_section(&self) -> Option<(String, Value)>
impl Rule for ...
block,
not just the inherent impl.Source§fn from_config(config: &Config) -> Box<dyn Rule>where
Self: Sized,
fn from_config(config: &Config) -> Box<dyn Rule>where
Self: Sized,
Source§fn check_with_structure(
&self,
ctx: &LintContext<'_>,
_structure: &DocumentStructure,
) -> LintResult
fn check_with_structure( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, ) -> LintResult
Source§fn check_with_ast(
&self,
ctx: &LintContext<'_>,
_ast: &MarkdownAst,
) -> LintResult
fn check_with_ast( &self, ctx: &LintContext<'_>, _ast: &MarkdownAst, ) -> LintResult
Source§fn check_with_structure_and_ast(
&self,
ctx: &LintContext<'_>,
_structure: &DocumentStructure,
_ast: &MarkdownAst,
) -> LintResult
fn check_with_structure_and_ast( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, _ast: &MarkdownAst, ) -> LintResult
Source§fn uses_document_structure(&self) -> bool
fn uses_document_structure(&self) -> bool
fn as_maybe_ast(&self) -> Option<&dyn MaybeAst>
Source§fn config_aliases(&self) -> Option<HashMap<String, String>>
fn config_aliases(&self) -> Option<HashMap<String, String>>
Source§fn fix_capability(&self) -> FixCapability
fn fix_capability(&self) -> FixCapability
Auto Trait Implementations§
impl Freeze for MD038NoSpaceInCode
impl RefUnwindSafe for MD038NoSpaceInCode
impl Send for MD038NoSpaceInCode
impl Sync for MD038NoSpaceInCode
impl Unpin for MD038NoSpaceInCode
impl UnwindSafe for MD038NoSpaceInCode
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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