Check if file is ignored according to git (#98)

Doesn't launch the job if the file is ignored.

There's a configuration parameter at the job level to disable this filtering.
Fix #32

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bacon"
-version = "2.2.8"
+version = "2.3.0-dev"
 authors = ["dystroy <denys.seguret@gmail.com>"]
 repository = "https://github.com/Canop/bacon"
 description = "background rust compiler"
@@ -9,24 +9,25 @@ keywords = ["rust", "background", "compiler", "watch", "inotify"]
 license = "AGPL-3.0"
 categories = ["command-line-utilities", "development-tools"]
 readme = "README.md"
-rust-version = "1.59"
+rust-version = "1.65"
 
 [dependencies]
-anyhow = "1.0.57"
+anyhow = "1.0.68"
 cargo_metadata = "0.14.0"
 clap = { version = "3.1", features = ["derive"] }
 cli-log = "2.0.0"
 coolor = "=0.5.0"
 crokey = "0.4.1"
-crossbeam = "0.8.1"
+crossbeam = "0.8.2"
 directories-next = "2.0.0"
+git-repository = "0.30.2"
 lazy-regex = "2.3.1"
-notify = "=5.0.0-pre.14"
+notify = "5.0.0"
 serde = { version = "1.0.136", features = ["derive"] }
-termimad = "0.20.4"
+termimad = "0.20.6"
 tokio = { version = "1.17.0", default-features = false, features = ["net", "sync", "process", "rt", "macros", "io-util"] }
 toml = "0.5.8"
-unicode-width = "0.1.9"
+unicode-width = "0.1.10"
 vte = "0.8"
 
 [profile.release]

bacon.toml

@@ -33,6 +33,7 @@ command = [
  "-A", "clippy::match_like_matches_macro",
  "-A", "clippy::neg_multiply",
  "-A", "clippy::vec_init_then_push",
+ "-A", "clippy::manual_clamp",
 ]
 need_stdout = false
 watch = ["tests", "benches", "examples"]

src/app.rs

@@ -15,10 +15,25 @@ pub fn run(
  event_source: &EventSource,
 ) -> Result<Option<JobRef>> {
  let keybindings = mission.settings.keybindings.clone();
+ let mut ignorer = time!(Info, mission.ignorer());
  let (watch_sender, watch_receiver) = bounded(0);
- let mut watcher = notify::recommended_watcher(move |res| match res {
- Ok(_) => {
- debug!("notify event received");
+ let mut watcher = notify::recommended_watcher(move |res: notify::Result<notify::Event>| match res {
+ Ok(we) => {
+ debug!("notify event: {we:?}");
+ if let Some(ignorer) = ignorer.as_mut() {
+ match time!(Info, ignorer.excludes_all(&we.paths)) {
+ Ok(true) => {
+ debug!("all excluded");
+ return;
+ }
+ Ok(false) => {
+ debug!("at least one is included");
+ }
+ Err(e) => {
+ warn!("exclusion check failed: {e}");
+ }
+ }
+ }
  if let Err(e) = watch_sender.send(()) {
  debug!("error when notifying on inotify event: {}", e);
  }
@@ -63,7 +78,6 @@ pub fn run(
  event_source.unblock(false);
  }
  recv(watch_receiver) -> _ => {
- debug!("got a watcher event");
  if let Err(e) = executor.start(state.new_task()) {
  debug!("error sending task: {}", e);
  } else {

src/command_result.rs

@@ -56,7 +56,7 @@ impl CommandResult {
  match self {
  Self::Report(report) => {
  let path = mission.bacon_locations_path();
- let mut file = File::create(&path)?;
+ let mut file = File::create(path)?;
  report.write_to(&mut file, mission)?;
  }
  Self::Failure(_) => { }

src/ignorer.rs

@@ -0,0 +1,70 @@
+use {
+ anyhow::{Context, Result},
+ git_repository::{
+ self as git,
+ prelude::FindExt,
+ Repository,
+ },
+ std::path::{Path, PathBuf},
+};
+
+/// An object able to tell whether a file is excluded
+/// by gitignore rules
+pub struct Ignorer {
+ repo: Repository,
+}
+
+impl Ignorer {
+
+ /// Create an Ignorer from any directory path: the closest
+ /// surrounding git repository will be found (if there's one)
+ /// and its gitignore rules used.
+ ///
+ /// root_path is assumed to exist and be a directory
+ pub(crate) fn new(root_path: &Path) -> Result<Self> {
+ let repo = git::discover(root_path)?;
+ Ok(Self { repo })
+ }
+
+ /// Tell whether the given path is excluded according to
+ /// either the global gitignore rules or the ones of the repository
+ pub fn excludes(&mut self, file_path: &Path) -> Result<bool> {
+ let worktree = self.repo.worktree().context("a worktree should exist")?;
+ let index = worktree.index()?;
+
+ // the "Cache" is the structure allowing checking exclusion
+ let mut cache = worktree.excludes(&index, None)?;
+
+ // cache.at_path panics if not provided a path relative
+ // to the work directory, so we compute the relative path
+ let Some(work_dir) = self.repo.work_dir() else {
+ return Ok(false);
+ };
+ let Ok(relative_path) = file_path.strip_prefix(work_dir) else {
+ return Ok(false);
+ };
+
+ // cache.at_path panics if the relative path is empty, so
+ // we must check that
+ if relative_path.as_os_str().is_empty() {
+ return Ok(true);
+ };
+
+ let platform = cache.at_path(relative_path, Some(file_path.is_dir()), |oid, buf| {
+ self.repo.objects.find_blob(oid, buf)
+ })?;
+
+ Ok(platform.is_excluded())
+ }
+
+ /// Return Ok(false) when at least one file is included (i.e. we should
+ /// execute the job)
+ pub fn excludes_all(&mut self, paths: &[PathBuf]) -> Result<bool> {
+ for path in paths {
+ if !self.excludes(path)? {
+ return Ok(false);
+ }
+ }
+ Ok(true)
+ }
+}

src/job.rs

@@ -33,6 +33,9 @@ pub struct Job {
  /// for "cargo run" jobs
  #[serde(default)]
  pub allow_warnings: bool,
+
+ /// whether gitignore rules must be applied
+ pub apply_gitignore: Option<bool>,
 }
 
 static DEFAULT_ARGS: &[&str] = &["--color", "always"];
@@ -59,6 +62,7 @@ impl Job {
  need_stdout: false,
  on_success: None,
  allow_warnings: false,
+ apply_gitignore: None,
  }
  }
 }

src/job_stack.rs

@@ -31,7 +31,7 @@ impl<'c> JobStack<'c> {
 
 
  pub fn pick_job(&mut self, job_ref: &JobRef) -> Result<Option<(ConcreteJobRef, Job)>> {
- info!("PICKING JOB {job_ref:?}");
+ debug!("picking job {job_ref:?}");
  let concrete = match job_ref {
  JobRef::Default => self.package_config.default_job.clone(),
  JobRef::Initial => self.initial_job().clone(),

src/line.rs

@@ -21,7 +21,6 @@ impl Line {
  pub fn location(&self) -> Option<&str> {
  match self.line_type {
  LineType::Location => {
- info!("CON: {:#?}", &self.content);
  self.content.strings.get(2).map(|ts| ts.raw.as_str())
  }
  _ => None,

src/main.rs

@@ -10,6 +10,7 @@ mod executor;
 mod failure;
 mod help_line;
 mod help_page;
+mod ignorer;
 mod internal;
 mod job;
 mod job_ref;
@@ -46,6 +47,7 @@ pub use {
  failure::*,
  help_line::*,
  help_page::*,
+ ignorer::*,
  internal::*,
  job::*,
  job_ref::*,

src/mission.rs

@@ -18,7 +18,7 @@ pub struct Mission<'s> {
  pub job_name: String,
  pub cargo_execution_directory: PathBuf,
  pub workspace_root: PathBuf,
- job: Job,
+ pub job: Job,
  files_to_watch: Vec<PathBuf>,
  directories_to_watch: Vec<PathBuf>,
  pub settings: &'s Settings,
@@ -77,6 +77,27 @@ impl<'s> Mission<'s> {
  })
  }
 
+ /// Return an Ignorer if required by the job's settings
+ /// and if the mission takes place in a git repository
+ pub fn ignorer(&self) -> Option<Ignorer> {
+ match self.job.apply_gitignore {
+ Some(false) => {
+ debug!("No gitignorer because of settings");
+ None
+ }
+ _ => { // by default we apply gitignore rules
+ match Ignorer::new(&self.workspace_root) {
+ Ok(ignorer) => Some(ignorer),
+ Err(e) => {
+ // might be normal, eg not in a git repo
+ debug!("Failed to initialise git ignorer: {e}");
+ None
+ }
+ }
+ }
+ }
+ }
+
  /// Return the path to the bacon-locations file
  pub fn bacon_locations_path(&self) -> PathBuf {
  self.workspace_root.join(".bacon-locations")

website/docs/config.md

@@ -91,6 +91,7 @@ watch | yes | A list of directories that will be watched if the job is run on a
 need_stdout | yes |whether we need to capture stdout too (stderr is always captured). Default is `false`
 on_success | yes | the action to run when there's no error, warning or test failures
 allow_warnings | yes | if true, the action is considered a success even when there are warnings. Default is `false` but the standard `run` job is configured with `allow_warnings=false`
+apply_gitignore | yes | if true (which is default) the job isn't triggered when the modified file is excluded by gitignore rules
 
 Example: