Struct CodemodRule 

pub struct CodemodRule {
    pub name: String,
    pub description: String,
    pub language: String,
    pub version: String,
    pub pattern: RulePattern,
    pub config: RuleConfig,
}

A complete codemod rule, suitable for serialization to/from YAML.

Fields

name: String

Unique rule name (kebab-case recommended).

description: String

Human-readable description of what the rule does.

language: String

Target programming language (e.g. "rust", "javascript").

version: String

Semantic version of the rule (default "1.0").

pattern: RulePattern

The before/after transformation pattern.

config: RuleConfig

Optional scanning configuration.

Implementations

impl CodemodRule

pub fn validate(&self) -> Result<()>

Validate the rule, checking for missing or inconsistent fields.

Errors

Returns CodemodError::Rule if validation fails.

pub fn to_pattern(&self) -> Pattern

Convert this rule into a Pattern by parsing the before/after templates and extracting variables.

Variables are detected by the $name syntax in the templates.

Trait Implementations

impl Clone for CodemodRule

fn clone(&self) -> CodemodRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodemodRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodemodRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CodemodRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.