MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-19 21:11:28 +07:00
Code Issues Packages Projects Releases Wiki Activity

[Java. Code Formatting] IDEA-168035 Distinct annotation formatting option for type/value/field/method annotations

Browse Source 
- Add jspecify nullability annotations as known type annotations

GitOrigin-RevId: 6560fc183a995a7c5b43b50e0c27995df090b7a6
This commit is contained in:
Georgii Ustinov
2025-08-27 17:37:41 +03:00
committed by intellij-monorepo-bot
parent fd3e7fd3df
commit 168c2a50db
30 changed files with 608 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
java/java-frontback-impl/src/com/intellij/psi/formatter/java/JavaFormatterAnnotationUtil.kt
View File

@@ -17,7 +17,9 @@ import com.intellij.psi.util.PsiTreeUtil
internal object JavaFormatterAnnotationUtil {
private val KNOWN_TYPE_ANNOTATIONS: Set<String> = setOf(
"org.jetbrains.annotations.NotNull",
"org.jetbrains.annotations.Nullable"
"org.jetbrains.annotations.Nullable",
"org.jspecify.annotations.NonNull",
"org.jspecify.annotations.Nullable",
)
/**

3
java/java-psi-api/src/com/intellij/codeInsight/AnnotationUtil.java
View File

@@ -26,6 +26,9 @@ public class AnnotationUtil {
public static final String NOT_NULL = "org.jetbrains.annotations.NotNull";
public static final String NOT_NULL_BY_DEFAULT = "org.jetbrains.annotations.NotNullByDefault";
public static final String J_SPECIFY_NON_NULL = "org.jspecify.annotations.NonNull";
public static final String J_SPECIFY_NULLABLE = "org.jspecify.annotations.Nullable";
public static final String NON_NLS = "org.jetbrains.annotations.NonNls";
public static final String NLS = "org.jetbrains.annotations.Nls";

4
java/java-psi-api/src/com/intellij/codeInsight/DumbAwareAnnotationUtil.kt
View File

@@ -19,7 +19,9 @@ object DumbAwareAnnotationUtil {
private val KNOWN_ANNOTATIONS = setOf(
AnnotationUtil.NOT_NULL,
AnnotationUtil.NULLABLE,
AnnotationUtil.NON_NLS
AnnotationUtil.NON_NLS,
AnnotationUtil.J_SPECIFY_NON_NULL,
AnnotationUtil.J_SPECIFY_NULLABLE
)
/**

18
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/CustomAnnotation.java Normal file
View File

@@ -0,0 +1,18 @@
package org.example;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import java.util.List;
@Target({ElementType.TYPE_USE})
@interface CustomAnno {}
public class Formatter {
@CustomAnno String getCustomString() {
return null;
}
@CustomAnno <T, V> List<T> getCustomList() {
return null;
}
}

21
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/CustomAnnotation_after.java Normal file
View File

@@ -0,0 +1,21 @@
package org.example;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import java.util.List;
@Target({ElementType.TYPE_USE})
@interface CustomAnno {
}
public class Formatter {
@CustomAnno
String getCustomString() {
return null;
}
@CustomAnno
<T, V> List<T> getCustomList() {
return null;
}
}

23
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/FullyQualifiedName.java Normal file
View File

@@ -0,0 +1,23 @@
package org.example;
public class Formatter {
@org.jspecify.annotations.NonNull
<T, V> List<T> getNotNullList() {
return List.of();
}
@org.jspecify.annotations.Nullable
<T, V> List<T> getNullableList() {
return null;
}
@org.jspecify.annotations.NonNull
String getNotNullName() {
return "";
}
@org.jspecify.annotations.Nullable
String getNullableName() {
return null;
}
}

19
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/FullyQualifiedName_after.java Normal file
View File

@@ -0,0 +1,19 @@
package org.example;
public class Formatter {
@org.jspecify.annotations.NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@org.jspecify.annotations.Nullable <T, V> List<T> getNullableList() {
return null;
}
@org.jspecify.annotations.NonNull String getNotNullName() {
return "";
}
@org.jspecify.annotations.Nullable String getNullableName() {
return null;
}
}

16
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ImportMix.java Normal file
View File

@@ -0,0 +1,16 @@
package org.example;
import org.jspecify.annotations.*;
import java.util.List;
public class Formatter {
@NonNull @org.jspecify.annotations.Nullable
<T, V> List<T> getNotNullList() {
return List.of();
}
@NonNull @org.jspecify.annotations.Nullable
String getNotNullName() {
return "";
}
}

15
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ImportMix_after.java Normal file
View File

@@ -0,0 +1,15 @@
package org.example;
import org.jspecify.annotations.*;
import java.util.List;
public class Formatter {
@NonNull @org.jspecify.annotations.Nullable <T, V> List<T> getNotNullList() {
return List.of();
}
@NonNull @org.jspecify.annotations.Nullable String getNotNullName() {
return "";
}
}

26
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ImportOnDemand.java Normal file
View File

@@ -0,0 +1,26 @@
package org.example;
import org.jspecify.annotations.*;
import java.util.List;
public class Formatter {
@NonNull
<T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable
<T, V> List<T> getNullableList() {
return null;
}
@NonNull
String getNotNullName() {
return "";
}
@Nullable
String getNullableName() {
return null;
}
}

23
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ImportOnDemand_after.java Normal file
View File

@@ -0,0 +1,23 @@
package org.example;
import org.jspecify.annotations.*;
import java.util.List;
public class Formatter {
@NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable <T, V> List<T> getNullableList() {
return null;
}
@NonNull String getNotNullName() {
return "";
}
@Nullable String getNullableName() {
return null;
}
}

27
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KeepLineBreaks.java Normal file
View File

@@ -0,0 +1,27 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull
@Nullable String breakLineBetweenAnnotations() {
return "";
}
@Nullable @NonNull
String breakLineBetweenTypeAndAnnotations() {
return null;
}
@Nullable
<T> String breakLineBetweenTypeParameterAndAnnotation() {
return null;
}
@Nullable
@NonNull
<T> String breakLineMixed() {
return null;
}
}

27
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KeepLineBreaks_after.java Normal file
View File

@@ -0,0 +1,27 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull
@Nullable String breakLineBetweenAnnotations() {
return "";
}
@Nullable @NonNull
String breakLineBetweenTypeAndAnnotations() {
return null;
}
@Nullable
<T> String breakLineBetweenTypeParameterAndAnnotation() {
return null;
}
@Nullable
@NonNull
<T> String breakLineMixed() {
return null;
}
}

14
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KnownAnnotationBeforeType.java Normal file
View File

@@ -0,0 +1,14 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull String getNotNullName() {
return "";
}
@Nullable String getNullableName() {
return null;
}
}

16
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KnownAnnotationBeforeTypeParameterList.java Normal file
View File

@@ -0,0 +1,16 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable <T, V> List<T> getNullableList() {
return null;
}
}

16
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KnownAnnotationBeforeTypeParameterList_after.java Normal file
View File

@@ -0,0 +1,16 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable <T, V> List<T> getNullableList() {
return null;
}
}

14
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/KnownAnnotationBeforeType_after.java Normal file
View File

@@ -0,0 +1,14 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull String getNotNullName() {
return "";
}
@Nullable String getNullableName() {
return null;
}
}

24
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/LowLanguageLevel.java Normal file
View File

@@ -0,0 +1,24 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull @Nullable String breakLineBetweenAnnotations() {
return "";
}
@Nullable
@NonNull String breakLineBetweenTypeAndAnnotations() {
return null;
}
@Nullable <T> String breakLineBetweenTypeParameterAndAnnotation() {
return null;
}
@Nullable
@NonNull <T> String breakLineMixed() {
return null;
}
}

29
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/LowLanguageLevel_after.java Normal file
View File

@@ -0,0 +1,29 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
public class Formatter {
@NonNull
@Nullable
String breakLineBetweenAnnotations() {
return "";
}
@Nullable
@NonNull
String breakLineBetweenTypeAndAnnotations() {
return null;
}
@Nullable
<T> String breakLineBetweenTypeParameterAndAnnotation() {
return null;
}
@Nullable
@NonNull
<T> String breakLineMixed() {
return null;
}
}

17
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ManyKnownAnnotations.java Normal file
View File

@@ -0,0 +1,17 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@Nullable @NonNull String getCustomString() {
return null;
}
@Nullable @NonNull <T, V> List<T> getCustomList() {
return null;
}
}

17
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/ManyKnownAnnotations_after.java Normal file
View File

@@ -0,0 +1,17 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@Nullable @NonNull String getCustomString() {
return null;
}
@Nullable @NonNull <T, V> List<T> getCustomList() {
return null;
}
}

20
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/PreserveWrappingManyAnnotations.java Normal file
View File

@@ -0,0 +1,20 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull
@Nullable
<T, V> List<T> getStrangeList() {
return List.of();
}
@NonNull
@Nullable
String getNotNullName() {
return "";
}
}

16
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/PreserveWrappingManyAnnotations_after.java Normal file
View File

@@ -0,0 +1,16 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull @Nullable <T, V> List<T> getStrangeList() {
return List.of();
}
@NonNull @Nullable String getNotNullName() {
return "";
}
}

28
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/PreserveWrappingSingleAnnotation.java Normal file
View File

@@ -0,0 +1,28 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull
<T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable
<T, V> List<T> getNullableList() {
return null;
}
@NonNull
String getNotNullName() {
return "";
}
@Nullable
String getNullableName() {
return null;
}
}

24
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/PreserveWrappingSingleAnnotation_after.java Normal file
View File

@@ -0,0 +1,24 @@
package org.example;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import java.util.List;
public class Formatter {
@NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@Nullable <T, V> List<T> getNullableList() {
return null;
}
@NonNull String getNotNullName() {
return "";
}
@Nullable String getNullableName() {
return null;
}
}

24
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/SpacesInFqnAnnotations.java Normal file
View File

@@ -0,0 +1,24 @@
package org.example;
public class Formatter {
@ org . jspecify .annotations . NonNull
<T, V> List<T> getNotNullList() {
return List.of();
}
@org. jspecify. annotations .
Nullable
<T, V> List<T> getNullableList() {
return null;
}
@ org. jspecify . annotations. NonNull
String getNotNullName() {
return "";
}
@ org . jspecify . annotations . Nullable
String getNullableName() {
return null;
}
}

19
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/SpacesInFqnAnnotations_after.java Normal file
View File

@@ -0,0 +1,19 @@
package org.example;
public class Formatter {
@org.jspecify.annotations.NonNull <T, V> List<T> getNotNullList() {
return List.of();
}
@org.jspecify.annotations.Nullable <T, V> List<T> getNullableList() {
return null;
}
@org.jspecify.annotations.NonNull String getNotNullName() {
return "";
}
@org.jspecify.annotations.Nullable String getNullableName() {
return null;
}
}

20
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/SpacesInImportList.java Normal file
View File

@@ -0,0 +1,20 @@
package org.example
import
org . jspecify . annotations. NonNull;
import org. jspecify . annotations.
Nullable;
import org . jspecify .
annotations .*;
public class Formatter {
@NonNull
String getNotNullName() {
return "";
}
@Nullable
String getNullableName() {
return null;
}
}

15
java/java-tests/testData/psi/formatter/java/jSpecifyTypeAnnotation/SpacesInImportList_after.java Normal file
View File

@@ -0,0 +1,15 @@
package org.example
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import org.jspecify.annotations.*;
public class Formatter {
@NonNull String getNotNullName() {
return "";
}
@Nullable String getNullableName() {
return null;
}
}

71
java/java-tests/testSrc/com/intellij/java/psi/formatter/java/JSpecifyTypeAnnotationFormatterTest.kt Normal file
View File

@@ -0,0 +1,71 @@
// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.java.psi.formatter.java
import com.intellij.JavaTestUtil
import com.intellij.application.options.CodeStyle
import com.intellij.lang.java.JavaLanguage
import com.intellij.openapi.command.WriteCommandAction
import com.intellij.openapi.roots.ModuleRootModificationUtil
import com.intellij.pom.java.LanguageLevel
import com.intellij.psi.codeStyle.CodeStyleManager
import com.intellij.psi.codeStyle.CommonCodeStyleSettings
import com.intellij.psi.codeStyle.CommonCodeStyleSettings.WRAP_ALWAYS
import com.intellij.testFramework.IdeaTestUtil
import com.intellij.testFramework.fixtures.LightJavaCodeInsightFixtureTestCase
import com.intellij.testFramework.fixtures.MavenDependencyUtil
class JSpecifyTypeAnnotationFormatterTest : LightJavaCodeInsightFixtureTestCase() {
private val commonSettings: CommonCodeStyleSettings
get() = CodeStyle.getSettings(project).getCommonSettings(JavaLanguage.INSTANCE)
override fun getTestDataPath() = "${JavaTestUtil.getJavaTestDataPath()}/psi/formatter/java/jSpecifyTypeAnnotation/"
override fun setUp() {
super.setUp()
commonSettings.KEEP_LINE_BREAKS = false
commonSettings.METHOD_ANNOTATION_WRAP = WRAP_ALWAYS
IdeaTestUtil.setProjectLanguageLevel(myFixture.project, LanguageLevel.JDK_1_8)
ModuleRootModificationUtil.updateModel(module) { model ->
MavenDependencyUtil.addFromMaven(model, "org.jspecify:jspecify:1.0.0")
}
}
fun testKnownAnnotationBeforeType() = doTest()
fun testKnownAnnotationBeforeTypeParameterList() = doTest()
fun testCustomAnnotation() = doTest()
fun testManyKnownAnnotations() = doTest()
fun testPreserveWrappingSingleAnnotation() = doTest()
fun testPreserveWrappingManyAnnotations() = doTest()
fun testFullyQualifiedName() = doTest()
fun testImportOnDemand() = doTest()
fun testImportMix() = doTest()
fun testSpacesInImportList() = doTest()
fun testSpacesInFqnAnnotations() = doTest()
fun testKeepLineBreaks() {
commonSettings.KEEP_LINE_BREAKS = true
doTest()
}
fun testLowLanguageLevel() {
IdeaTestUtil.setProjectLanguageLevel(myFixture.project, LanguageLevel.JDK_1_7)
doTest()
}
private fun doTest() {
val testName = getTestName(false)
myFixture.configureByFile("$testName.java")
WriteCommandAction.runWriteCommandAction(project) { CodeStyleManager.getInstance(project).reformatText(file, 0, editor.document.textLength) }
myFixture.checkResultByFile("${testName}_after.java")
}
}