abstract class AbstractSyntacticRuleSuite extends Suite with TestRegistration with DiffAssertions
Utility to unit test syntactic rules.
Mix-in FunSuiteLike (ScalaTest 3.0), AnyFunSuiteLike (ScalaTest 3.1+) or the testing style of your choice if you add your own tests.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- AbstractSyntacticRuleSuite
- DiffAssertions
- TestRegistration
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
Implicitly
- by convertToEqualizer
- by convertToEqualizer
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new AbstractSyntacticRuleSuite()
Type Members
- class AssertionsHelper extends AnyRef
- Definition Classes
- Assertions
- class CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- case class DiffFailure(title: String, expected: String, obtained: String, diff: String) extends TestFailedException with Product with Serializable
- Definition Classes
- DiffAssertions
Abstract Value Members
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def !==(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def !==[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toany2stringadd[AbstractSyntacticRuleSuite] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AbstractSyntacticRuleSuite, B)
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toArrowAssoc[AbstractSyntacticRuleSuite] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def ===(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def ===[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertCompiles(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- def assertEqual[A](a: A, b: A): Unit
- Definition Classes
- DiffAssertions
- def assertNoDiff(obtained: String, expected: String, title: String = "", printObtained: Boolean = false): Boolean
- Definition Classes
- DiffAssertions
- def assertNoDiffOrPrintExpected(obtained: String, expected: String): Boolean
- Definition Classes
- DiffAssertions
- def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertTypeError(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- val assertionsHelper: AssertionsHelper
- Definition Classes
- Assertions
- macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def cancel(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def check(rule: SyntacticRule, name: String, original: String, expected: String, testTags: Tag*): Unit
- def checkDiff(rule: SyntacticRule, original: scala.meta.Input, expected: String, testTags: Tag*): Unit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compareContents(original: Seq[String], revised: Seq[String]): String
- Definition Classes
- DiffAssertions
- def compareContents(original: String, revised: String): String
- Definition Classes
- DiffAssertions
- def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def convertToEqualizer[T](left: T): Equalizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
- def ensuring(cond: (AbstractSyntacticRuleSuite) => Boolean, msg: => Any): AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toEnsuring[AbstractSyntacticRuleSuite] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AbstractSyntacticRuleSuite) => Boolean): AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toEnsuring[AbstractSyntacticRuleSuite] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toEnsuring[AbstractSyntacticRuleSuite] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toEnsuring[AbstractSyntacticRuleSuite] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def error2message(obtained: String, expected: String): String
- Definition Classes
- DiffAssertions
- final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
- Definition Classes
- Suite
- def expectedTestCount(filter: Filter): Int
- Definition Classes
- Suite
- def fail(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fileModificationTimeOrEpoch(file: File): String
- Definition Classes
- DiffAssertions
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toStringFormat[AbstractSyntacticRuleSuite] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def header[T](t: T): String
- Definition Classes
- DiffAssertions
- def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
- Definition Classes
- Assertions
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def pending: Assertion with PendingStatement
- Definition Classes
- Assertions
- def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
- Definition Classes
- Assertions
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- Suite
- def runNestedSuites(args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
- def runTest(testName: String, args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
- def runTests(testName: Option[String], args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
- val styleName: String
- Definition Classes
- Suite
- final val succeed: Assertion
- Definition Classes
- Assertions
- def suiteId: String
- Definition Classes
- Suite
- def suiteName: String
- Definition Classes
- Suite
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tags: Map[String, Set[String]]
- Definition Classes
- Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
- Definition Classes
- Suite
- def testNames: Set[String]
- Definition Classes
- Suite
- def toString(): String
- Definition Classes
- AnyRef → Any
- def trailingSpace(str: String): String
- Definition Classes
- DiffAssertions
- def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withClue[T](clue: Any)(fun: => T): T
- Definition Classes
- Assertions
Shadowed Implicit Value Members
- def !==(literalNull: Null): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).!==(literalNull)
- Definition Classes
- Equalizer
- def !==(spread: Spread[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).!==(spread)
- Definition Classes
- Equalizer
- def !==(rightSide: Any)(implicit equality: Equality[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).!==(rightSide)(equality)
- Definition Classes
- Equalizer
- def !==(literalNull: Null): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).!==(literalNull)
- Definition Classes
- Equalizer
- def !==(spread: Spread[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).!==(spread)
- Definition Classes
- Equalizer
- def !==(rightSide: Any)(implicit equality: Equality[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).!==(rightSide)(equality)
- Definition Classes
- Equalizer
- def ===(literalNull: Null): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).===(literalNull)
- Definition Classes
- Equalizer
- def ===(spread: Spread[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).===(spread)
- Definition Classes
- Equalizer
- def ===(rightSide: Any)(implicit equality: Equality[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).===(rightSide)(equality)
- Definition Classes
- Equalizer
- def ===(literalNull: Null): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).===(literalNull)
- Definition Classes
- Equalizer
- def ===(spread: Spread[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).===(spread)
- Definition Classes
- Equalizer
- def ===(rightSide: Any)(implicit equality: Equality[AbstractSyntacticRuleSuite]): Boolean
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).===(rightSide)(equality)
- Definition Classes
- Equalizer
- val leftSide: AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalatest.Assertions.Equalizer[AbstractSyntacticRuleSuite]).leftSide
- Definition Classes
- Equalizer
- val leftSide: AbstractSyntacticRuleSuite
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toorg.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite] performed by method convertToEqualizer in org.scalactic.TripleEquals.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(abstractSyntacticRuleSuite: org.scalactic.TripleEquals.Equalizer[AbstractSyntacticRuleSuite]).leftSide
- Definition Classes
- Equalizer
Deprecated Value Members
- final def execute: Unit
- Definition Classes
- Suite
- Annotations
- @deprecated
- Deprecated
The parameterless execute method has been deprecated and will be removed in a future version of ScalaTest. Please invoke execute with empty parens instead: execute().
- def trap[T](f: => T): Throwable
- Definition Classes
- Assertions
- Annotations
- @deprecated
- Deprecated
The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest
- def →[B](y: B): (AbstractSyntacticRuleSuite, B)
- Implicit
- This member is added by an implicit conversion from AbstractSyntacticRuleSuite toArrowAssoc[AbstractSyntacticRuleSuite] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.