com.nawforce.pkgforce.diagnostics.Issue.scala Maven / Gradle / Ivy

Go to download
/*
 [The "BSD licence"]
 Copyright (c) 2017 Kevin Jones
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.nawforce.pkgforce.diagnostics

import com.nawforce.pkgforce.diagnostics.DiagnosticCategory.isErrorType
import com.nawforce.pkgforce.path.{PathLike, PathLocation}
import com.nawforce.runtime.platform.Path
import io.github.apexdevtools.api.{IssueLocation, Rule}
import upickle.default.{macroRW, ReadWriter => RW}

import scala.collection.compat.immutable.ArraySeq

/** Shim between DiagnosticCategory & Rule, upickle is unhappy if DiagnosticCategory extends Rule */
final case class DiagnosticRule(category: DiagnosticCategory) extends Rule {
  override def name(): String      = category.name
  override def priority(): Integer = category.priority
}

/** An issue recoded against a specific file location. */
final case class Issue(
  path: PathLike,
  diagnostic: Diagnostic,
  provider: String = Issue.APEX_LS_PROVIDER
) extends io.github.apexdevtools.api.Issue {

  override def filePath(): String = path.toString

  override def fileLocation(): IssueLocation = diagnostic.location

  override def message(): String = diagnostic.message

  override def rule(): Rule = DiagnosticRule(diagnostic.category)

  override def isError: java.lang.Boolean = isErrorType(diagnostic.category)
}

object Issue {
  val APEX_LS_PROVIDER            = "apex-ls"
  val emptyArray: ArraySeq[Issue] = ArraySeq.empty

  implicit val pathLikeRW: RW[PathLike] =
    upickle.default.readwriter[String].bimap[PathLike](_.toString, Path(_))
  implicit val rw: RW[Issue] = macroRW

  implicit val ordering: Ordering[Issue] = Ordering
    .by[Issue, Int](issue =>
      if (DiagnosticCategory.isErrorType(issue.diagnostic.category)) 0 else 1
    )
    .orElseBy(_.diagnostic.location.startLine)
    .orElseBy(_.diagnostic.location.startPosition)

  def apply(category: DiagnosticCategory, pathLocation: PathLocation, message: String): Issue = {
    new Issue(pathLocation.path, Diagnostic(category, pathLocation.location, message))
  }

}

sealed case class IssuesAnd[T](issues: ArraySeq[Issue], value: T)

object IssuesAnd {
  def apply[T](value: T) = new IssuesAnd[T](ArraySeq(), value)
}