Trait/Object

scalafix.rule

RuleCtx

Related Docs: object RuleCtx | package rule

Permalink

trait RuleCtx extends PatchOps

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RuleCtx
  2. PatchOps
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addGlobalImport(symbol: scala.meta.Symbol)(implicit index: SemanticdbIndex): patch.Patch

    Permalink

    Add an import on symbol among the global imports.

    Add an import on symbol among the global imports.

    This patch is not reference, unlike removeImportee(Importee). It is only necessary to use this patch once per tree, duplicate symbols are ignored.

    Definition Classes
    PatchOps
  2. abstract def addGlobalImport(importer: Importer): patch.Patch

    Permalink

    Add this importer to the global imports at the top of this file.

    Add this importer to the global imports at the top of this file.

    It is OK to pass in a quasiquote here. The importer has no attached semantic information, so it's not possible to deduplicate Importers.

    Definition Classes
    PatchOps
  3. abstract def addLeft(tree: Tree, toAdd: String): patch.Patch

    Permalink

    Add the string toAdd to the first token of tree.

    Add the string toAdd to the first token of tree. Does not remove tokens.

    Definition Classes
    PatchOps
  4. abstract def addLeft(token: scala.meta.Token, toAdd: String): patch.Patch

    Permalink

    Add the string toAdd to the left side of token, while keeping token.

    Add the string toAdd to the left side of token, while keeping token.

    Definition Classes
    PatchOps
  5. abstract def addRight(tree: Tree, toAdd: String): patch.Patch

    Permalink

    Add the string toAdd to the last token of tree.

    Add the string toAdd to the last token of tree. Does not remove tokens.

    Definition Classes
    PatchOps
  6. abstract def addRight(token: scala.meta.Token, toAdd: String): patch.Patch

    Permalink

    Add the string toAdd to the right side of token, while keeping token.

    Add the string toAdd to the right side of token, while keeping token.

    Definition Classes
    PatchOps
  7. abstract def comments: AssociatedComments

    Permalink

    Find comments/docstrings associated with tree nodes.

    Find comments/docstrings associated with tree nodes. *

  8. abstract def debugIndex()(implicit index: util.SemanticdbIndex, fileLine: FileLine): Unit

    Permalink

    Print out the contents of SemanticdbIndex for this input only.

    Print out the contents of SemanticdbIndex for this input only. *

  9. abstract def index(implicit index: util.SemanticdbIndex): util.SemanticdbIndex

    Permalink

    Get SemanticdbIndex for this single tree alone.

  10. abstract def input: scala.meta.Input

    Permalink

    The input where the tree was parsed from.

    The input where the tree was parsed from.

    This is typically either Input.VirtualFile for semantic rules and Input.File for syntactic rules. For Input.VirtualFile, it is possible to trace back to the original file path via SemanticdbIndex.sourcepath.

  11. abstract def lint(msg: LintMessage): patch.Patch

    Permalink

    Report a linter message.

    Report a linter message.

    To construct a LintMessage, start by creating a lint category. Example:

    class MyLinter extends Rule {
      val divisionByZero = scalafix.LintCategory.error("Division by zero!")
      val divisionTree: scala.meta.Tree = ???
      PatchOps.lint(divisionByZero.at(divisionTree.pos))
    }

    Each LintCategory is assigned a unique identifier, which is formatted as "RuleName.categoryID". The divisionByZero example would have the id "MyLinter.divisionByZero". A LintCategory has a default severity level (warning, error) that the user can override in .scalafix.conf.

    Definition Classes
    PatchOps
  12. abstract def matchingParens: MatchingParens

    Permalink

    Find matching open/close pairs of parens/braces/brackets.

    Find matching open/close pairs of parens/braces/brackets. *

  13. abstract def removeGlobalImport(symbol: scala.meta.Symbol)(implicit index: SemanticdbIndex): patch.Patch

    Permalink

    Remove importees that resolve to symbol.

    Remove importees that resolve to symbol.

    Note, this patch is not reference, unlike removeImportee(Importee). It is only necessary to use this patch once per tree, duplicate symbols are ignored.

    Definition Classes
    PatchOps
  14. abstract def removeImportee(importee: Importee): patch.Patch

    Permalink

    Remove this particular instance of Importee.

    Remove this particular instance of Importee.

    Handles tricky cases like trailing commas or curly braces. Example, removeImportee(b) in import a.{b, c} produces import a.c.

    Note, importee instance is by reference, so removing quasiquotes (example, removeImportee(importee"b")) does nothing.

    Definition Classes
    PatchOps
  15. abstract def removeToken(token: scala.meta.Token): patch.Patch

    Permalink

    Replace single token with empty string.

    Replace single token with empty string.

    Definition Classes
    PatchOps
  16. abstract def removeTokens(tokens: scala.meta.Tokens): patch.Patch

    Permalink

    Replace all tokens with empty string.

    Replace all tokens with empty string.

    Definition Classes
    PatchOps
  17. abstract def renameSymbol(fromSymbol: Global, toName: String)(implicit index: SemanticdbIndex): patch.Patch

    Permalink

    Replace appearances of names that reference fromSymbol with toName.

    Replace appearances of names that reference fromSymbol with toName.

    toName should be a legal identifier, it cannot be a tree such as foo(). Use this patch for example to rename a methods on a class.

    Definition Classes
    PatchOps
  18. abstract def replaceSymbol(fromSymbol: Global, toSymbol: Global)(implicit index: SemanticdbIndex): patch.Patch

    Permalink

    Replace references/call-sites to fromSymbol with references to toSymbol.

    Replace references/call-sites to fromSymbol with references to toSymbol.

    toSymbol must be a static method or a globally accessible object. toSymbol should not be path dependent. To rename a class method, use renameSymbol.

    Experimental. May produce broken code in some cases. This is the same patch as replace:com.foo/com.bar from sbt-scalafix.

    Definition Classes
    PatchOps
  19. abstract def replaceSymbols(toReplace: (String, String)*)(implicit index: SemanticdbIndex): patch.Patch

    Permalink

    Shorthand for calling replaceSymbol from strings.

    Shorthand for calling replaceSymbol from strings.

    String values are treated as Symbol.Global.

    Definition Classes
    PatchOps
  20. abstract def replaceToken(token: scala.meta.Token, toReplace: String): patch.Patch

    Permalink

    Replace the entire contents of this Token with toReplace.

    Replace the entire contents of this Token with toReplace.

    Definition Classes
    PatchOps
  21. abstract def replaceTree(tree: Tree, toReplace: String): patch.Patch

    Permalink

    Replace all tokens of tree contents with toReplace.

    Replace all tokens of tree contents with toReplace.

    Definition Classes
    PatchOps
  22. abstract def tokenList: TokenList

    Permalink

    Traverse tokens as a doubly linked list.

    Traverse tokens as a doubly linked list. *

  23. abstract def tokens: Tokens

    Permalink

    The tokenized tokens of this this tree.

    The tokenized tokens of this this tree. *

  24. abstract def tree: Tree

    Permalink

    The parsed syntax tree that should be fixed.

    The parsed syntax tree that should be fixed.

    The scalafix API does not support fixing un-parseable code at this point.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def matching: MatchingParens

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.0) Renamed to matchingParens

  2. def rename(name: Name, toReplace: String): patch.Patch

    Permalink
    Definition Classes
    PatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.0) Use replaceTree instead

Inherited from PatchOps

Inherited from AnyRef

Inherited from Any

Ungrouped