slack.lint.inclusive.InclusiveNamingSourceCodeScanner.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slack-lint-checks Show documentation
Slack lint checks.
The newest version!
// Copyright (C) 2021 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package slack.lint.inclusive

import com.android.tools.lint.client.api.UElementHandler
import com.android.tools.lint.detector.api.Context
import com.android.tools.lint.detector.api.Detector
import com.android.tools.lint.detector.api.JavaContext
import com.android.tools.lint.detector.api.SourceCodeScanner
import com.android.tools.lint.detector.api.isKotlin
import org.jetbrains.kotlin.psi.KtProperty
import org.jetbrains.uast.UClass
import org.jetbrains.uast.UField
import org.jetbrains.uast.UFile
import org.jetbrains.uast.ULabeledExpression
import org.jetbrains.uast.ULocalVariable
import org.jetbrains.uast.UMethod
import org.jetbrains.uast.UParameter
import org.jetbrains.uast.UVariable

@Suppress("UnstableApiUsage")
class InclusiveNamingSourceCodeScanner : Detector(), SourceCodeScanner {

  private lateinit var blocklist: Set

  override fun beforeCheckRootProject(context: Context) {
    super.beforeCheckRootProject(context)
    blocklist = InclusiveNamingChecker.loadBlocklist(context)
  }

  override fun getApplicableUastTypes() =
    listOf(
      UFile::class.java,
      UClass::class.java,
      UMethod::class.java,
      UVariable::class.java,
      ULabeledExpression::class.java,
    )

  override fun createUastHandler(context: JavaContext): UElementHandler? {
    if (blocklist.isEmpty()) return null
    val checker = InclusiveNamingChecker.SourceCodeChecker(context, blocklist)
    context.uastFile?.let { uastFile ->
      checker.check(uastFile, context.file.name, "file", isFile = true)
    }
    return object : UElementHandler() {
      override fun visitFile(node: UFile) {
        checker.check(node, node.packageName, "package")
      }

      override fun visitClass(node: UClass) {
        checker.check(node, node.name, "class")
      }

      override fun visitMethod(node: UMethod) {
        if (node.isConstructor) return
        val type = if (isKotlin(node.language)) "function" else "method"
        checker.check(node, node.name, type)
      }

      // Covers parameters, properties, fields, and local vars
      override fun visitVariable(node: UVariable) {
        val type =
          when (node) {
            is UField -> {
              if (isKotlin(node.language)) {
                "property"
              } else {
                "field"
              }
            }
            is ULocalVariable -> "local variable"
            is UParameter -> {
              if (node.sourcePsi is KtProperty) {
                "property"
              } else {
                "parameter"
              }
            }
            else -> return
          }
        checker.check(node, node.name, type)
      }

      // Covers things like forEach label@ {}
      override fun visitLabeledExpression(node: ULabeledExpression) {
        checker.check(node, node.label, "label")
      }
    }
  }
}