|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.CommandLine;
using Microsoft.TemplateEngine.Abstractions;
using Microsoft.TemplateEngine.Abstractions.TemplateFiltering;
using Microsoft.TemplateEngine.Cli.TemplateResolution;
using Microsoft.TemplateEngine.Utils;
using Microsoft.TemplateSearch.Common.Abstractions;
namespace Microsoft.TemplateEngine.Cli.Commands
{
/// <summary>
/// Defines supported dotnet new command filter option
/// Filter options can be used along with other dotnet new subcommands to filter the required items for the action, for example for list subcommand filters can limit the templates to be shown.
/// </summary>
internal class FilterOptionDefinition
{
internal FilterOptionDefinition(Func<Option> optionFactory)
{
OptionFactory = optionFactory ?? throw new ArgumentNullException(nameof(optionFactory));
}
internal static FilterOptionDefinition AuthorFilter { get; } =
new TemplateFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreateAuthorOption(),
matchFilter: authorArg => WellKnownSearchFilters.AuthorFilter(authorArg),
mismatchCriteria: resolutionResult => resolutionResult.HasAuthorMismatch,
matchInfoName: MatchInfo.BuiltIn.Author);
internal static FilterOptionDefinition BaselineFilter { get; } =
new TemplateFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreateBaselineOption(),
matchFilter: baselineArg => WellKnownSearchFilters.BaselineFilter(baselineArg),
mismatchCriteria: resolutionResult => resolutionResult.HasBaselineMismatch,
matchInfoName: MatchInfo.BuiltIn.Baseline);
internal static FilterOptionDefinition LanguageFilter { get; } =
new TemplateFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreateLanguageOption(),
matchFilter: languageArg => WellKnownSearchFilters.LanguageFilter(languageArg),
mismatchCriteria: resolutionResult => resolutionResult.HasLanguageMismatch,
matchInfoName: MatchInfo.BuiltIn.Language);
internal static FilterOptionDefinition TagFilter { get; } =
new TemplateFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreateTagOption(),
matchFilter: tagArg => WellKnownSearchFilters.ClassificationFilter(tagArg),
mismatchCriteria: resolutionResult => resolutionResult.HasClassificationMismatch,
matchInfoName: MatchInfo.BuiltIn.Classification);
internal static FilterOptionDefinition TypeFilter { get; } =
new TemplateFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreateTypeOption(),
matchFilter: typeArg => WellKnownSearchFilters.TypeFilter(typeArg),
mismatchCriteria: resolutionResult => resolutionResult.HasTypeMismatch,
matchInfoName: MatchInfo.BuiltIn.Type);
internal static FilterOptionDefinition PackageFilter { get; } =
new PackageFilterOptionDefinition(
optionFactory: () => SharedOptionsFactory.CreatePackageOption(),
matchFilter: PackageMatchFilter);
/// <summary>
/// A predicate that creates instance of option.
/// </summary>
internal Func<Option> OptionFactory { get; }
private static Func<ITemplatePackageInfo, bool> PackageMatchFilter(string? packageArg)
{
return (pack) =>
{
if (string.IsNullOrWhiteSpace(packageArg))
{
return true;
}
return pack.Name.Contains(packageArg, StringComparison.OrdinalIgnoreCase);
};
}
}
/// <summary>
/// Defines supported dotnet new command filter option applicable to the template.
/// </summary>
internal class TemplateFilterOptionDefinition : FilterOptionDefinition
{
internal TemplateFilterOptionDefinition(
Func<Option> optionFactory,
Func<string?, Func<ITemplateInfo, MatchInfo?>> matchFilter,
Func<TemplateResolutionResult, bool> mismatchCriteria,
string matchInfoName) : base(optionFactory)
{
TemplateMatchFilter = matchFilter ?? throw new ArgumentNullException(nameof(matchFilter));
MismatchCriteria = mismatchCriteria ?? throw new ArgumentNullException(nameof(mismatchCriteria));
MatchInfoName = matchInfoName ?? throw new ArgumentNullException(nameof(matchInfoName));
}
/// <summary>
/// A predicate that returns the template match filter for the filter option.
/// Template match filter should return the MatchInfo for the given template based on filter value.
/// </summary>
/// <remarks>
/// Common template match filters are defined in Microsoft.TemplateEngine.Utils.WellKnonwnSearchFilter class.
/// </remarks>
internal Func<string?, Func<ITemplateInfo, MatchInfo?>> TemplateMatchFilter { get; set; }
/// <summary>
/// A predicate that returns if the filter option caused a mismatch in <see cref="TemplateResolutionResult"/> in case of partial match.
/// </summary>
internal Func<TemplateResolutionResult, bool> MismatchCriteria { get; set; }
/// <summary>
/// A <see cref="MatchInfo"/> name used in match dispositions.
/// </summary>
internal string MatchInfoName { get; set; }
}
/// <summary>
/// Defines supported dotnet new command filter option applicable to the package.
/// </summary>
internal class PackageFilterOptionDefinition : FilterOptionDefinition
{
internal PackageFilterOptionDefinition(
Func<Option> optionFactory,
Func<string?, Func<ITemplatePackageInfo, bool>> matchFilter) : base(optionFactory)
{
PackageMatchFilter = matchFilter ?? throw new ArgumentNullException(nameof(matchFilter));
}
/// <summary>
/// A predicate that returns the package match filter for the filter option
/// Package match filter should if package is a match based on filter value.
/// </summary>
internal Func<string?, Func<ITemplatePackageInfo, bool>> PackageMatchFilter { get; set; }
}
}
|