"Code Cleanup" action to migrate all instances of deprecated syntax to new one

This commit is contained in:
Dmitry Jemerov
2015-05-20 13:09:23 +02:00
parent 4570872bfd
commit 6e7ea662c8
7 changed files with 194 additions and 13 deletions
@@ -18,6 +18,7 @@ package org.jetbrains.kotlin.idea.highlighter
import com.intellij.codeInsight.daemon.impl.HighlightRangeExtension
import com.intellij.codeInsight.intention.EmptyIntentionAction
import com.intellij.codeInsight.intention.IntentionAction
import com.intellij.codeInspection.ProblemHighlightType
import com.intellij.lang.annotation.Annotation
import com.intellij.lang.annotation.AnnotationHolder
@@ -179,18 +180,8 @@ public open class JetPsiChecker : Annotator, HighlightRangeExtension {
}
private fun registerQuickFix(annotation: Annotation, diagnostic: Diagnostic) {
val intentionActionsFactories = QuickFixes.getActionsFactories(diagnostic.getFactory())
for (intentionActionsFactory in intentionActionsFactories) {
if (intentionActionsFactory != null) {
for (action in intentionActionsFactory.createActions(diagnostic)) {
annotation.registerFix(action)
}
}
}
val actions = QuickFixes.getActions(diagnostic.getFactory())
for (action in actions) {
annotation.registerFix(action)
createQuickfixes(diagnostic).forEach {
annotation.registerFix(it)
}
// Making warnings suppressable
@@ -261,5 +252,14 @@ public open class JetPsiChecker : Annotator, HighlightRangeExtension {
//DeprecatedAnnotationVisitor(holder, bindingContext)
)
public fun createQuickfixes(diagnostic: Diagnostic): Collection<IntentionAction> {
val result = arrayListOf<IntentionAction>()
val intentionActionsFactories = QuickFixes.getActionsFactories(diagnostic.getFactory())
for (intentionActionsFactory in intentionActionsFactories.filterNotNull()) {
result.addAll(intentionActionsFactory.createActions(diagnostic))
}
result.addAll(QuickFixes.getActions(diagnostic.getFactory()))
return result
}
}
}
+8
View File
@@ -1007,6 +1007,14 @@
level="WARNING"
/>
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.KotlinCleanupInspection"
shortName="KotlinDeprecation"
displayName="Deprecated language feature"
groupName="Kotlin"
enabledByDefault="true"
cleanupTool="true"
level="WARNING"/>
<project.converterProvider implementation="org.jetbrains.kotlin.idea.converters.JetRunConfigurationSettingsFormatConverterProvider"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
@@ -0,0 +1,84 @@
/*
* Copyright 2010-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.kotlin.idea.inspections
import com.intellij.codeInspection.*
import com.intellij.openapi.progress.ProcessCanceledException
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiFile
import org.jetbrains.kotlin.diagnostics.Diagnostic
import org.jetbrains.kotlin.diagnostics.DiagnosticFactory
import org.jetbrains.kotlin.diagnostics.Errors
import org.jetbrains.kotlin.diagnostics.rendering.DefaultErrorMessages
import org.jetbrains.kotlin.idea.caches.resolve.analyzeFullyAndGetResult
import org.jetbrains.kotlin.idea.highlighter.JetPsiChecker
import org.jetbrains.kotlin.idea.quickfix.JetWholeProjectModalAction
import org.jetbrains.kotlin.idea.util.ProjectRootsUtil
import org.jetbrains.kotlin.psi.JetFile
import org.jetbrains.kotlin.psi.JetTreeVisitorVoid
import org.jetbrains.kotlin.resolve.jvm.diagnostics.ErrorsJvm
public class KotlinCleanupInspection(): LocalInspectionTool(), CleanupLocalInspectionTool {
// required to simplify the inspection registration in tests
override fun getDisplayName(): String = "Deprecated language feature"
override fun checkFile(file: PsiFile, manager: InspectionManager, isOnTheFly: Boolean): Array<out ProblemDescriptor>? {
if (isOnTheFly || file !is JetFile || !ProjectRootsUtil.isInProjectSource(file)) {
return null
}
val analysisResult = file.analyzeFullyAndGetResult()
if (analysisResult.isError()) {
throw ProcessCanceledException(analysisResult.error)
}
val diagnostics = analysisResult.bindingContext.getDiagnostics()
val problemDescriptors = arrayListOf<ProblemDescriptor>()
file.acceptChildren(object: JetTreeVisitorVoid() {
override fun visitElement(element: PsiElement) {
super.visitElement(element)
val collection = diagnostics.forElement(element)
collection.forEach {
if (it.getFactory().isCleanup()) {
problemDescriptors.add(it.toProblemDescriptor(file, manager))
}
}
}
})
return problemDescriptors.toTypedArray()
}
private fun DiagnosticFactory<*>.isCleanup() =
this == Errors.DEPRECATED_TRAIT_KEYWORD ||
this == Errors.DEPRECATED_ANNOTATION_SYNTAX ||
this == Errors.ENUM_ENTRY_USES_DEPRECATED_OR_NO_DELIMITER ||
this == Errors.ENUM_ENTRY_USES_DEPRECATED_SUPER_CONSTRUCTOR ||
this == Errors.DEPRECATED_LAMBDA_SYNTAX ||
this == Errors.JAVA_LANG_CLASS_PARAMETER_IN_ANNOTATION ||
this == ErrorsJvm.JAVA_LANG_CLASS_ARGUMENT_IN_ANNOTATION
private fun Diagnostic.toProblemDescriptor(file: JetFile, manager: InspectionManager): ProblemDescriptor? {
val quickFixes = JetPsiChecker.createQuickfixes(this)
.filter { it !is JetWholeProjectModalAction<*> }
.map { IntentionWrapper(it, file) }
return manager.createProblemDescriptor(getPsiElement(),
DefaultErrorMessages.render(this),
false,
quickFixes.toTypedArray(),
ProblemHighlightType.GENERIC_ERROR_OR_WARNING)
}
}
@@ -39,7 +39,7 @@ public class DeprecatedLambdaSyntaxFix(element: JetFunctionLiteralExpression) :
override fun getText() = JetBundle.message("migrate.lambda.syntax")
override fun getFamilyName() = JetBundle.message("migrate.lambda.syntax.family")
override fun invoke(project: Project, editor: Editor, file: JetFile) {
override fun invoke(project: Project, editor: Editor?, file: JetFile) {
DeprecatedSyntaxFix.createFix(element).runFix()
}
@@ -0,0 +1,20 @@
trait Foo {
}
[deprecated("boo")] fun bar() {}
enum class E {
First Second
}
enum class F(val name: String) {
First: F("First")
Second: F("Second")
}
val f = { (a: Int, b: Int) -> a + b }
annotation class Ann(val arg1: Class<*>, val arg2: Class<out Any?>)
Ann(javaClass<String>(), javaClass<Int>()) class MyClass
@@ -0,0 +1,22 @@
import kotlin.reflect.KClass
interface Foo {
}
@deprecated("boo") fun bar() {}
enum class E {
First, Second
}
enum class F(val name: String) {
First("First"),
Second("Second")
}
val f = { a: Int, b: Int -> a + b }
annotation class Ann(val arg1: KClass<*>, val arg2: KClass<out Any?>)
Ann(String::class, Int::class) class MyClass
@@ -0,0 +1,47 @@
/*
* Copyright 2010-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.kotlin.idea.inspections
import com.intellij.analysis.AnalysisScope
import com.intellij.codeInspection.InspectionManager
import com.intellij.codeInspection.ex.GlobalInspectionContextBase
import com.intellij.profile.codeInspection.InspectionProjectProfileManager
import com.intellij.testFramework.LightProjectDescriptor
import org.jetbrains.kotlin.idea.test.JetLightCodeInsightFixtureTestCase
import org.jetbrains.kotlin.idea.test.JetWithJdkAndRuntimeLightProjectDescriptor
import org.jetbrains.kotlin.idea.test.PluginTestCaseBase
class KotlinCleanupInspectionTest(): JetLightCodeInsightFixtureTestCase() {
override fun getTestDataPath(): String
= PluginTestCaseBase.getTestDataPathBase() + "/inspections/cleanup"
override fun getProjectDescriptor(): LightProjectDescriptor = JetWithJdkAndRuntimeLightProjectDescriptor.INSTANCE
public fun testCleanup() {
myFixture.enableInspections(javaClass<KotlinCleanupInspection>())
myFixture.configureByFile("cleanup.kt")
val project = myFixture.getProject()
val managerEx = InspectionManager.getInstance(project)
val globalContext = managerEx.createNewGlobalContext(false) as GlobalInspectionContextBase
val analysisScope = AnalysisScope(myFixture.getFile())
val profile = InspectionProjectProfileManager.getInstance(project).getInspectionProfile()
globalContext.codeCleanup(project, analysisScope, profile, "Cleanup", null, true)
myFixture.checkResultByFile("cleanup.kt.after")
}
}