Skip to content

fix(ci): the invisible-character gate never matched anything - #72

Open
hyperpolymath wants to merge 1 commit into
mainfrom
fix/empty-linter-pattern-never-matched
Open

fix(ci): the invisible-character gate never matched anything#72
hyperpolymath wants to merge 1 commit into
mainfrom
fix/empty-linter-pattern-never-matched

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Measured 2026-08-27: this gate caught 0 of 6 invisible-character test cases. It has never detected an NBSP, zero-width space, BOM, soft hyphen, bidi override or word joiner.

Root cause

The pattern used UTF-8 byte sequences (\xc2\xa0) while grep -P matches characters. Bytes c2 a0 are one character U+00A0; \xc2\xa0 asks for two, U+00C2 then U+00A0 — never present.

grep -P '\xc2\xa0'  ->  miss
grep -P '\x{a0}'    ->  MATCH

Only \x00 worked, being single-byte in both readings. The gate ran, passed, and could not see what it exists to see.

Fixed

  • codepoint escapes in place of byte sequences
  • C0 controls \x01-\x08,\x0B,\x0C,\x0E-\x1F added (TAB/LF/CR excluded)
  • grep -a — without it grep skips any NUL-bearing file as binary

The C0 range matters: a stray backspace byte made a workflow unparseable in developer-ecosystem, so it never ran — and this linter called it clean.

Canonical fix: hyperpolymath/empty-linter#70. 1 file(s) here.

Verified: YAML re-parsed, and the corrected pattern was confirmed to catch a real NBSP before the change was kept.

MEASURED 2026-08-27: this gate's pattern caught 0 OF 6 invisible-character test
cases. It has never detected an NBSP, zero-width space, BOM, soft hyphen, bidi
override or word joiner.

ROOT CAUSE: the pattern used UTF-8 BYTE sequences (\xc2\xa0) while grep -P
matches CHARACTERS. Bytes c2 a0 are ONE character U+00A0; \xc2\xa0 asks for TWO
characters, U+00C2 then U+00A0, which is never present.

  grep -P '\xc2\xa0'  ->  miss
  grep -P '\x{a0}'    ->  MATCH

Only \x00 worked, being single-byte in both readings.

FIXED: codepoint escapes; C0 control characters \x01-\x08,\x0B,\x0C,\x0E-\x1F
added (TAB/LF/CR excluded); and grep -a, without which grep skips any NUL-bearing
file as binary.

The C0 range matters: a stray BACKSPACE byte made a workflow unparseable in
developer-ecosystem, so it never ran, and this linter called it clean.

Canonical fix: hyperpolymath/empty-linter#70. 1 file(s) here.
VERIFIED: YAML re-parsed, and the corrected pattern was confirmed to catch a real
NBSP before the change was kept.
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 19ed2d75-9630-4739-a00c-c21914ce76ac

📥 Commits

Reviewing files that changed from the base of the PR and between faa9c63 and b4d70b6.

📒 Files selected for processing (1)
  • .github/workflows/dogfood-gate.yml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (25)
  • GitHub Check: Gitar
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / rust-secrets
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: panic-attack assail
  • GitHub Check: Patch Bridge CVE triage
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Groove manifest check
🔇 Additional comments (1)
.github/workflows/dogfood-gate.yml (1)

125-125: LGTM!

Also applies to: 136-136


📝 Walkthrough

Summary by CodeRabbit

  • Bug Fixes
    • Improved detection of invisible and control characters during automated checks.
    • Scanning now reliably examines binary files as text, helping identify hidden characters that could otherwise be missed.

Walkthrough

The empty-lint workflow now matches invisible characters by Unicode code point, includes additional control characters and the word joiner, and scans binary files as text.

Changes

Invisible-character gate

Layer / File(s) Summary
Pattern and scan updates
.github/workflows/dogfood-gate.yml
The PATTERNS regex now uses Unicode code-point escapes and detects additional control characters and the word joiner. The scan passes -a to grep so binary files are treated as text.

Estimated code review effort: 2 (Simple) | ~5 minutes

Merge Risk: ⚪ Minimal · up to b4d70

This localized workflow change makes the invisible-character gate detect the intended characters, including controls and NUL-bearing files, with no actionable merge-blocking risk remaining after normal checks and review.

Poem

A rabbit checks each hidden sign
Code points now align in line
Control marks cannot hide
Binary files are searched inside
The gate reports what it finds

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: fixing the CI gate that failed to match invisible characters.
Description check ✅ Passed The description explains the defect, root cause, implemented fixes, affected file, and verification steps. It does not reproduce the repository checklist headings, but it is sufficiently complete and …
Linked Issues check ✅ Passed The changes satisfy the coding objectives in issue #70 for this repository: they use Unicode code-point escapes, add the required C0 control range while excluding TAB, LF, and CR, and use grep -a. The…
Out of Scope Changes check ✅ Passed The pull request changes only the invisible-character detection command in .github/workflows/dogfood-gate.yml. The changes directly support the linked issue and stated objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Description check

Explanation

The description explains the defect, root cause, implemented fixes, affected file, and verification steps. It does not reproduce the repository checklist headings, but it is sufficiently complete and relevant.

Full details: Linked Issues check

Explanation

The changes satisfy the coding objectives in issue #70 for this repository: they use Unicode code-point escapes, add the required C0 control range while excluding TAB, LF, and CR, and use grep -a. The scope remains limited to the affected workflow file.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

Copy link
Copy Markdown

@gitar-bot

gitar-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

Important

You are using the Gitar free plan. Upgrade to unlock code review, CI analysis, auto-apply, custom automations, and more.

Gitar

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR successfully addresses the logic issue where the invisible-character CI gate was ineffective due to incorrect character escaping and binary-file skipping. By switching to Unicode codepoint escapes and adding the -a flag, the gate should now correctly identify the intended characters. While the implementation is up to standards according to Codacy, there is a notable absence of regression test files or fixtures to verify that these characters are actually detected. Including such files would ensure the gate remains functional in the future.

About this PR

  • The PR does not introduce any test fixtures or regression-test files (e.g., a sample file containing targeted invisible characters) to ensure the gate remains functional and to verify the current fix works as intended.

Test suggestions

  • Verify detection of Non-Breaking Space (U+00A0) in a source file
  • Verify detection of C0 control characters (e.g., Backspace \x08) in a source file
  • Verify detection of Zero-Width Space (U+200B) in a source file
  • Ensure files containing null bytes (\x00) are scanned rather than skipped as binary
  • Verify that allowed whitespace (TAB, LF, CR) does not trigger the gate
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify detection of Non-Breaking Space (U+00A0) in a source file
2. Verify detection of C0 control characters (e.g., Backspace \x08) in a source file
3. Verify detection of Zero-Width Space (U+200B) in a source file
4. Ensure files containing null bytes (\x00) are scanned rather than skipped as binary
5. Verify that allowed whitespace (TAB, LF, CR) does not trigger the gate

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

-o -name '*.idr' -o -name '*.zig' -o -name '*.v' -o -name '*.jl' \
-o -name '*.gleam' -o -name '*.hs' -o -name '*.ml' -o -name '*.sh' \) \
-exec grep -Prl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null
-exec grep -aPrl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚪ LOW RISK

Suggestion: The -r flag is redundant when using find to provide explicit file paths. To improve performance in larger repositories, use + instead of \; to batch file processing. Additionally, removing the 2>/dev/null redirection is recommended to ensure that any grep errors, such as PCRE compilation failures, are visible in the CI logs.

Suggested change
-exec grep -aPrl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null
-exec grep -aPl "$PATTERNS" {} + > /tmp/empty-lint-results.txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant