Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing descriptions for Inspections #27

Open
SrTobi opened this issue Apr 29, 2020 · 0 comments
Open

Missing descriptions for Inspections #27

SrTobi opened this issue Apr 29, 2020 · 0 comments

Comments

@SrTobi
Copy link
Contributor

SrTobi commented Apr 29, 2020

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SrTobi