From 475a0acfdac226dc0882b13503ace014a2ec2f6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 6 Jun 2019 18:16:11 +0300 Subject: [PATCH] Show documentation URL of the template after project creation. --- .../Abp/Cli/ProjectBuilding/Building/TemplateInfo.cs | 4 ++++ .../Volo/Abp/Cli/ProjectBuilding/ProjectBuilder.cs | 11 +++++++++++ .../Cli/ProjectBuilding/Templates/Mvc/MvcTemplate.cs | 2 +- .../Templates/MvcModule/MvcModuleTemplate.cs | 2 +- 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/TemplateInfo.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/TemplateInfo.cs index 4041dc8d7a..3809646ecc 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/TemplateInfo.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Building/TemplateInfo.cs @@ -6,10 +6,14 @@ namespace Volo.Abp.Cli.ProjectBuilding.Building { public abstract class TemplateInfo { + [NotNull] public string Name { get; } public DatabaseProvider DefaultDatabaseProvider { get; } + [CanBeNull] + public string DocumentUrl { get; set; } + protected TemplateInfo( [NotNull] string name, DatabaseProvider defaultDatabaseProvider = DatabaseProvider.NotSpecified) diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/ProjectBuilder.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/ProjectBuilder.cs index 64aa02ee6e..574dd32a3d 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/ProjectBuilder.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/ProjectBuilder.cs @@ -1,5 +1,7 @@ using System; using System.Threading.Tasks; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; using Volo.Abp.Cli.ProjectBuilding.Building; using Volo.Abp.DependencyInjection; @@ -7,6 +9,8 @@ namespace Volo.Abp.Cli.ProjectBuilding { public class ProjectBuilder : IProjectBuilder, ITransientDependency { + public ILogger Logger { get; set; } + protected ITemplateStore TemplateStore { get; } protected ITemplateInfoProvider TemplateInfoProvider { get; } @@ -14,6 +18,8 @@ namespace Volo.Abp.Cli.ProjectBuilding { TemplateStore = templateStore; TemplateInfoProvider = templateInfoProvider; + + Logger = NullLogger.Instance; } public async Task BuildAsync(ProjectBuildArgs args) @@ -44,6 +50,11 @@ namespace Volo.Abp.Cli.ProjectBuilding ProjectBuildPipelineBuilder.Build(context).Execute(context); + if (!templateInfo.DocumentUrl.IsNullOrEmpty()) + { + Logger.LogInformation("Check the documentation of this template: " + templateInfo.DocumentUrl); + } + return new ProjectBuildResult(context.Result.ZipContent, args.SolutionName.ProjectName); } diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/Mvc/MvcTemplate.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/Mvc/MvcTemplate.cs index 069c5fbf03..5df8167fad 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/Mvc/MvcTemplate.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/Mvc/MvcTemplate.cs @@ -14,7 +14,7 @@ namespace Volo.Abp.Cli.ProjectBuilding.Templates.Mvc public MvcTemplate() : base(TemplateName, DatabaseProvider.EntityFrameworkCore) { - + DocumentUrl = "https://docs.abp.io/en/abp/latest/Startup-Templates/Mvc"; } public override IEnumerable GetCustomSteps(ProjectBuildContext context) diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/MvcModuleTemplate.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/MvcModuleTemplate.cs index e3258ec8a6..e12f97a638 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/MvcModuleTemplate.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/MvcModuleTemplate.cs @@ -14,7 +14,7 @@ namespace Volo.Abp.Cli.ProjectBuilding.Templates.MvcModule public MvcModuleTemplate() : base(TemplateName) { - + DocumentUrl = "https://docs.abp.io/en/abp/latest/Startup-Templates/Mvc-Module"; } public override IEnumerable GetCustomSteps(ProjectBuildContext context)