Packages

c

scalafix.internal.patch

DeprecatedRuleCtx

class DeprecatedRuleCtx extends v0.RuleCtx with DeprecatedPatchOps

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeprecatedRuleCtx
  2. DeprecatedPatchOps
  3. RuleCtx
  4. PatchOps
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeprecatedRuleCtx(doc: Doc)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def comments: AssociatedComments

    Find comments/docstrings associated with tree nodes.

    Find comments/docstrings associated with tree nodes. *

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  7. def debugIndex()(implicit index: util.SemanticdbIndex, fileLine: FileLine): Unit

    Print out the contents of SemanticdbIndex for this input only.

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

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def index(implicit index: util.SemanticdbIndex): util.SemanticdbIndex

    Get SemanticdbIndex for this single tree alone.

    Get SemanticdbIndex for this single tree alone.

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  14. def input: scala.meta.Input

    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.

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def matchingParens: MatchingParens

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

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

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. def tokenList: TokenList

    Traverse tokens as a doubly linked list.

    Traverse tokens as a doubly linked list. *

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  23. def tokens: Tokens

    The tokenized tokens of this this tree.

    The tokenized tokens of this this tree. *

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  24. def tree: Tree

    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.

    Definition Classes
    DeprecatedRuleCtxRuleCtx
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. final def addGlobalImport(symbol: Symbol)(implicit index: v0.SemanticdbIndex): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  2. final def addGlobalImport(importer: Importer): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  3. final def addLeft(tree: Tree, toAdd: String): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  4. final def addLeft(tok: scala.meta.Token, toAdd: String): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  5. final def addRight(tree: Tree, toAdd: String): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  6. final def addRight(tok: scala.meta.Token, toAdd: String): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  7. final def lint(msg: v0.LintMessage): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  8. final def removeGlobalImport(symbol: Symbol)(implicit index: v0.SemanticdbIndex): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  9. final def removeImportee(importee: Importee): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  10. final def removeToken(token: scala.meta.Token): v0.Patch

    Replace single token with empty string.

    Replace single token with empty string.

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  11. final def removeTokens(tokens: Iterable[scala.meta.Token]): v0.Patch
    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  12. final def removeTokens(tokens: Tokens): v0.Patch

    Replace all tokens with empty string.

    Replace all tokens with empty string.

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  13. final def renameSymbol(fromSymbol: Global, toName: String)(implicit index: v0.SemanticdbIndex): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  14. final def replaceSymbol(fromSymbol: Global, toSymbol: Global)(implicit index: v0.SemanticdbIndex): v0.Patch

    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
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  15. final def replaceSymbols(toReplace: Seq[(String, String)])(implicit noop: DummyImplicit, index: v0.SemanticdbIndex): v0.Patch

    Helper for calling replaceSymbols without needing _*

    Helper for calling replaceSymbols without needing _*

    Defers work to replaceSymbols((String, String)*). Needs a dummy implicit to differentiate from replaceSymbols((String, String)*) after type erasure

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  16. final def replaceSymbols(toReplace: (String, String)*)(implicit index: v0.SemanticdbIndex): v0.Patch

    Shorthand for calling replaceSymbol from strings.

    Shorthand for calling replaceSymbol from strings.

    String values are treated as Symbol.Global.

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  17. final def replaceToken(token: scala.meta.Token, toReplace: String): v0.Patch

    Replace the entire contents of this Token with toReplace.

    Replace the entire contents of this Token with toReplace.

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

  18. final def replaceTree(from: Tree, to: String): v0.Patch

    Replace all tokens of tree contents with toReplace.

    Replace all tokens of tree contents with toReplace.

    Definition Classes
    DeprecatedPatchOpsPatchOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0)

Inherited from DeprecatedPatchOps

Inherited from v0.RuleCtx

Inherited from PatchOps

Inherited from AnyRef

Inherited from Any

Ungrouped