intellij-hocon icon indicating copy to clipboard operation
intellij-hocon copied to clipboard

Missing descriptions for Inspections

Open SrTobi opened this issue 4 years ago • 0 comments

Hi,

Hocon has two inspections:

org.jetbrains.plugins.hocon.ref.HoconIncludeResolutionInspection
org.jetbrains.plugins.hocon.ref.HoconRequiredIncludeResolutionInspection

They both are missing description files what leads to errors. To add description files, just add html files with the shortname of the inspection + .html into ./resoures/inspectionDescriptions and fill them with a description inside a html body:

<html>
<body>
[Description goes here]
</body>
</html>

You might want to consider a test that checks that inspections have descriptions like we have in the scala plugin: https://github.com/JetBrains/intellij-scala/blob/idea202.x/scala/scala-impl/test/org/jetbrains/plugins/scala/codeInspection/GeneralInspectionSanityTest.scala

(See https://youtrack.jetbrains.com/issue/SCL-17483)

SrTobi avatar Apr 29 '20 10:04 SrTobi