feat: add Fixer enum

part of #656

crates/config/src/fixer.rs

@@ -0,0 +1,31 @@
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+/// A pattern string or fix object to auto fix the issue.
+/// It can reference metavariables appeared in rule.
+#[derive(Serialize, Deserialize, Clone, JsonSchema)]
+#[serde(untagged)]
+pub enum Fixer {
+ Str(String),
+ // Config(FixConfig),
+}
+
+// #[derive(Serialize, Deserialize, Clone, JsonSchema)]
+// pub struct FixConfig {
+// template: String,
+// forward_expand: String,
+// backward_expand: String,
+// prepend: String,
+// }
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::from_str;
+
+ #[test]
+ fn test_parse() {
+ let fixer: Fixer = from_str("test").expect("should parse");
+ assert!(matches!(fixer, Fixer::Str(_)));
+ }
+}

crates/config/src/lib.rs

@@ -1,5 +1,6 @@
 mod combined;
 mod constraints;
+mod fixer;
 mod maybe;
 mod rule;
 mod rule_collection;

crates/config/src/rule_config.rs

@@ -1,3 +1,4 @@
+use crate::fixer::Fixer;
 use crate::rule::{RuleSerializeError, SerializableRule};
 use crate::transform::Transformation;
 use crate::DeserializeEnv;
@@ -114,7 +115,7 @@ pub struct SerializableRuleConfig<L: Language> {
  #[serde(default)]
  pub severity: Severity,
  /// A pattern to auto fix the issue. It can reference metavariables appeared in rule.
- pub fix: Option<String>,
+ pub fix: Option<Fixer>,
  /// Glob patterns to specify that the rule only applies to matching files
  pub files: Option<Vec<String>>,
  /// Glob patterns that exclude rules from applying to files
@@ -129,7 +130,7 @@ type RResult<T> = std::result::Result<T, RuleConfigError>;
 
 impl<L: Language> SerializableRuleConfig<L> {
  fn get_fixer(&self) -> RResult<Option<TemplateFix<String>>> {
- if let Some(fix) = &self.fix {
+ if let Some(Fixer::Str(fix)) = &self.fix {
  if let Some(trans) = &self.transform {
  let keys: Vec<_> = trans.keys().cloned().collect();
  Ok(Some(TemplateFix::with_transform(