microsoft / microsoft/component-detection

Service to centrally track and cleanup generated files in detectors

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

Nobody has claimed this yet.

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

Description

Problem

Multiple detectors within the component-detection project are generating temporary or output files and performing their own cleanup. As more detectors are added, this approach becomes difficult to manage, increases risk of resource leakage, and complicates code maintenance.

Proposal

Introduce a centralized service to:

  • Track all files generated by detectors during their operation
  • Provide a unified cleanup mechanism that ensures files do not linger after execution
  • Offer standardized APIs for detectors to register files for tracking and cleaning

Benefits

  • Reduces code duplication and errors in individual detectors
  • Simplifies detector implementation
  • Helps prevent file buildup and potential resource leaks
  • Easier management and auditing of generated files across all detectors

Additional Info

This would help future-proof the project as detector count and complexity grows.

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 surveying the detector implementations in the component-detection repository to identify how they generate, register, and clean up temporary or output files. Define the service boundary and standardized registration and cleanup behavior from those existing patterns. Done means detectors can use the centralized service and generated files are reliably cleaned up after execution.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.