Skip to content

fix(cli): suppress watch-mode errors for paths under .git #11305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wahajahmed010 wants to merge 1 commit into
base: main
Choose a base branch
from
+76 −14
Open

fix(cli): suppress watch-mode errors for paths under .git #11305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-watcher-git-internal-errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@biomejs/biome": patch
---

Fixed [#11110](https://github.com/biomejs/biome/issues/11110): `biome lint --watch` and other watch-mode commands no longer emit `internalError/io` diagnostics for file events under `.git/` (such as `.git/index.lock`), and no longer surface transient filesystem errors reported by `notify` for paths that the watcher has no interest in.
85 changes: 71 additions & 14 deletions crates/biome_cli/src/runner/impls/watchers/default.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
use std::sync::mpsc::{Receiver, channel};

use crate::runner::diagnostics::WatcherDiagnostic;
use crate::runner::watcher::{Watcher, WatcherEvent};
use biome_diagnostics::{Error, NotifyError};
use camino::Utf8PathBuf;
use camino::{Utf8Path, Utf8PathBuf};
use tracing::warn;
use notify::event::{CreateKind, ModifyKind, RemoveKind};
use notify::{Event, EventKind, RecursiveMode, Result, recommended_watcher};
use tracing::warn;

pub(crate) struct DefaultWatcher {
rx: Receiver<Result<Event>>,
Expand All @@ -23,6 +21,20 @@ impl DefaultWatcher {
}
}

/// Returns `true` if the path lives inside a directory that Biome should not
/// surface to the user even when it appears in a watcher event.
///
/// Today this only covers the `.git` directory. It exists so that transient
/// VCS bookkeeping (such as `.git/index.lock` updates) does not produce
/// `internalError/io` diagnostics in `--watch` mode, even when the project's
/// `.gitignore` does not exclude `.git` or VCS integration is disabled.
fn is_internal_vcs_path(path: &Utf8Path) -> bool {
path.components().any(|c| match c {
camino::Utf8Component::Normal(part) => part == ".git",
_ => false,
})
}

impl Watcher for DefaultWatcher {
fn watch(&mut self, paths: Vec<Utf8PathBuf>) {
let mut watched_paths = self.watcher.paths_mut();
Expand All @@ -40,9 +52,17 @@ impl Watcher for DefaultWatcher {
fn poll(&mut self) -> Option<WatcherEvent> {
self.rx.iter().find_map(|event| {
match event {
Err(err) => Some(WatcherEvent::Error(WatcherDiagnostic {
source: Some(Error::from(NotifyError::from(err))),
})),
Err(err) => {
// `notify` surfaces filesystem errors that occur on the
// watched paths (for example, transient permission
// failures while reading a file inside `.git`). Those
// events should never reach Biome's error reporter, since
// they do not reflect problems with the user's code or
// configuration. Drop the event so the watcher keeps
// running.
warn!("Watcher event error (suppressed): {err}");
None
}
Comment on lines +55 to +65

@coderabbitai coderabbitai Bot Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟠 Major | 🏗️ Heavy lift

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

rg -n -C 8 'WatcherEvent::Error|notify::Error|ErrorKind|event\.paths|fn poll' \
  crates/biome_cli

Repository: biomejs/biome

Length of output: 25778

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- watcher implementation ---'
cat -n crates/biome_cli/src/runner/impls/watchers/default.rs | sed -n '1,150p'

printf '%s\n' '--- watcher event and consumer contract ---'
cat -n crates/biome_cli/src/runner/watcher.rs | sed -n '1,100p'
cat -n crates/biome_cli/src/runner/mod.rs | sed -n '350,415p'

printf '%s\n' '--- notify dependency declarations and uses ---'
rg -n -C 5 'notify|RecommendedWatcher|WatcherEvent' Cargo.toml Cargo.lock crates/biome_cli

Repository: biomejs/biome

Length of output: 28535

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- relevant tests and imports ---'
cat -n crates/biome_cli/src/runner/impls/watchers/default.rs | sed -n '85,160p'
rg -n -C 6 'is_internal_vcs_path|Utf8Path::|DefaultWatcher|watcher' crates/biome_cli/src/runner crates/biome_cli/tests 2>/dev/null || true

printf '%s\n' '--- notify source availability ---'
find . -path '*/notify-*' -o -path '*/notify' | head -30

Repository: biomejs/biome

Length of output: 50370

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- focused watcher tests ---'
sed -n '100,135p' crates/biome_cli/src/runner/impls/watchers/default.rs

printf '%s\n' '--- watcher diagnostics ---'
fd -t f . crates/biome_cli/src/runner | sort | xargs rg -n -C 5 'WatcherDiagnostic|notify|internalError/io'

printf '%s\n' '--- exact test imports and symbols ---'
python3 - <<'PY'
from pathlib import Path
p = Path("crates/biome_cli/src/runner/impls/watchers/default.rs")
text = p.read_text()
test = text.split("#[cfg(test)]", 1)[1]
print(test)
PY

printf '%s\n' '--- local cargo registry notify sources, if present ---'
find "${CARGO_HOME:-$HOME/.cargo}/registry/src" -maxdepth 3 \
  \( -path '*/notify-8.2.0/src/error.rs' -o -path '*/notify-types-2.0.0/src/*' \) \
  -print 2>/dev/null | head -20

Repository: biomejs/biome

Length of output: 7111

🌐 Web query:

notify 8.2.0 Error type paths ErrorKind documentation

💡 Result:

In the notify crate version 8.2.0, errors are represented by the notify::Error struct, which contains two primary fields: kind and paths [1][2]. The kind field is an instance of the notify::ErrorKind enum, which categorizes the type of error that occurred [3][1]. The paths field is a Vec that contains any filesystem paths relevant to the error, if applicable [1][2]. The ErrorKind enum includes the following variants: - Generic(String): Used for platform-specific mappings or opaque internal errors [3][4]. - Io(std::io::Error): Used for standard I/O errors [3][4]. - PathNotFound: Indicates that a specified path does not exist [3][4]. - WatchNotFound: Used when attempting to remove a watch that does not exist [3][4]. - InvalidConfig(Config): Indicates an invalid value was provided in the runtime configuration [3][4]. - MaxFilesWatch: Indicates the limit on the total number of inotify watches has been reached [3][4]. The Error struct provides methods to manage these paths, such as add_path(PathBuf) and set_paths(Vec), allowing users to associate specific filesystem targets with a given error instance [2]. Errors can be generated either during the creation of a Watcher or during the event stream [1].

Citations:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- check Rust child-module name resolution with a standalone snippet ---'
if command -v rustc >/dev/null 2>&1; then
    rustc --version
    if rustc - --crate-type=lib <<'RS'
use std::path::Path;

mod tests {
    fn uses_parent_import() {
        let _ = Path::new("x");
    }
}
RS
    then
        echo 'parent import is visible in the child module'
    else
        echo 'parent import is not visible in the child module'
    fi
else
    echo 'rustc unavailable'
fi

printf '%s\n' '--- diagnostic conversion declarations ---'
rg -n -C 8 'impl.*(From|Into).*notify|WatcherDiagnostic|pub struct Error|notify' \
  crates/biome_cli/src crates/biome_diagnostics/src crates/biome_*/* 2>/dev/null | head -250

Repository: biomejs/biome

Length of output: 20442

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- existing notify error handling ---'
sed -n '200,270p' crates/biome_service/src/scanner/watcher.rs
sed -n '135,165p' crates/biome_cli/src/runner/diagnostics.rs

printf '%s\n' '--- all watcher diagnostic constructors and conversions ---'
rg -n -C 8 'WatcherDiagnostic|WatchError|NotifyError|NotifyResult|Error::from|source:' \
  crates/biome_cli/src crates/biome_service/src | head -300

Repository: biomejs/biome

Length of output: 32747

Preserve non-VCS watcher errors.

If a notify::Error has no paths, includes a non-VCS path, or is not demonstrably transient, return WatcherEvent::Error. Suppress only transient errors limited to internal VCS paths. Add regression tests and import camino::Utf8Path in the test module so the tests compile.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/biome_cli/src/runner/impls/watchers/default.rs` around lines 55 - 65,
Update the watcher event error handling around the notify error match to
suppress errors only when they are demonstrably transient and all affected paths
are internal VCS paths. Return WatcherEvent::Error for errors with no paths, any
non-VCS path, or otherwise non-transient conditions, and add regression tests
covering these cases; import camino::Utf8Path in the test module.

Ok(event) => {
// Modifying folder or metadata is ignored as it can unlikely affect the results.
// Any event types are necessary for some platforms to catch events.
Expand All @@ -55,13 +75,23 @@ impl Watcher for DefaultWatcher {
| EventKind::Remove(RemoveKind::File | RemoveKind::Any)
| EventKind::Any
) {
Some(WatcherEvent::Changed(
event
.paths
.into_iter()
.filter_map(|path| Utf8PathBuf::from_path_buf(path).ok())
.collect(),
))
let paths: Vec<Utf8PathBuf> = event
.paths
.into_iter()
.filter_map(|path| Utf8PathBuf::from_path_buf(path).ok())
// `.git/` paths come from VCS bookkeeping (e.g.
// `index.lock` churn) and should not trigger a
// re-crawl. Filtering at the watcher level keeps
// the workspace scanner's ignore contract intact
// while removing the spurious diagnostics that
// otherwise surface in watch mode.
.filter(|path| !is_internal_vcs_path(path))
.collect();
if paths.is_empty() {
None
} else {
Some(WatcherEvent::Changed(paths))
}
} else {
None
}
Expand All @@ -70,3 +100,30 @@ impl Watcher for DefaultWatcher {
})
}
}

#[cfg(test)]
mod tests {
use super::is_internal_vcs_path;
Comment on lines +104 to +106

@coderabbitai coderabbitai Bot Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

rg -n -C 3 'mod tests|use super::is_internal_vcs_path|use camino::Utf8Path|Utf8Path::new' \
  crates/biome_cli/src/runner/impls/watchers/default.rs

Repository: biomejs/biome

Length of output: 1025

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- imports and tests ---'
sed -n '1,145p' crates/biome_cli/src/runner/impls/watchers/default.rs

printf '%s\n' '--- related watcher symbols and call sites ---'
rg -n -C 4 'fn poll|notify::Error|Utf8PathBuf|is_internal_vcs_path|changed_paths|poll\(' \
  crates/biome_cli/src/runner/impls/watchers/default.rs crates/biome_cli/src/runner/impls/watchers

printf '%s\n' '--- standalone Rust name-resolution probe ---'
if command -v rustc >/dev/null 2>&1; then
  tmp="$(mktemp --suffix=.rs)"
  trap 'rm -f "$tmp" "${tmp%.rs}"' EXIT
  cat >"$tmp" <<'RS'
mod parent {
    use std::path::Path;

    mod child {
        fn uses_parent_import() {
            let _ = Path::new(".");
        }
    }
}
fn main() {}
RS
  if rustc "$tmp" -o "${tmp%.rs}" 2>&1; then
    echo 'child can use the parent use binding unqualified'
  else
    echo 'child cannot use the parent use binding unqualified'
  fi
else
  echo 'rustc unavailable'
fi

Repository: biomejs/biome

Length of output: 23059

🏁 Script executed:

#!/bin/bash
set -euo pipefail

tmp="$(mktemp /tmp/rust-scope-XXXXXX.rs)"
bin="${tmp%.rs}"
trap 'rm -f "$tmp" "$bin"' EXIT

cat >"$tmp" <<'RS'
mod parent {
    use std::path::Path;

    mod child {
        fn uses_parent_import() {
            let _ = Path::new(".");
        }
    }
}

fn main() {}
RS

if rustc --crate-name rust_scope_probe "$tmp" -o "$bin" 2>/tmp/rust-scope-probe.err; then
  echo 'child can use the parent use binding unqualified'
else
  echo 'child cannot use the parent use binding unqualified'
  cat /tmp/rust-scope-probe.err
fi

Repository: biomejs/biome

Length of output: 852

Import Utf8Path inside mod tests.

The parent module’s import is not inherited by the child module, so Utf8Path::new(...) does not compile. Add use camino::Utf8Path;.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/biome_cli/src/runner/impls/watchers/default.rs` around lines 104 -
106, Add a camino::Utf8Path import inside the cfg(test) tests module alongside
is_internal_vcs_path so its Utf8Path::new(...) usages compile; do not modify the
parent module imports.


#[test]
fn detects_path_inside_dot_git_directory() {
assert!(is_internal_vcs_path(Utf8Path::new(
"/repo/.git/index.lock"
)));
assert!(is_internal_vcs_path(Utf8Path::new("repo/.git/HEAD")));
assert!(is_internal_vcs_path(Utf8Path::new(
"/repo/sub/.git/index.lock"
)));
}

#[test]
fn leaves_non_git_paths_alone() {
assert!(!is_internal_vcs_path(Utf8Path::new("/repo/src/index.js")));
assert!(!is_internal_vcs_path(Utf8Path::new(
"/repo/.github/workflows/ci.yml"
)));
assert!(!is_internal_vcs_path(Utf8Path::new(
"/repo/some/path/git-notes.txt"
)));
}
}
Comment on lines +104 to +129

@coderabbitai coderabbitai Bot Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

rg -n -C 8 'DefaultWatcher|fn poll|WatcherEvent::Changed|WatcherEvent::Error|notify::Error' \
  crates/biome_cli/src/runner/impls/watchers

Repository: biomejs/biome

Length of output: 7546

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- default watcher ---'
cat -n crates/biome_cli/src/runner/impls/watchers/default.rs

printf '%s\n' '--- watcher trait and consumers ---'
rg -n -C 10 'pub trait Watcher|enum WatcherEvent|WatcherEvent::Error|poll\(\)' \
  crates/biome_cli/src/runner crates/biome_cli/src | head -n 260

printf '%s\n' '--- watcher module files and test imports ---'
git ls-files crates/biome_cli/src/runner/impls/watchers
rg -n -C 5 'Utf8Path|DefaultWatcher|WatcherEvent::Changed|WatcherEvent::Error' \
  crates/biome_cli/src/runner/impls/watchers

Repository: biomejs/biome

Length of output: 25580

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '%s\n' '--- targeted change history for the reviewed file ---'
git diff --unified=25 -- crates/biome_cli/src/runner/impls/watchers/default.rs | head -n 240

printf '%s\n' '--- watcher diagnostics and error construction ---'
rg -n -C 12 'struct WatcherDiagnostic|enum WatcherDiagnostic|WatcherDiagnostic|WatcherEvent::Error' \
  crates/biome_cli/src/runner crates/biome_cli/src | head -n 260

printf '%s\n' '--- deterministic checks for the test module and poll branches ---'
python3 - <<'PY'
from pathlib import Path
import re

p = Path("crates/biome_cli/src/runner/impls/watchers/default.rs")
text = p.read_text()

tests = text[text.index("#[cfg(test)]"):]

print("test module imports Utf8Path:",
      bool(re.search(r'^\s*use\s+[^;]*\bUtf8Path\b', tests, re.M)))
print("test module references Utf8Path:",
      bool(re.search(r'\bUtf8Path::new\s*\(', tests)))
print("poll suppresses Err branches:",
      bool(re.search(r'Err\(err\)\s*=>\s*\{.*?None', text, re.S)))
print("poll emits Changed only after non-empty paths:",
      bool(re.search(r'if paths\.is_empty\(\)\s*\{\s*None\s*\}\s*else\s*\{\s*Some\(WatcherEvent::Changed\(paths\)\)', text, re.S)))
print("poll filters .git paths:",
      bool(re.search(r'\.filter\(\|path\| !is_internal_vcs_path\(path\)\)', text)))
PY

Repository: biomejs/biome

Length of output: 8939

Add the missing import and DefaultWatcher::poll regression tests.

The test module uses Utf8Path but imports only is_internal_vcs_path, so the tests do not compile. Add the import, then cover error events, mixed .git and non-.git paths, and events containing only .git paths. The tests must exercise poll, not only the helper.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/biome_cli/src/runner/impls/watchers/default.rs` around lines 104 -
129, Import Utf8Path in the tests module so the existing helper tests compile,
then add regression tests for DefaultWatcher::poll covering error events, mixed
internal VCS and non-VCS paths, and batches containing only .git paths.
Construct each event scenario through the watcher’s public poll flow and assert
the resulting behavior, rather than testing only is_internal_vcs_path.

Source: Coding guidelines