Struct ast_grep_config::SerializableRuleConfig

pub struct SerializableRuleConfig<L: Language> {
    pub core: SerializableRuleCore<L>,
    pub id: String,
    pub message: String,
    pub note: Option<String>,
    pub severity: Severity,
    pub transform: Option<HashMap<String, Transformation>>,
    pub fix: Option<String>,
    pub files: Option<Vec<String>>,
    pub ignores: Option<Vec<String>>,
    pub url: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
}

Fields

core: SerializableRuleCore<L>

id: String

Unique, descriptive identifier, e.g., no-unused-variable

message: String

Main message highlighting why this rule fired. It should be single line and concise, but specific enough to be understood without additional context.

note: Option<String>

Additional notes to elaborate the message and provide potential fix to the issue.

severity: Severity

One of: hint, info, warning, or error

transform: Option<HashMap<String, Transformation>>

A dictionary for meatvariable manipulation. Dict key is the new variable name. Dict value is a [transformation] that specifies how meta var is processed. Warning: this is experimental option. https://github.com/ast-grep/ast-grep/issues/436

fix: Option<String>

A pattern to auto fix the issue. It can reference metavariables appeared in rule.

files: Option<Vec<String>>

Glob patterns to specify that the rule only applies to matching files

ignores: Option<Vec<String>>

Glob patterns that exclude rules from applying to files

url: Option<String>

Documentation link to this rule

metadata: Option<HashMap<String, String>>

Extra information for the rule

Methods from Deref<Target = SerializableRuleCore<L>>

pub fn get_matcher( &self, globals: &GlobalRules<L> ) -> Result<RuleWithConstraint<L>, RuleConfigError>

Trait Implementations

impl<L: Clone + Language> Clone for SerializableRuleConfig<L>

fn clone(&self) -> SerializableRuleConfig<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Language> Deref for SerializableRuleConfig<L>

type Target = SerializableRuleCore<L>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<L: Language> DerefMut for SerializableRuleConfig<L>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, L> Deserialize<'de> for SerializableRuleConfig<L>where L: Deserialize<'de> + Language,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<L> Serialize for SerializableRuleConfig<L>where L: Serialize + Language,

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

Serialize this value into the given Serde serializer.