From 4a21d9902f82c03bded4218628b9f896c5b40a3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Tue, 6 Aug 2019 15:37:21 +0300 Subject: [PATCH] Resolved #1594: Rename "mvc-module" template's name to "module". --- docs/en/CLI.md | 8 ++++---- docs/en/Startup-Templates/Index.md | 2 +- docs/en/Startup-Templates/{Mvc-Module.md => Module.md} | 6 +++--- .../Volo/Abp/Cli/Commands/NewCommand.cs | 4 ++-- .../Abp/Cli/ProjectBuilding/TemplateInfoProvider.cs | 4 ++-- .../{MvcModuleTemplate.cs => ModuleTemplate.cs} | 10 +++++----- 6 files changed, 17 insertions(+), 17 deletions(-) rename docs/en/Startup-Templates/{Mvc-Module.md => Module.md} (95%) rename framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/{MvcModuleTemplate.cs => ModuleTemplate.cs} (89%) diff --git a/docs/en/CLI.md b/docs/en/CLI.md index af7159bc22..f931d3688f 100644 --- a/docs/en/CLI.md +++ b/docs/en/CLI.md @@ -49,14 +49,14 @@ abp new Acme.BookStore * `--database-provider` or `-d`: Specifies the database provider. Default provider is `ef`. Available providers: * `ef`: Entity Framework Core. * `mongodb`: MongoDB. - * `mvc-module`: ASP.NET Core [module template](Startup-Templates/Mvc-Module.md). Additional options: + * `module`: [Module template](Startup-Templates/Module.md). Additional options: * `--no-ui`: Specifies to not include the UI. This makes possible to create service-only modules (a.k.a. microservices - without UI). * `--output-folder` or `-o`: Specifies the output folder. Default value is the current directory. * `--version` or `-v`: Specifies the ABP & template version. It can be a [release tag](https://github.com/abpframework/abp/releases) or a [branch name](https://github.com/abpframework/abp/branches). Uses the latest release if not specified. Most of the times, you will want to use the latest version. ### add-package -Adds a new ABP package to a project by, +Adds an ABP package to a project by, * Adding related nuget package as a dependency to the project. * Adding `[DependsOn(...)]` attribute to the module class in the project (see the [module development document](Module-Development-Basics.md)). @@ -83,9 +83,9 @@ abp add-package Volo.Abp.MongoDB ### add-module -Adds a multi-package module to a solution by finding all packages of the module, finding related projects in the solution and adding each package to the corresponding project in the solution. +Adds a [multi-package application module](Modules/Index) to a solution by finding all packages of the module, finding related projects in the solution and adding each package to the corresponding project in the solution. -> A business module generally consists of several packages (because of layering, different database providr options or other reasons). Using `add-module` command dramatically simplifies adding a module to a solution. However, each module may require some additional configurations which is generally indicated in the documentation of the related module. +> A business module generally consists of several packages (because of layering, different database provider options or other reasons). Using `add-module` command dramatically simplifies adding a module to a solution. However, each module may require some additional configurations which is generally indicated in the documentation of the related module. Basic usage: diff --git a/docs/en/Startup-Templates/Index.md b/docs/en/Startup-Templates/Index.md index 2119afddad..f47fb97910 100644 --- a/docs/en/Startup-Templates/Index.md +++ b/docs/en/Startup-Templates/Index.md @@ -3,7 +3,7 @@ While you can start with an empty project and add needed packages manually, startup templates make easy and comfortable to start a new solution with the ABP framework. Click the name from the list below to see the documentation of the related startup template: * [**app**](Application.md): Application template. -* [**mvc-module**](Mvc-Module.md): Module/service template. +* [**module**](Module.md): Module/service template. diff --git a/docs/en/Startup-Templates/Mvc-Module.md b/docs/en/Startup-Templates/Module.md similarity index 95% rename from docs/en/Startup-Templates/Mvc-Module.md rename to docs/en/Startup-Templates/Module.md index 1a2c6c275f..fa425c67e2 100644 --- a/docs/en/Startup-Templates/Mvc-Module.md +++ b/docs/en/Startup-Templates/Module.md @@ -15,14 +15,14 @@ dotnet tool install -g Volo.Abp.Cli Then use the `abp new` command in an empty folder to create a new solution: ```bash -abp new Acme.IssueManagement -t mvc-module +abp new Acme.IssueManagement -t module ``` - `Acme.IssueManagement` is the solution name, like *YourCompany.YourProduct*. You can use single level, two-levels or three-levels naming. ### Without User Interface -The template comes with a UI by default. You can use `--no-ui` option to not include the UI layer. +The template comes with an MVC UI by default. You can use `--no-ui` option to not include the UI layer. ````bash abp new Acme.IssueManagement -t mvc-module --no-ui @@ -119,7 +119,7 @@ You can still create unit tests for your classes which will be harder to write ( ### Host Projects -The solution has a few host applications to run your module on development. Host applications are used to run your module in a fully configured application. It is useful on development. Host applications includes some other modules in addition to the module being developed: +The solution has a few host applications to run your module. Host applications are used to run your module in a fully configured application. It is useful on development. Host applications includes some other modules in addition to the module being developed: Host applications support two types of scenarios. diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs index 29485f119c..f75a2eae4c 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs @@ -133,8 +133,8 @@ namespace Volo.Abp.Cli.Commands sb.AppendLine(" abp new Acme.BookStore -u angular -d mongodb"); sb.AppendLine(" abp new Acme.BookStore -d mongodb"); sb.AppendLine(" abp new Acme.BookStore -d mongodb -o d:\\my-project"); - sb.AppendLine(" abp new Acme.BookStore -t mvc-module"); - sb.AppendLine(" abp new Acme.BookStore -t mvc-module no-ui"); + sb.AppendLine(" abp new Acme.BookStore -t module"); + sb.AppendLine(" abp new Acme.BookStore -t module no-ui"); sb.AppendLine(""); sb.AppendLine("See the documentation for more info: https://docs.abp.io/en/abp/latest/CLI"); diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/TemplateInfoProvider.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/TemplateInfoProvider.cs index e5bb97478a..ceb79b2a53 100644 --- a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/TemplateInfoProvider.cs +++ b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/TemplateInfoProvider.cs @@ -19,8 +19,8 @@ namespace Volo.Abp.Cli.ProjectBuilding { case AppTemplate.TemplateName: return new AppTemplate(); - case MvcModuleTemplate.TemplateName: - return new MvcModuleTemplate(); + case ModuleTemplate.TemplateName: + return new ModuleTemplate(); default: throw new Exception("There is no template found with given name: " + name); } 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/ModuleTemplate.cs similarity index 89% rename from framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/MvcModuleTemplate.cs rename to framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ProjectBuilding/Templates/MvcModule/ModuleTemplate.cs index 32b4a2a24b..cb81ca9bc7 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/ModuleTemplate.cs @@ -4,17 +4,17 @@ using Volo.Abp.Cli.ProjectBuilding.Building.Steps; namespace Volo.Abp.Cli.ProjectBuilding.Templates.MvcModule { - public class MvcModuleTemplate : TemplateInfo + public class ModuleTemplate : TemplateInfo { /// - /// "mvc-module". + /// "module". /// - public const string TemplateName = "mvc-module"; + public const string TemplateName = "module"; - public MvcModuleTemplate() + public ModuleTemplate() : base(TemplateName) { - DocumentUrl = "https://docs.abp.io/en/abp/latest/Startup-Templates/Mvc-Module"; + DocumentUrl = "https://docs.abp.io/en/abp/latest/Startup-Templates/Module"; } public override IEnumerable GetCustomSteps(ProjectBuildContext context)