easyabp / abphelper.cli

Providing code generation and more features to help you develop applications and modules with the ABP framework.

AbpHelper.CLI

AbpHelper is a tool that help you with developing Abp vNext applications.

Make sure to backup your source files before using it!

Getting Started

1. Install AbpHelper CLI tool

   dotnet tool install EasyAbp.AbpHelper -g

   If you prefer GUI, there is also a tool with a fancy UI: AbpHelper.GUI

2. If you have previously installed it, update it with the following command:

   dotnet tool update EasyAbp.AbpHelper -g

3. Use ABP CLI to create an ABP application

   abp new MyToDo

4. Create an entity

   public class Todo : FullAuditedEntity<Guid>
   {
       public string Content { get; set; }
       public bool Done { get; set; }
   }

5. Run AbpHelper

   abphelper generate crud Todo -d C:\MyTodo

   • generate crud is a sub command to generate CRUD files
   • Todo specified the entity name we created earlier
   • -d specified the root directory of the ABP project, which is created by the ABP CLI

   AbpHelper will generate all the CRUD stuffs , even include adding migration and database updating!

6. Run the DbMigrator to seed the database

7. Startup your application

8. Login with the default admin account, and see the magic happens!

   

   If you don't see the TODO menu, check your permissions and make sure the TODO related permissions are granted

Usage

• Run abphelper -h to see the general help
• Similarly, you can use -h or --help option to see detailed usage of each of the following commands

Commands

• generate

  Generate files for ABP projects. See 'abphelper generate --help' for details

  • crud

    Generate a set of CRUD related files according to the specified entity

    Demo GIF

  • service

    Generate service interface and class files according to the specified name

    Demo GIF

  • methods

    Generate service method(s) according to the specified name(s)

    Demo GIF

  • localization

    Generate localization item(s) according to the specified name(s)

    Demo GIF

  • controller

    Generate controller class and methods according to the specified service

    Demo GIF

• ef

  A shortcut to run 'dotnet ef' commands. See 'abphelper ef --help' for details

  Demo GIF

• module

  Help quickly add/update/remove ABP modules. See 'abphelper module --help' for details

  Demo GIF

abphelper.cli's Issues

Menu items name improvement.

Refer to Volo's BloggingModule, Menu:Blog should be Menu:Blogs.

AbpHelper.CLI/src/AbpHelper/Templates/Crud/Localization.sbntxt

Line 2 in 1809b4f

"Menu:{{ EntityInfo.Name }}": "Menu{{ EntityInfo.Name }}",

Add support for Mongodb

The code generator should check duplication.

When we try to generate codes for Todo twice, the generator don't know that the code is already existing. So it should check duplication first.

Maybe the namespace of dtos should follow the entity.

I generate codes for entity Todo2 which in the folder Todos instead of Todo2s, and the dtos are created in Todo2s folder. Maybe Todo2 in Todos folder/namespace should be allowed. What do you think? @wakuflair

GUI needs a sub command to get the UI framework name of the selected solution.

GUI does not know which UI framework the selected solution uses, maybe we should create a new sub command to get UI framework name so GUI can show available options for developers.

Need create/update info models generation.

It is not a good way to add Bootstrap attributes to creation DTO.

Developers may need a CreateUpdateTodoInfoModel (or two separated info models), so they can custom their form.

Generator doesn't work when an entity class implements more than one interface.

Error here:

AbpHelper.CLI/src/AbpHelper/Steps/Abp/EntityParserStep.cs

Line 50 in 1052e3c

var genericNameSyntax = baseList.Descendants<SimpleBaseTypeSyntax>().Single().Descendants<GenericNameSyntax>().FirstOrDefault();

Entity class for example:

    public class ReviewNotice : CreationAuditedAggregateRoot<Guid>, IMultiTenant
    {
        public virtual Guid? TenantId { get; set; }
        
        public virtual Guid ReviewId { get; protected set; }
        
        public virtual Guid UserId { get; protected set; }
    }

build cli ERROR,copy sbntxt file

error MSB3027: 无法将“F:\github\abptools\AbpHelper.CLI\src\AbpHelper\Templates\Crud\Groups\Test\test{{ ProjectInfo.FullName }}.EntityFrameworkCore.Tests\EntityFrameworkCore{{ EntityInfo.NamespaceLastPart }}{{ EntityInfo.Name }}RepositoryTests.cs.sbntxt”复制到“bin\Debug\netcoreapp3.1\publish\Templates\Crud\Groups\Test\test{{ ProjectInfo.FullName }}.EntityFrameworkCore.Tests\EntityFrameworkCore{{ EntityInfo.NamespaceLastPart }}{{ EntityInfo.Name }}RepositoryTests.cs.sbntxt”。超出了重试计数 10。失败。

