pub struct MD072FrontmatterKeySort { /* private fields */ }Expand description
Rule MD072: Frontmatter key sort
Ensures frontmatter keys are sorted alphabetically. Supports YAML, TOML, and JSON frontmatter formats. Auto-fix is only available when frontmatter contains no comments (YAML/TOML). JSON frontmatter is always auto-fixable since JSON has no comments.
Note: This rule is disabled by default because alphabetical key sorting is an opinionated style choice. Many projects prefer semantic ordering (title first, date second, etc.) rather than alphabetical.
See docs/md072.md for full documentation.
Implementations§
Source§impl MD072FrontmatterKeySort
impl MD072FrontmatterKeySort
pub fn new() -> Self
Sourcepub fn from_config_struct(config: MD072Config) -> Self
pub fn from_config_struct(config: MD072Config) -> Self
Create from a config struct
Trait Implementations§
Source§impl Clone for MD072FrontmatterKeySort
impl Clone for MD072FrontmatterKeySort
Source§fn clone(&self) -> MD072FrontmatterKeySort
fn clone(&self) -> MD072FrontmatterKeySort
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Default for MD072FrontmatterKeySort
impl Default for MD072FrontmatterKeySort
Source§fn default() -> MD072FrontmatterKeySort
fn default() -> MD072FrontmatterKeySort
Returns the “default value” for a type. Read more
Source§impl Rule for MD072FrontmatterKeySort
impl Rule for MD072FrontmatterKeySort
fn name(&self) -> &'static str
fn description(&self) -> &'static str
fn check(&self, ctx: &LintContext<'_>) -> LintResult
fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>
Source§fn category(&self) -> RuleCategory
fn category(&self) -> RuleCategory
Get the category of this rule for selective processing
fn as_any(&self) -> &dyn Any
Source§fn default_config_section(&self) -> Option<(String, Value)>
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,
fn from_config(config: &Config) -> Box<dyn Rule>where
Self: Sized,
Factory: create a rule from config (if present), or use defaults.
Source§fn should_skip(&self, _ctx: &LintContext<'_>) -> bool
fn should_skip(&self, _ctx: &LintContext<'_>) -> bool
Check if this rule should quickly skip processing based on content
Source§fn config_aliases(&self) -> Option<HashMap<String, String>>
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
fn fix_capability(&self) -> FixCapability
Declares the fix capability of this rule
Source§fn cross_file_scope(&self) -> CrossFileScope
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,
)
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
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§
impl Freeze for MD072FrontmatterKeySort
impl RefUnwindSafe for MD072FrontmatterKeySort
impl Send for MD072FrontmatterKeySort
impl Sync for MD072FrontmatterKeySort
impl Unpin for MD072FrontmatterKeySort
impl UnwindSafe for MD072FrontmatterKeySort
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
Mutably borrows from an owned value. Read more
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>
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 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>
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