Skip to content

docs(core): correct DEFAULT_IGNORE_PATTERNS comment about bin/#321

Open
KennyUMN wants to merge 1 commit into
Lum1104:mainfrom
KennyUMN:fix/ignore-filter-bin-comment
Open

docs(core): correct DEFAULT_IGNORE_PATTERNS comment about bin/#321
KennyUMN wants to merge 1 commit into
Lum1104:mainfrom
KennyUMN:fix/ignore-filter-bin-comment

Conversation

@KennyUMN
Copy link
Copy Markdown

What

The block comment above DEFAULT_IGNORE_PATTERNS in packages/core/src/ignore-filter.ts says the defaults add "bin/obj for .NET projects", but only obj/ is actually included.

Why

bin/ is intentionally excluded — in Node and Ruby projects bin/ is the conventional location for CLI entrypoint source, which should still be analyzed. This is already enforced by the "does not contain bin (used by Node/Ruby CLI launchers)" test in ignore-filter.test.ts. Only obj/ is pure .NET intermediate build output that's safe to blanket-ignore.

The inaccurate comment is what led to the confusion in #76, where it looked like bin/ had simply been forgotten. This documents the exclusion as intentional and points at the test so the next reader doesn't try to "fix" it by adding bin/ (which would break the test and start analyzing source as build output).

Change

Comment-only. No behavior change.

- * exclusion rules, plus bin/obj for .NET projects.
+ * exclusion rules, plus obj/ for .NET build output.
+ *
+ * Note: bin/ is intentionally NOT excluded. Although it holds .NET build
+ * output, it doubles as the conventional location for CLI entrypoint source
+ * in Node and Ruby projects, which should still be analyzed. See the
+ * "does not contain bin" case in ignore-filter.test.ts.

Testing

pnpm test in packages/core — all 670 tests pass (33 files), including the full ignore-filter suite.

Refs #76

Copilot AI review requested due to automatic review settings May 29, 2026 04:04
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates documentation around the default ignore patterns to clarify .NET build output handling and explicitly document why bin/ is not excluded.

Changes:

  • Refines the description of .NET-related ignores to focus on obj/ build output.
  • Adds an explicit note explaining why bin/ is intentionally not excluded, referencing existing test coverage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The block comment claimed the defaults add 'bin/obj for .NET projects',
but only obj/ is included. bin/ is intentionally excluded because it
holds CLI entrypoint source in Node/Ruby projects (asserted by the
'does not contain bin' test). The inaccurate comment is what led to the
confusion in Lum1104#76 about bin/ being missing. Document the intentional
exclusion instead.
@KennyUMN KennyUMN force-pushed the fix/ignore-filter-bin-comment branch from 4614a41 to 0221ce1 Compare May 29, 2026 04:10
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.

2 participants