Merge pull request #48 from croz-ltd/feature_addModuleDescriptions

Feature add module descriptions
croz-ltd · Mar 18, 2022 · 24670c2 · 24670c2
2 parents 5ca4e3e + ca65a9e
commit 24670c2
Show file tree

Hide file tree

Showing 38 changed files with 78 additions and 7 deletions.
diff --git a/build.gradle b/build.gradle
@@ -95,8 +95,11 @@ subprojects {
         suppressAllPomMetadataWarnings()
 
         pom {
-          name = getProject().getName()
-          description = projectDescription
+          afterEvaluate {
+            name = project.name
+            description = project.description
+          }
+
           url = projectRepositoryUrl
 
           licenses {

diff --git a/gradle.properties b/gradle.properties
@@ -14,7 +14,6 @@ developerOrganization=CROZ Ltd
 developerOrganizationUrl=https://croz.net
 licenseName=The Apache License, Version 2.0
 licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.txt
-projectDescription=Java library whose purpose is to make development of applications on JVM a little easier
 projectRepositoryUrl=https://github.com/croz-ltd/nrich
 
 # Maven Central

diff --git a/nrich-bom/build.gradle b/nrich-bom/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Bill of Materials (BOM)"
+
 List<Project> nrichProjectList = rootProject.subprojects.findAll { !it.name.endsWith(project.name) }.sort { it.name }
 
 dependencies {

diff --git a/nrich-core-api/build.gradle b/nrich-core-api/build.gradle
@@ -0,0 +1 @@
+description = "Nrich Core API"
diff --git a/nrich-encrypt-api/build.gradle b/nrich-encrypt-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Encrypt API"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"

diff --git a/nrich-encrypt-spring-boot-starter/build.gradle b/nrich-encrypt-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Encrypt Spring Boot starter"
+
 dependencies {
   api project(":nrich-encrypt-api")
 
@@ -21,5 +23,4 @@ dependencies {
   testImplementation "org.junit.jupiter:junit-jupiter-api"
   testImplementation "org.junit.jupiter:junit-jupiter-params"
   testImplementation "org.springframework.boot:spring-boot-test"
-
 }
diff --git a/nrich-encrypt/build.gradle b/nrich-encrypt/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides support for encryption and decryption of data"
+
 dependencies {
   api project(":nrich-encrypt-api")
 

diff --git a/nrich-excel-api/build.gradle b/nrich-excel-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Excel API"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"

diff --git a/nrich-excel-spring-boot-starter/build.gradle b/nrich-excel-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Excel Spring Boot starter"
+
 dependencies {
   api project(":nrich-excel-api")
 

diff --git a/nrich-excel/build.gradle b/nrich-excel/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides support for easier creation of Excel reports"
+
 dependencies {
   api project(":nrich-excel-api")
 

diff --git a/nrich-form-configuration-api/build.gradle b/nrich-form-configuration-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Form Configuration API"
+
 dependencies {
   api "jakarta.validation:jakarta.validation-api"
 

diff --git a/nrich-form-configuration-spring-boot-starter/build.gradle b/nrich-form-configuration-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Form Configuration Spring Boot starter"
+
 dependencies {
   api project(":nrich-form-configuration-api")
 

diff --git a/nrich-form-configuration/build.gradle b/nrich-form-configuration/build.gradle
@@ -1,3 +1,5 @@
+description = "Converts server side Bean Validation constraints to a form that can be used to apply them on the client side"
+
 dependencies {
   api project(":nrich-form-configuration-api")
 

diff --git a/nrich-jackson-spring-boot-starter/build.gradle b/nrich-jackson-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Jackson Spring Boot starter. Additionally configures some useful defaults for Jackson"
+
 dependencies {
   annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
   annotationProcessor "org.projectlombok:lombok"

diff --git a/nrich-jackson/build.gradle b/nrich-jackson/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides Jackson modules for serializing class names and converting empty strings to null"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"

diff --git a/nrich-logging-api/build.gradle b/nrich-logging-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Logging API"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"

diff --git a/nrich-logging/build.gradle b/nrich-logging/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides a unified way of logging exceptions"
+
 dependencies {
   api project(":nrich-logging-api")
 

diff --git a/nrich-notification-api/build.gradle b/nrich-notification-api/build.gradle
@@ -1,8 +1,9 @@
+description = "Nrich Notification API"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"
 
   implementation "jakarta.validation:jakarta.validation-api"
   implementation "org.springframework:spring-context"
-
 }
diff --git a/nrich-notification-spring-boot-starter/build.gradle b/nrich-notification-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Notification Spring Boot starter"
+
 dependencies {
   api project(":nrich-notification-api")
 

diff --git a/nrich-notification/build.gradle b/nrich-notification/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides a unified response format for data returned to clients"
+
 dependencies {
   api project(":nrich-notification-api")
 

diff --git a/nrich-registry-api/build.gradle b/nrich-registry-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Registry API"
+
 dependencies {
   api project(":nrich-search-api")
 

diff --git a/nrich-registry-spring-boot-starter/build.gradle b/nrich-registry-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Registry Spring Boot starter"
+
 dependencies {
   api project(":nrich-registry-api")
 

diff --git a/nrich-registry/build.gradle b/nrich-registry/build.gradle
@@ -1,3 +1,8 @@
+description = """
+  Provides a representation of JPA entities in a format that can be used on the client side to build dynamic forms and tables,
+  as well as a REST API for querying, updating and deleting those entities
+"""
+
 dependencies {
   api project(":nrich-registry-api")
   api "jakarta.validation:jakarta.validation-api"

diff --git a/nrich-search-api/build.gradle b/nrich-search-api/build.gradle
@@ -1,8 +1,9 @@
+description = "Nrich Search API"
+
 dependencies {
   api "jakarta.persistence:jakarta.persistence-api"
   api "jakarta.validation:jakarta.validation-api"
 
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"
-
 }
diff --git a/nrich-search-repository-api/build.gradle b/nrich-search-repository-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Search Repository API"
+
 dependencies {
   api project(":nrich-search-api")
   api "org.springframework.data:spring-data-commons"

diff --git a/nrich-search-spring-boot-starter/build.gradle b/nrich-search-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Search Spring Boot starter"
+
 dependencies {
   api project(":nrich-search-api")
   api project(":nrich-search-repository-api")

diff --git a/nrich-search/build.gradle b/nrich-search/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides an easy way of querying of JPA entities through automatic query creation from passed in data (either strings or classes that hold restriction values)"
+
 dependencies {
   api project(":nrich-search-api")
   api project(":nrich-search-repository-api")

diff --git a/nrich-security-csrf-api/build.gradle b/nrich-security-csrf-api/build.gradle
@@ -0,0 +1 @@
+description = "Nrich Security CSRF API"
diff --git a/nrich-security-csrf-spring-boot-starter/build.gradle b/nrich-security-csrf-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Security CSRF Spring Boot starter"
+
 dependencies {
   api project(":nrich-security-csrf-api")
 

diff --git a/nrich-security-csrf/build.gradle b/nrich-security-csrf/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides CSRF support"
+
 dependencies {
   api project(":nrich-security-csrf-api")
 

diff --git a/nrich-spring-boot/build.gradle b/nrich-spring-boot/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides additional functionality on top of Spring Boot"
+
 dependencies {
   implementation "org.springframework.boot:spring-boot-autoconfigure"
 

diff --git a/nrich-spring-util/build.gradle b/nrich-spring-util/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides additional functionality on top of Spring"
+
 dependencies {
   annotationProcessor "org.projectlombok:lombok"
   compileOnly "org.projectlombok:lombok"

diff --git a/nrich-validation-api/build.gradle b/nrich-validation-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Validation API"
+
 dependencies {
   api "jakarta.validation:jakarta.validation-api"
 }
diff --git a/nrich-validation-spring-boot-starter/build.gradle b/nrich-validation-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Validation Spring Boot starter"
+
 dependencies {
   api project(":nrich-validation-api")
 

diff --git a/nrich-validation/build.gradle b/nrich-validation/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides additional Bean Validation constraints"
+
 dependencies {
   api project(":nrich-validation-api")
 

diff --git a/nrich-webmvc-api/build.gradle b/nrich-webmvc-api/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Web MVC API"
+
 dependencies {
   api "jakarta.servlet:jakarta.servlet-api"
 }
diff --git a/nrich-webmvc-spring-boot-starter/build.gradle b/nrich-webmvc-spring-boot-starter/build.gradle
@@ -1,3 +1,5 @@
+description = "Nrich Web MVC Spring Boot starter"
+
 dependencies {
   api project(":nrich-webmvc-api")
 

diff --git a/nrich-webmvc/build.gradle b/nrich-webmvc/build.gradle
@@ -1,3 +1,5 @@
+description = "Provides @RestControllerAdvice for exception logging and notification resolving and additional serialization and locale features"
+
 dependencies {
   api project(":nrich-webmvc-api")
 
@@ -30,5 +32,4 @@ dependencies {
   testImplementation "org.junit.jupiter:junit-jupiter-params"
   testImplementation "org.mockito:mockito-core"
   testImplementation "org.springframework:spring-test"
-
 }