juancgalvis/scaffold-clean-architecture

Gradle plugin to create a clean application in Java that already works, It follows our best practices!

Scaffolding of Clean Architecture

Gradle plugin to create a java application based on Clean Architecture following our best practices!

Plugin Implementation

To use the plugin you need Gradle version 5 or later, to start add the following section into your build.gradle file.

plugins {
 id "co.com.bancolombia.cleanArchitecture" version "1.5.4"
}

Tasks

The Scaffolding Clean Architecture plugin will allow you create 6 task :

1 The cleanArchitecture | ca task will generate a clean architecture structure in your project, this task have three optional parameters; package , type and name.

package = <package.we.need>: You can specify the main or default package of your project. Default Value = co.com.bancolombia

• type = <imperative | reactive>: With this parameter the task will generate a POO project. Default Value = imperative

• name = NameProject: This parameter is going to specify the name of the project. Default Value = cleanArchitecture

gradle cleanArchitecture --package=co.com.bancolombia --type=imperative --name=NameProject
gradle ca 

2 The generateModel | gm task will generate a class and interface in model layer, this task have one required parameter name.

gradle generateModel --name=[modelName]
gradle gm --name [modelName]

3 The generateUseCase | guc task will generate a class in model layer, this task have one required parameter name.

gradle generateUseCase --name=[useCaseName]
gradle guc --name [useCaseName]

4 The generateDrivenAdapter | gda task will generate a class in Infrastructure layer, this task have one required parameter value.

gradle generateDrivenAdapter --value=[referenceNumberDrivenAdapter]
gradle gda --value [referenceNumberDrivenAdapter]

Reference driven adapter value	Name
1	JPA Repository
2	Mongo Repository
3	Async Event Bus

5 The generateEntryPoint | gep task will generate a class in Infrastructure layer, this task have one required parameter value.

gradle generateEntryPoint --value=referenceNumberEntryPoint
gradle gep --value referenceNumberEntryPoint

Reference entry point value	Name
1	API REST (Spring Boot Starter Web)
2	API REST (Spring Boot Starter WebFlux)

6 The validateStructure | vs Validate that project references aren't violated.

gradle validateStructure  
gradle vs

7 The generatePipeline | gpl task will generate CI pipeline inside the folder "./deployment/", this task have one required parameter value.

gradle generatePipeline --value=referenceNumberPipeline
gradle gpl --value referenceNumberPipeline

Reference pipeline value	Name
1	Azure DevOps

How I can help?

Review the issues, we hear new ideas.