microsoft / microsoft/component-detection

Allow Capabilities to ignore specific files in scan

Open
#1,362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
553
Forks
135
Avg merge
20h 58m
Merged PRs (30d)
6

Description

presently we are able to ignore scanning all files under a directory by passing in --IgnoreDirectories "path" or --DirectoryExclusionList "pathGlob",

However there is sometimes the need to only exempt specific files from being scanned, while still scanning the rest of the directory. Filtering in the DetectorProcessingService applies to the path levels only, so this will require a new approach rather than relying on the --IgnoreDirectories argument.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading DetectorProcessingService and tracing how --IgnoreDirectories and --DirectoryExclusionList are applied to scan paths. Determine where file-level exclusions should be represented while preserving scans for other files in the directory. Done means specific files can be exempted without excluding their surrounding directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
devtools, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.