Hide menu item for tenant user if an entity does not implement IMultiTenant.

Change namespace from AbpHelper to EasyAbp.AbpHelper

In the future, EasyAbp team will create more projects for abp framework, the AbpHelper belongs to EasyAbp organization and it is an important platform to glue all the projects. 😀

Add support for Angular

Path error at Mac OS.

I have no idea if Linux has this problem.

Suggestions for command line improvement

This is the current command line demo:
abphelper C:\MyTodo Todo.cs

I have some suggestions:

1. Rename "abphelper" to "abp-helper".
   Of course we should not use CamelCase, but maybe abp-helper is a better choice.
2. Change the input from solution folder to .sln file.
   If we do it, maybe developers can use it directly by select a .sln file without having to learn which folder should be inputted.
3. Add a required function name to command line.
   In future, AbpHelper may has more functions than the code generation, so we can add a function name likes generate after the command abphelper.
4. Entity name don't need .cs suffix.
   If developers input Todo, we can assert the filename is "Todo.cs", and if the entity file is not in the default location "C:\MyTodo\src\MyTodo.Domain\Todos\Todo.cs", they can configure the correct path by --EntityFile C:\MyTodo\src\MyTodo.Domain\Todos\TodoEntity.cs or -e C:\MyTodo\src\MyTodo.Domain\Todos\TodoEntity.cs.
5. Maybe solution folder input could be omitted.
   Developers can change current folder to C:\MyTodo and run the command line, for this use, solution folder (or .sln file) is not required to input, so we can omit it can provide a way to set the target .sln file likes -s C:\MyTodo\MyTodo.sln.

For example:

abp-helper generate Todo
abp-helper generate Todo -e C:\MyTodo\src\MyTodo.Domain\Todos\TodoEntity.cs
abp-helper generate Todo -s C:\MyTodo\MyTodo.sln

`abphelper --version` shows wrong version number

Localization add/delete helper.

A subcommand to add/delete a localization item into all the localization JSON files.

给每个工程目录添加FodyWeavers.xml文件

每个工程的*.csproj文件同目录，添加FodyWeavers.xml文件

TenantId should be removed from index.js and Index.cshtml

Relate to: #34

• Should remove { data: "tenantId" }, from index.js.
• Should remove <th>@L["XxxxxTenantId"]</th> from Index.cshtml.

Mvc UI pages generation EditModal.cshtml code problem.

@inherits MyProject.Web.Pages.MyProjectPage makes IDE show the error.

Which repository should be injected in CRUD class if an entity has a custom repository?

If a developer use --custom-repository to generate codes, maybe we can use:

        public TodoAppService(
            ITodoRepository repository) : base(repository)
        {
        }

to replace:

        public TodoAppService(
            IRepository<Todo, Guid> repository) : base(repository)
        {
        }

Problems with repeated generation of constructors.

Maybe we can add a option to specify UI framework.

Refer to: https://github.com/abpframework/abp/blob/dev/docs/en/CLI.md

Maybe we need a CLI parameter like: --ui angular or -u angular.

