testkit
API
Generated with
testkit/scala.meta.testkit

scala.meta.testkit

package scala.meta.testkit

Members list

Type members

Classlikes

case class AnyDiff(a: Any, b: Any) extends Exception

Helper class to create textual diff between two objects

Helper class to create textual diff between two objects

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class Corpus(url: String, filter: String => Boolean)

A collection of Scala source files to run SyntaxAnalysis.

A collection of Scala source files to run SyntaxAnalysis.

Value parameters

filter

Files that don't match the filter are excluded from the analysis. Here's the structure for url files:

          repos/
            project1/
              COMMIT // <- git commit hash of project1 snapshot
              URL    // <- Github project url
              src/main/...
              Code.scala
            project2/
            ...
            projectN/

In particular, each project directory must contain a COMMIT and URL file. These files are used to construct links to the source files on Github.

url

A zip file that matches the structure described below.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Corpus

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Corpus.type
case class CorpusFile(filename: String, projectUrl: String, commit: String)

A Scala source file taken from some Github repo

A Scala source file taken from some Github repo

Value parameters

commit

The commit has at where this ScalaFile originates from.

filename

Path to the file relative to the "target/repos" root directory.

projectUrl

The url of the Github project containing this source file.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileOps

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
FileOps.type
case class Observation[T](msg: String, line: Int, kind: T)

An observation during a SyntaxAnalysis.

An observation during a SyntaxAnalysis.

Value parameters

kind

The category of this observation. Observations of the same category are grouped together in the markdown table. Good values are enumerations or sealed ADTs.

line

The offending line number in the source file where the observation was made. Starts from line 0, which matches with scala.meta.Position.line.

msg

The message corresponding this individual observation. The message will be dislayed next to this entry.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Observation

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Phase

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Phase.type
object StringFS

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
StringFS.type
object StructurallyEqual

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object SyntaxAnalysis

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Generated with