dotnet/msbuild

IMSBuildGlob should have a method that expands globs

Open

#1.908 geöffnet am 24. März 2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (1.364 Forks)batch import
Feature - Globbinghelp wantedtriaged

Repository-Metriken

Stars
 (5.062 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 11T 7h) (125 gemergte PRs in 30 T)

Beschreibung

IMSBuildGlob currently knows how to match strings against itself. It would be nice if it also had an ExpandToFiles method which hit the disk and expanded the glob into matching files, with the same behaviour that the engine is internally using. We didn't expose this functionality because there's no outside asks for it yet.

Implementation details:

  • Since expansion is slow, the results should be cached, and maybe the method should also have an async counterpart
  • A very easy implementation is to just call EngineFileUtilities.GetFileList. However, that method needlessly parses the glob again. A better implementation is to rework the internal static methods to also accept an already parsed glob. This poses some complications due to the different validation checks done by EngineFileUtilities.GetFileList and FileMatcher.GetFiles
  • Behaviour on illegal filespecs (as per the engine today):
    • EngineFileUtilities.GetFileList returns back the original illegal filespec
    • FileMatcher.GetFiles return back the original illegal filespec if it's not excluded, otherwise returns empty

Contributor Guide

Research-Richtung
Studieren Sie die IMSBuildGlob Schnittstelle und die FileMatcher Klasse. Verstehen Sie, wie EngineFileUtilities.GetFileList funktioniert und wie Sie eine ExpandToFiles Methode mit Caching implementieren.
Tech Stack
csharp
Domain
build system
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#MSBuild internals
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45