From d1ff8784c6901a2f57bac292d9347d5664dd4616 Mon Sep 17 00:00:00 2001
From: Yurii Dubinka <yurii.dubinka@gmail.com>
Date: Fri, 29 Apr 2022 20:25:53 +0300
Subject: [PATCH] #113: Use single format of TODO items within your codebase
 (#138)

---
 .../formatting/arch4u-code-style-ruleset.xml  | 26 ++++++++++++++-----
 .../dgroup/arch4u/pmd/xml/TodoFormat.xml      |  8 +++---
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/src/main/resources/io/github/dgroup/arch4u/pmd/formatting/arch4u-code-style-ruleset.xml b/src/main/resources/io/github/dgroup/arch4u/pmd/formatting/arch4u-code-style-ruleset.xml
index 67d0b54..2bc755e 100644
--- a/src/main/resources/io/github/dgroup/arch4u/pmd/formatting/arch4u-code-style-ruleset.xml
+++ b/src/main/resources/io/github/dgroup/arch4u/pmd/formatting/arch4u-code-style-ruleset.xml
@@ -29,21 +29,33 @@
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
          xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
   <description>arch4u rules related to code style</description>
-  <!-- @todo #113/DEV TodoFormat: Add reference to the discussions from 'message' and 'externalInfoUrl'. -->
   <rule name="TodoFormat"
         since="0.2.0"
         language="java"
-        externalInfoUrl="https://github.com/dgroup/arch4u-pmd/discussions/..."
-        message="Use single format of TODO items within your codebase: https://github.com/dgroup/arch4u-pmd/discussions/..."
+        externalInfoUrl="https://github.com/dgroup/arch4u-pmd/discussions/137"
+        message="Use single format of TODO items within your codebase: https://github.com/dgroup/arch4u-pmd/discussions/137"
         class="io.github.dgroup.arch4u.pmd.TodoFormat">
-    <!-- @todo #113/DEV TodoFormat: Make proper description and example for this rule -->
     <description>
-      ...
-      Read more: https://github.com/dgroup/arch4u-pmd/discussions/...
+      Use single format of TODO items within your codebase.
+      Read more: https://github.com/dgroup/arch4u-pmd/discussions/137
     </description>
     <priority>3</priority>
     <example>
-      ...
+      /**
+       * ...
+       * TODO Add REST API endpoint that supports OpenAPI and Web-Flux
+       *  We need a way how to generate OpenAPI specifications that supports Web-Flux.
+       *  Ensure that ....
+       *  labels: enhancement, help wanted
+       *  assignees: dgroup
+       *  milestone: 2
+       *
+       * Other javadoc elements
+       * @return The id of created entity.
+       */
+      public Long create(@Valid @RequestBody Employee employee) {
+           // ...
+      }
     </example>
   </rule>
 </ruleset>
diff --git a/src/test/resources/io/github/dgroup/arch4u/pmd/xml/TodoFormat.xml b/src/test/resources/io/github/dgroup/arch4u/pmd/xml/TodoFormat.xml
index 08beafb..11f62b0 100644
--- a/src/test/resources/io/github/dgroup/arch4u/pmd/xml/TodoFormat.xml
+++ b/src/test/resources/io/github/dgroup/arch4u/pmd/xml/TodoFormat.xml
@@ -160,7 +160,7 @@ public class User {
     <expected-problems>1</expected-problems>
     <expected-linenumbers>10</expected-linenumbers>
     <expected-messages>
-      <message>The TODO subject " - TODO Wrong subject" should start from TODO, non-blank and less or equal 255: https://github.com/dgroup/arch4u-pmd/discussions/...</message>
+      <message>The TODO subject " - TODO Wrong subject" should start from TODO, non-blank and less or equal 255: https://github.com/dgroup/arch4u-pmd/discussions/137</message>
     </expected-messages>
     <code><![CDATA[
 public class User {
@@ -201,7 +201,7 @@ public class User {
     <expected-problems>1</expected-problems>
     <expected-linenumbers>10</expected-linenumbers>
     <expected-messages>
-      <message>The TODO subject " - TODO" should start from TODO, non-blank and less or equal 255: https://github.com/dgroup/arch4u-pmd/discussions/...</message>
+      <message>The TODO subject " - TODO" should start from TODO, non-blank and less or equal 255: https://github.com/dgroup/arch4u-pmd/discussions/137</message>
     </expected-messages>
     <code><![CDATA[
 public class User {
@@ -234,7 +234,7 @@ public class User {
     <expected-problems>1</expected-problems>
     <expected-linenumbers>2</expected-linenumbers>
     <expected-messages>
-      <message>The TODO subject " TODO Subject is too big and more than 5 symbols allowed" should start from TODO, non-blank and less or equal 5: https://github.com/dgroup/arch4u-pmd/discussions/...</message>
+      <message>The TODO subject " TODO Subject is too big and more than 5 symbols allowed" should start from TODO, non-blank and less or equal 5: https://github.com/dgroup/arch4u-pmd/discussions/137</message>
     </expected-messages>
     <code><![CDATA[
     /**
@@ -274,7 +274,7 @@ public class User {
     <expected-problems>1</expected-problems>
     <expected-linenumbers>3</expected-linenumbers>
     <expected-messages>
-      <message>The TODO description "[  1st line,   2nd line]" should be aligned and has at least 5 or more words: https://github.com/dgroup/arch4u-pmd/discussions/...</message>
+      <message>The TODO description "[  1st line,   2nd line]" should be aligned and has at least 5 or more words: https://github.com/dgroup/arch4u-pmd/discussions/137</message>
     </expected-messages>
     <code><![CDATA[
     /**