src/main/kotlin/translations/intentions/TranslationFileAnnotator.kt diff

← → edited src/main/kotlin/translations/intentions/TranslationFileAnnotator.kt

Ignore whitespaces Open in IDE

⁠ joe: 2025

Copy Copy

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2024 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.translations.intentions

import com.demonwav.mcdev.translations.Translation
import com.demonwav.mcdev.translations.TranslationFiles
import com.demonwav.mcdev.translations.index.TranslationIndex
import com.demonwav.mcdev.translations.lang.gen.psi.LangTypes
import com.demonwav.mcdev.util.mcDomain
import com.intellij.lang.annotation.AnnotationHolder
import com.intellij.lang.annotation.Annotator
import com.intellij.lang.annotation.HighlightSeverity
import com.intellij.psi.PsiElement

class TranslationFileAnnotator : Annotator {
override fun annotate(element: PsiElement, annotations: AnnotationHolder) {
val translation = TranslationFiles.toTranslation(element)
if (translation != null) {
checkEntryKey(element, translation, annotations)
checkEntryDuplicates(element, translation, annotations)
checkEntryMatchesDefault(element, translation, annotations)
}
if (element.node.elementType == LangTypes.DUMMY) {
annotations.newAnnotation(HighlightSeverity.ERROR, "Translations must not contain incomplete entries.")
.range(element)
.create()
}
}

private fun checkEntryKey(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
if (translation.key != translation.trimmedKey) {
annotations.newAnnotation(HighlightSeverity.WARNING, "Translation key contains whitespace at start or end.")
.range(element)
.newFix(TrimKeyIntention(element)).universal().registerFix()
.create()
}
}

private fun checkEntryDuplicates(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
val count = TranslationIndex.getTranslations(element.containingFile).count { it.key == translation.key }
if (count > 1) {
annotations.newAnnotation(HighlightSeverity.WARNING, "Duplicate translation keys \"${translation.key}\".")
.newFix(RemoveDuplicatesIntention(translation, element)).universal().registerFix()
.create()
}
}

private fun checkEntryMatchesDefault(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
val domain = element.containingFile?.virtualFile?.mcDomain
val defaultEntries = TranslationIndex.getAllDefaultEntries(element.project, domain)
if (defaultEntries.any { it.contains(translation.key) }) {
return
}
val warningText = "Translation key not included in default localization file."
annotations.newAnnotation(HighlightSeverity.WARNING, warningText)
.newFix(RemoveUnmatchedEntryIntention(element)).universal().registerFix()
.create()
}
}

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2025 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.translations.intentions

import com.demonwav.mcdev.translations.Translation
import com.demonwav.mcdev.translations.TranslationFiles
import com.demonwav.mcdev.translations.index.TranslationIndex
import com.demonwav.mcdev.translations.lang.gen.psi.LangTypes
import com.demonwav.mcdev.util.mcDomain
import com.intellij.lang.annotation.AnnotationHolder
import com.intellij.lang.annotation.Annotator
import com.intellij.lang.annotation.HighlightSeverity
import com.intellij.psi.PsiElement

class TranslationFileAnnotator : Annotator {
override fun annotate(element: PsiElement, annotations: AnnotationHolder) {
val translation = TranslationFiles.toTranslation(element)
if (translation != null) {
checkEntryKey(element, translation, annotations)
checkEntryDuplicates(element, translation, annotations)
checkEntryMatchesDefault(element, translation, annotations)
}
if (element.node.elementType == LangTypes.DUMMY) {
annotations.newAnnotation(HighlightSeverity.ERROR, "Translations must not contain incomplete entries.")
.range(element)
.create()
}
}

private fun checkEntryKey(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
if (translation.key != translation.trimmedKey) {
annotations.newAnnotation(HighlightSeverity.WARNING, "Translation key contains whitespace at start or end.")
.range(element)
.newFix(TrimKeyIntention(element)).universal().registerFix()
.create()
}
}

private fun checkEntryDuplicates(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
val count = TranslationIndex.getTranslations(element.containingFile).count { it.key == translation.key }
if (count > 1) {
annotations.newAnnotation(HighlightSeverity.WARNING, "Duplicate translation keys \"${translation.key}\".")
.newFix(RemoveDuplicatesIntention(translation, element)).universal().registerFix()
.create()
}
}

private fun checkEntryMatchesDefault(element: PsiElement, translation: Translation, annotations: AnnotationHolder) {
val domain = element.containingFile?.virtualFile?.mcDomain
val defaultEntries = TranslationIndex.getAllDefaultEntries(element.project, domain)
if (defaultEntries.any { it.contains(translation.key) }) {
return
}
val warningText = "Translation key not included in default localization file."
annotations.newAnnotation(HighlightSeverity.WARNING, warningText)
.newFix(RemoveUnmatchedEntryIntention(element)).universal().registerFix()
.create()
}
}

/* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2024 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.translations.intentions import com.demonwav.mcdev.translations.Translation import com.demonwav.mcdev.translations.TranslationFiles import com.demonwav.mcdev.translations.index.TranslationIndex import com.demonwav.mcdev.translations.lang.gen.psi.LangTypes import com.demonwav.mcdev.util.mcDomain import com.intellij.lang.annotation.AnnotationHolder import com.intellij.lang.annotation.Annotator import com.intellij.lang.annotation.HighlightSeverity import com.intellij.psi.PsiElement class TranslationFileAnnotator : Annotator { override fun annotate(element: PsiElement, annotations: AnnotationHolder) { val translation = TranslationFiles.toTranslation(element) if (translation != null) { checkEntryKey(element, translation, annotations) checkEntryDuplicates(element, translation, annotations) checkEntryMatchesDefault(element, translation, annotations) } if (element.node.elementType == LangTypes.DUMMY) { annotations.newAnnotation(HighlightSeverity.ERROR, "Translations must not contain incomplete entries.") .range(element) .create() } } private fun checkEntryKey(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { if (translation.key != translation.trimmedKey) { annotations.newAnnotation(HighlightSeverity.WARNING, "Translation key contains whitespace at start or end.") .range(element) .newFix(TrimKeyIntention(element)).universal().registerFix() .create() } } private fun checkEntryDuplicates(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { val count = TranslationIndex.getTranslations(element.containingFile).count { it.key == translation.key } if (count > 1) { annotations.newAnnotation(HighlightSeverity.WARNING, "Duplicate translation keys \"${translation.key}\".") .newFix(RemoveDuplicatesIntention(translation, element)).universal().registerFix() .create() } } private fun checkEntryMatchesDefault(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { val domain = element.containingFile?.virtualFile?.mcDomain val defaultEntries = TranslationIndex.getAllDefaultEntries(element.project, domain) if (defaultEntries.any { it.contains(translation.key) }) { return } val warningText = "Translation key not included in default localization file." annotations.newAnnotation(HighlightSeverity.WARNING, warningText) .newFix(RemoveUnmatchedEntryIntention(element)).universal().registerFix() .create() } } /* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2025 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.translations.intentions import com.demonwav.mcdev.translations.Translation import com.demonwav.mcdev.translations.TranslationFiles import com.demonwav.mcdev.translations.index.TranslationIndex import com.demonwav.mcdev.translations.lang.gen.psi.LangTypes import com.demonwav.mcdev.util.mcDomain import com.intellij.lang.annotation.AnnotationHolder import com.intellij.lang.annotation.Annotator import com.intellij.lang.annotation.HighlightSeverity import com.intellij.psi.PsiElement class TranslationFileAnnotator : Annotator { override fun annotate(element: PsiElement, annotations: AnnotationHolder) { val translation = TranslationFiles.toTranslation(element) if (translation != null) { checkEntryKey(element, translation, annotations) checkEntryDuplicates(element, translation, annotations) checkEntryMatchesDefault(element, translation, annotations) } if (element.node.elementType == LangTypes.DUMMY) { annotations.newAnnotation(HighlightSeverity.ERROR, "Translations must not contain incomplete entries.") .range(element) .create() } } private fun checkEntryKey(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { if (translation.key != translation.trimmedKey) { annotations.newAnnotation(HighlightSeverity.WARNING, "Translation key contains whitespace at start or end.") .range(element) .newFix(TrimKeyIntention(element)).universal().registerFix() .create() } } private fun checkEntryDuplicates(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { val count = TranslationIndex.getTranslations(element.containingFile).count { it.key == translation.key } if (count > 1) { annotations.newAnnotation(HighlightSeverity.WARNING, "Duplicate translation keys \"${translation.key}\".") .newFix(RemoveDuplicatesIntention(translation, element)).universal().registerFix() .create() } } private fun checkEntryMatchesDefault(element: PsiElement, translation: Translation, annotations: AnnotationHolder) { val domain = element.containingFile?.virtualFile?.mcDomain val defaultEntries = TranslationIndex.getAllDefaultEntries(element.project, domain) if (defaultEntries.any { it.contains(translation.key) }) { return } val warningText = "Translation key not included in default localization file." annotations.newAnnotation(HighlightSeverity.WARNING, warningText) .newFix(RemoveUnmatchedEntryIntention(element)).universal().registerFix() .create() } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?