Merge pull request #144 from codacy/add-issue-details

feat: Update pattern documentation CF-1807

Author: nedaKaighobadi

src/views/IssueDetailsProvider.ts

@@ -14,11 +14,47 @@ export class IssueDetailsProvider {
     // remove h1 and h2 from explanation's markdown
     const curatedExplanation = pattern.explanation?.replace(/^#{1,2}\s.*\n/, '')
 
+    const explanationEmptyState = `At Codacy we strive to provide great descriptions for our patterns. With good explanations developers can better understand issues and even learn how to fix them. 
+   
+For this tool we are not yet meeting this standard but you can help us improve the docs. To know more, take a look at our [tool documentation guide](https://docs.codacy.com/related-tools/tool-developer-guide/#documentation).
+
+You can also visit the tool's website to find useful tips about the patterns.`
+
+    const rationale = pattern.rationale
+      ? `### Why is this a problem?
+${pattern.rationale}`
+      : ''
+    const solution = pattern.solution
+      ? `### How to fix it
+${pattern.solution}`
+      : ''
+
+    const badExamples = pattern.badExamples?.length
+      ? `### Bad examples
+${pattern.badExamples.map((example) => `\`\`\`\n ${example}\n\`\`\``)}`
+      : ''
+    const goodExamples = pattern.goodExamples?.length
+      ? `### Good examples
+${pattern.goodExamples.map((example) => `\`\`\`\n ${example}\n\`\`\``)}`
+      : ''
+
+    const examples =
+      pattern.badExamples?.length || pattern.goodExamples?.length
+        ? `### Examples
+${badExamples}
+${goodExamples}`
+        : ''
+
     return `
 ## ${pattern.title}
-${pattern.description}
+${rationale}
+
+${solution}
+
+${examples}
 
-${curatedExplanation}
+## ${tool?.name}'s documentation
+${pattern.explanation ? curatedExplanation : explanationEmptyState}
 
 ---