SONAR-5001 Allow Markdown for rule property descriptions

diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
index 68d4891f9384c5ad6d7db04c73e608789ed22a2d..2b54eeea59ba85afc7f3700816a65798e0c35a5c 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
@@ -133,7 +133,7 @@ public class RuleMapping extends BaseMapping<RuleDoc, RuleMappingContext> {
           json
             .beginObject()
             .prop("key", param.key())
-            .prop("desc", param.description())
+            .prop("htmlDesc", param.description() == null ? null : Markdown.convertToHtml(param.description()))
             .prop("defaultValue", param.defaultValue())
             .endObject();
         }

diff --git a/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java b/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
index c5f1c0312e78bc234a61ed10b2767109f5855ebf..cc4819a9a582bfdda6fee57d36fb30eafdd97135 100644 (file)
--- a/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
@@ -88,7 +88,7 @@ public class ShowActionMediumTest {
         .setTags(newHashSet("tag1", "tag2"))
         .setSystemTags(newHashSet("systag1", "systag2"))
     );
-    RuleParamDto param = RuleParamDto.createFor(ruleDto).setName("regex").setType("STRING").setDescription("Reg ex").setDefaultValue(".*");
+    RuleParamDto param = RuleParamDto.createFor(ruleDto).setName("regex").setType("STRING").setDescription("Reg *exp*").setDefaultValue(".*");
     ruleDao.addRuleParam(session, ruleDto, param);
     session.commit();
     session.clearCache();

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
index 648e6c9b2fe5971685a268774fb937e4751404ea..2e3f3fa36ef869c98932223f10acd0d6716fd1b6 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
@@ -18,7 +18,7 @@
     "params": [
       {
         "key": "regex",
-        "desc": "Reg ex",
+        "htmlDesc": "Reg ex",
         "defaultValue": "a.*"
       }
     ]

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
index c2938aeb995f4bf6bb1d80351056052552b13d94..ec25f48afc4cc665009f364eec50153d28e6d1cc 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
@@ -4,12 +4,12 @@
     "params": [
       {
         "key": "my_var",
-        "desc": "My small description",
+        "htmlDesc": "My small description",
         "defaultValue": "some value"
       },
       {
         "key": "the_var",
-        "desc": "My small description",
+        "htmlDesc": "My small description",
         "defaultValue": "other value"
       }
     ]

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
index 20a27a3b6837d0c855f2a02a6e1c6061498d189f..a80d4e3fb397ab74730a6b2fdafdaa47a2403dea 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
@@ -13,7 +13,7 @@
     "params": [
       {
         "key": "regex",
-        "desc": "Reg ex",
+        "htmlDesc": "Reg <em>exp</em>",
         "defaultValue": ".*"
       }
     ]

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
index 648e6c9b2fe5971685a268774fb937e4751404ea..2e3f3fa36ef869c98932223f10acd0d6716fd1b6 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
@@ -18,7 +18,7 @@
     "params": [
       {
         "key": "regex",
-        "desc": "Reg ex",
+        "htmlDesc": "Reg ex",
         "defaultValue": "a.*"
       }
     ]

diff --git a/server/sonar-web/src/main/hbs/coding-rules/coding-rules-detail.hbs b/server/sonar-web/src/main/hbs/coding-rules/coding-rules-detail.hbs
index 2165c6552d6f9bf252ad2e580d81ed6ac843aa75..06ba87d17824f018b1ac777203cfa32986fee5fc 100644 (file)
--- a/server/sonar-web/src/main/hbs/coding-rules/coding-rules-detail.hbs
+++ b/server/sonar-web/src/main/hbs/coding-rules/coding-rules-detail.hbs
@@ -117,7 +117,7 @@
             <span class="value">{{defaultValue}}</span>
           {{else}}
             <div class="coding-rules-detail-parameter-description">
-              {{desc}}
+              {{{htmlDesc}}}
               {{#if defaultValue}}
                 <div>
                   {{t 'coding_rules.parameters.default_value'}} {{defaultValue}}