And it could be --ui none by default to skip the UI pages generation. (Relate to: #15)

There are several reasons:

1. In future, there will be more ABP official UI frameworks and community UI frameworks, even a solution has more than one UI frameworks, so it is hard to do automatic recognition.

2. Developers have experience to use -u angular because ABP CLI also has the parameter.

3. GUI will remember the solution information so developers do not need to repeat it. (Not yet implemented)

Add `service` sub command

will generate:

• Contracts project
  • Service interface
  • Dtos folder
• Application project
  • Service class

support generate entities?

suggest

• Whether to consider support for generating entities?
• Consider reading the PDM file to generate the entities!

Dto class code style problem.

    public class CreateUpdateTodoDto
    {
        [DisplayName("TodoTenantId")]
        public Guid? TenantId {get; set;}  // Should be { get; set; }
// Extra line should be removed
    }

    public class ReviewNoticeDto : CreationAuditedEntityDto<Guid>
    {
        public Guid? TenantId {get; set;}  // Should be { get; set; }
    }

An optional feature to generate a custom repository.

Maybe sometimes developers need a custom repository for an entity. So how about providing an optional feature to generate a custom repository?

The module menu item may need to be a sub item of administration menu item.

        private async Task ConfigureMainMenu(MenuConfigurationContext context)
        {
            var administrationMenuItem = context.Menu.GetAdministration();
            var l = context.ServiceProvider.GetRequiredService<IStringLocalizer<UniappManagementResource>>();            //Add main menu items.

            var authorizationService = context.ServiceProvider.GetRequiredService<IAuthorizationService>();

            if (await authorizationService.IsGrantedAsync(UniappManagementPermissions.Uniapps.Default))
            {
                administrationMenuItem.AddItem(
                    new ApplicationMenuItem("Uniapp", l["Menu:Uniapp"], "/UniappManagement/Uniapps/Uniapp")
                );
            }
        }

Otherwise, too many menu items will cause trouble to the UI, Only a few cases require customization by developers to move out the module menu item.

给工程文件添加configureawait.props引用

给每个工程文件*.csproj添加configureawait.props

CreateUpdateViewModel generation.

Most of entities need attributes to customize form, and the manual operation is troublesome.

We may need to generate CreateUpdateViewModel to replace CreateUpdateDto using in MVC UI modal, because the latter has more attributes for the abp dynamic form.

Maybe we should split CreateUpdateTodoDto to CreateTodoDto and UpdateTodoDto

Now it builds the CRUD class with a CreateUpdateTodoDto:

public class TodoAppService : CrudAppService<Todo, TodoDto, Guid, PagedAndSortedResultRequestDto,
            CreateUpdateTodoDto, CreateUpdateTodoDto>,
        ITodoAppService

When developers want a CreateTodoDto and a UpdateTodoDto, so they should delete CreateUpdateTodoDto, create those two new dtos, change ITodoAppService and TodoAppService and add them to automapper profile manually.

If we build both CreateTodoDto and UpdateTodoDto to replace CreateUpdateTodoDto by default, when developers want to combine them, they can just let CreateTodoDto inherit from UpdateTodoDto.

Entity class auto complete feature.

Developer create an entity without ctor:

    public class Todo : AggregateRoot<Guid>
    {
        public virtual string Content { get; protected set; }
        
        public virtual DateTime? DueTime { get; protected set; }
        
        public virtual bool IsDone { get; protected set; }
    }

When he use code generator, should we complete the ctor methods?

    public class Todo : AggregateRoot<Guid>
    {
        public virtual string Content { get; protected set; }
        
        public virtual DateTime? DueTime { get; protected set; }
        
        public virtual bool IsDone { get; protected set; }
        
        protected Todo() {}

        public Todo(
            Guid id,
            string content,
            DateTime? dueTime,
            bool isDone) : base(id)
        {
            Content = content;
            DueTime = dueTime;
            IsDone = isDone;
        }
    }

System.NotSupportedException: Unknown ABP project structure. Directory

[10:32:12 ERR] Error while invoking activity activity-5 of workflow 713380c7ffff471cb26237e68d68cf37
System.NotSupportedException: Unknown ABP project structure. Directory: D:\Work\Hd.StandardWork.Exec
at EasyAbp.AbpHelper.Steps.Abp.ProjectInfoProviderStep.OnExecuteAsync(WorkflowExecutionContext context, CancellationToken cancellationToken) in D:\Repos\EasyAbp\AbpHelper.CLI\src\AbpHelper\Steps\Abp\ProjectInfoProviderStep.cs:line 36
at Elsa.Services.ActivityInvoker.InvokeAsync(WorkflowExecutionContext workflowContext, IActivity activity, Func`2 invokeAction)

我是用abp 创建的模块，2.2.1版本的。

Localization generation might need to be moved out from UI generation workflow.

AbpHelper.CLI/src/AbpHelper/Workflow/Abp/UiRazorPagesGenerationWorkflow.cs

Line 34 in d8ac17b

/* Add localization */

The reasons:

1. Maybe every UI frameworks depends on the localization.
2. Services use the localization too, it means we should create localization even if user disable the UI generator.

Maybe .sln is better than directory for code generation command.

Relate to: #19

Today the ABP CLI generate the .sln file in root directory for MVC template, but generate it in /aspnet-core directory for Angular template.

Maybe we should use -s .sln instead of -d root-directory, reasons:

1. Developers who use Angular may input the /aspnet-core directory before he know the mistake (For now the correct input is root directory). The .sln file scheme requires less learning costs.

2. AbpHelper GUI will remember solution configurations, and one day maybe ABP CLI will optimize the directory structure, so there are two different structure that need to be adapted. But if we use .sln file to locating the solution, we will not care about this changing.

3. ABP CLI also use .sln and .csproj, developers have experience. https://github.com/abpframework/abp/blob/dev/docs/en/CLI.md

给工程文件添加common.props引用

给每个工程文件*.csproj添加common.props

CRUD permissions generation.

In CrudAppService we have GetPolicyName, GetListPolicyName, CreatePolicyName, UpdatePolicyName and DeletePolicyName, maybe the basic CRUD permissions should be generated.

@model in Index.cshtml missing namespace

AbpHelper.CLI/src/AbpHelper/Templates/Crud/Groups/UiRazor/src/{{ ProjectInfo.FullName }}.Web/Pages/{{ EntityInfo.RelativeDirectory }}/{{ EntityInfo.Name }}/Index.cshtml.sbntxt

Line 5 in 75fe3d1

@model IndexModel

Should be @model {{ ProjectInfo.FullName }}.Web.Pages.{{ EntityInfo.RelativeNamespace }}.{{ EntityInfo.Name }}.IndexModel.

Module code generator: Move all the EntityName folders into ModuleName folder in Pages of Web project.

From:

To:

Reasons:

1. ModuleName folder exist when the solution was generated.
2. Avoid duplicate names with other modules and applications.
3. The blogging module does the same.

Optimize the CLI installation command in README.md

https://docs.abp.io/en/abp/latest/CLI#installation
Abp CLI doc show the following command:
dotnet tool install -g Volo.Abp.Cli

Maybe we should use:
dotnet tool install -g EasyAbp.AbpHelper.Cli or dotnet tool install -g EasyAbp.AbpHelper
to replace:
dotnet tool install AbpHelper -g

What do you think? @wakuflair

Output a success message after generation completed.

In this way, GUI user knows if the process is over.

fix: build failed in VS

build failed in VS with following error:

CS8630 Invalid 'nullable' value: 'Enable' for C# 7.3. Please use language version '8.0' or greater.

unless forcing the AbpHelper.csproj to use C# 8.0

<PropertyGroup>
   <LangVersion>8.0</LangVersion>
</PropertyGroup

Rollback mechanism for the code generator.

We need a way to rollback the code generated by the generator.

When the program runs in error, even the migration has been executed, we should rollback all the changes, or it will pollute the projects.

feat: suggest using a shorter command

currently abphelper is the command to use AbpHelper.Cli, maybe can consider using a shorter name (e.g. abph) which will be more convenient.

Need a module parent menu item.

Need parent menu item to group the Entity menu items.

For example:

Menu:TodoManagement
---- Menu:TodoManagement.Todos
-------- Menu:TodoManagement.Todos.Todo

Refer to https://github.com/abpframework/abp/blob/dev/modules/blogging/src/Volo.Blogging.Web/BloggingMenuContributor.cs#L27

Need an option to skip UI pages generation.

Maybe some entities (even aggregate roots) do not need UI pages.

What do you think? @wakuflair

MVC UI Index.cshtml page generation improvement.

https://github.com/EasyAbp/AbpHelper.CLI/blob/develop/src/AbpHelper/Templates/Crud/Groups/UiRazor/src/%7B%7B%20ProjectInfo.FullName%20%7D%7D.Web/Pages/%7B%7B%20EntityInfo.NamespaceLastPart%20%7D%7D/%7B%7B%20EntityInfo.Name%20%7D%7D/Index.cshtml.sbntxt

Refer to: https://github.com/abpframework/abp/blob/dev/modules/identity/src/Volo.Abp.Identity.Web/Pages/Identity/Roles/Index.cshtml

1. Needs "PageLayout" generation: Title, BreadCrumb and MenuItemName configurations in PageLayout.Content.

2. "<h2></h2>" should be "<abp-card-title></abp-card-title>".

3. "size-md" should be _6 and _6.

4. Creation button needs permission check. Relate to: #33 .

5. "<abp-table>" may need class="nowrap".

Add support for module

Module crud code generation miss localization.

Module code generator: folder structure adjustment.

According to Blogging module, module's entities should have full directory layers like EasyAbp/MyModule/Todos/Todo.cs.

So I tried:

But got:

Add `methods` sub command

will generate:

• Contracts project
  • Method declaration in the specified service interface
  • Dto classes(Input and Output) in the Dtos folder
• Application project
  • Empty method implementation in the specified service class

TenantId should be removed from Dtos

In multi tenancy design, CreateUpdateEntityDto and EntityDto usually do not need TenantId property.