yerba 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03e5cb5c88654843c8c86735f91d1e550e81282ccd1c0db8813527c4b4f9898
-  data.tar.gz: 805516b5ce364c09dab736e562f4a09d312d70b75ceb2c9e22a9e63fad45eb6d
+  metadata.gz: c8388badb1c673c2f6815631a955f731b1699ed4f6aea305a73519e2f231d63c
+  data.tar.gz: dc153bff8304870d85e4631e794d04a4ec107d93fc8a7b8738845e2b3ead7133
 SHA512:
-  metadata.gz: 9cb2ace3f935a023bdd938cde43010f158efc18fce052a7fe5780cf3f9362779d0bc66a463f60453586b24e0b2e6b2ed180cf7d71d2f99095b57d0eb2adc92d8
-  data.tar.gz: a4946b677d5b05d2741a09749e540056376dc2d2724f12bc383d722974638576bfdf022a9a02587c75b4167d9d9ae644ddcb45ed6d3f86167423c8d7263c7ba3
+  metadata.gz: be8d6ee312803ab9fca14e5d3a692fcc601354144918d5e7ef9237348ec8a51be42ffec4cef0bef9a5a680477c8344578118b29f094dd9202944292db54683fd
+  data.tar.gz: 77f14d190d24bfbabc069a8ba015c813ff525564cc5c18767d9a6806f546526bd53555eeabff25e64da2bbbd6dc08a82f72b8443e75ac61250c0751bcc8755c7

data/README.md

@@ -539,6 +539,7 @@ Available pipeline steps:
 - `directives` Add or remove the document start marker (`---`), with optional `max` validation
 - `unique` Find or remove duplicate items in a sequence
 - `schema` Validate against a JSON schema (with optional `path` for scoping)
+- `final_newline` Enforce exact number of trailing newlines (`count: 1` by default, strips extras)
 
 This makes it easy to enforce project-wide YAML conventions in CI:
 

data/lib/yerba/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yerba
-  VERSION = "0.7.5"
+  VERSION = "0.7.6"
 end

data/rust/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yerba"
-version = "0.7.5"
+version = "0.7.6"
 edition = "2021"
 authors = ["Marco Roth <marco.roth@intergga.ch>"]
 description = "YAML Editing and Refactoring with Better Accuracy"

data/rust/src/document/style.rs

@@ -656,6 +656,18 @@ impl Document {
     self.reparse(&new_source)
   }
 
+  pub fn enforce_final_newline(&mut self, count: usize) -> Result<(), YerbaError> {
+    let source = self.to_string();
+    let trimmed = source.trim_end_matches('\n');
+    let expected = format!("{}{}", trimmed, "\n".repeat(count));
+
+    if source != expected {
+      self.reparse(&expected)
+    } else {
+      Ok(())
+    }
+  }
+
   pub fn enforce_key_style(&mut self, style: &crate::KeyStyle, dot_path: Option<&str>) -> Result<(), YerbaError> {
     let scope_ranges: Vec<TextRange> = match dot_path {
       Some(path) if !path.is_empty() => self.navigate_all_compact(path).iter().map(|node| node.text_range()).collect(),

data/rust/src/yerbafile.rs

@@ -41,6 +41,7 @@ pub enum PipelineStep {
   Directives(DirectivesConfig),
   Unique(UniqueConfig),
   Schema(SchemaConfig),
+  FinalNewline(FinalNewlineConfig),
 }
 
 #[derive(Debug, Clone, Deserialize)]
@@ -95,6 +96,16 @@ pub struct SchemaConfig {
   pub items: bool,
 }
 
+#[derive(Debug, Clone, Deserialize)]
+pub struct FinalNewlineConfig {
+  #[serde(default = "default_one")]
+  pub count: usize,
+}
+
+fn default_one() -> usize {
+  1
+}
+
 #[derive(Debug, Clone, Deserialize)]
 pub struct RenameConfig {
   pub from: String,
@@ -188,8 +199,13 @@ impl<'de> Deserialize<'de> for PipelineStep {
       return Ok(PipelineStep::Schema(config));
     }
 
+    if let Some(value) = mapping.get(yaml_serde::Value::String("final_newline".to_string())) {
+      let config: FinalNewlineConfig = yaml_serde::from_value(value.clone()).map_err(serde::de::Error::custom)?;
+      return Ok(PipelineStep::FinalNewline(config));
+    }
+
     Err(serde::de::Error::custom(
-      "unknown pipeline step: expected sort_keys, quote_style, collection_style, sequence_indent, set, insert, delete, rename, remove, blank_lines, sort, directives, unique, or schema",
+      "unknown pipeline step: expected sort_keys, quote_style, collection_style, sequence_indent, set, insert, delete, rename, remove, blank_lines, sort, directives, unique, schema, or final_newline",
     ))
   }
 }
@@ -359,6 +375,22 @@ impl Yerbafile {
       results.extend(file_results);
     }
 
+    if !self.pipeline.is_empty() {
+      if let Some(ref global_glob) = self.files {
+        if let Ok(paths) = glob::glob(global_glob) {
+          let unprocessed: Vec<String> = paths
+            .filter_map(|entry| entry.ok())
+            .map(|path| path.to_string_lossy().to_string())
+            .filter(|file| !globally_processed.contains(file.as_str()))
+            .collect();
+
+          let global_results: Vec<RuleResult> = unprocessed.par_iter().map(|file| self.apply_global_pipeline_to_file(file, write)).collect();
+
+          results.extend(global_results);
+        }
+      }
+    }
+
     results
   }
 
@@ -436,9 +468,55 @@ impl Yerbafile {
       ran_global = true;
     }
 
+    if !ran_global && self.should_run_global_pipeline(file) {
+      results.push(self.apply_global_pipeline_to_file(file, write));
+    }
+
     results
   }
 
+  fn apply_global_pipeline_to_file(&self, file: &str, write: bool) -> RuleResult {
+    let mut document = match Document::parse_file(file) {
+      Ok(document) => document,
+      Err(error) => {
+        return RuleResult {
+          file: file.to_string(),
+          changed: false,
+          error: Some(error),
+        }
+      }
+    };
+
+    let original = document.to_string();
+
+    if let Err(error) = execute_pipeline(&mut document, &self.pipeline, None, file, self) {
+      return RuleResult {
+        file: file.to_string(),
+        changed: false,
+        error: Some(error),
+      };
+    }
+
+    let new_content = document.to_string();
+    let changed = new_content != original;
+
+    if changed && write {
+      if let Err(error) = fs::write(file, &new_content) {
+        return RuleResult {
+          file: file.to_string(),
+          changed,
+          error: Some(YerbaError::IoError(error)),
+        };
+      }
+    }
+
+    RuleResult {
+      file: file.to_string(),
+      changed,
+      error: None,
+    }
+  }
+
   fn relativize_path(&self, file_path: &str) -> Option<String> {
     let path = Path::new(file_path);
 
@@ -744,6 +822,8 @@ fn execute_step(document: &mut Document, step: &PipelineStep, base_path: Option<
 
       Ok(())
     }
+
+    PipelineStep::FinalNewline(config) => document.enforce_final_newline(config.count),
   }
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yerba
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Marco Roth