case class RuleCtxImpl(tree: Tree, config: config.ScalafixConfig) extends rule.RuleCtx with Product with Serializable
- Self Type
- RuleCtxImpl
- Alphabetic
- By Inheritance
- RuleCtxImpl
- Serializable
- Serializable
- Product
- Equals
- RuleCtx
- PatchOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RuleCtxImpl(tree: Tree, config: config.ScalafixConfig)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addGlobalImport(symbol: scala.meta.Symbol)(implicit index: util.SemanticdbIndex): 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
- RuleCtxImpl → PatchOps
-
def
addGlobalImport(importer: Importer): 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
- RuleCtxImpl → PatchOps
-
def
addLeft(tree: Tree, toAdd: String): 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
- RuleCtxImpl → PatchOps
-
def
addLeft(tok: scala.meta.Token, toAdd: String): 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
- RuleCtxImpl → PatchOps
-
def
addRight(tree: Tree, toAdd: String): 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
- RuleCtxImpl → PatchOps
-
def
addRight(tok: scala.meta.Token, toAdd: String): 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
- RuleCtxImpl → PatchOps
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
lazy val
comments: AssociatedComments
Find comments/docstrings associated with tree nodes.
Find comments/docstrings associated with tree nodes. *
- Definition Classes
- RuleCtxImpl → RuleCtx
-
val
config: config.ScalafixConfig
- Definition Classes
- RuleCtxImpl → RuleCtx
- def debug(values: Text[Any]*)(implicit fileLine: FileLine): Unit
-
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
- RuleCtxImpl → RuleCtx
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
index(implicit index: util.SemanticdbIndex): util.SemanticdbIndex
Get SemanticdbIndex for this single tree alone.
Get SemanticdbIndex for this single tree alone.
- Definition Classes
- RuleCtxImpl → RuleCtx
-
lazy val
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
- RuleCtxImpl → RuleCtx
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
lint(msg: LintMessage): 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
- RuleCtxImpl → PatchOps
-
lazy val
matchingParens: MatchingParens
Find matching open/close pairs of parens/braces/brackets.
Find matching open/close pairs of parens/braces/brackets. *
- Definition Classes
- RuleCtxImpl → RuleCtx
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
printLintMessage(msg: LintMessage, owner: RuleName): Unit
- Definition Classes
- RuleCtxImpl → RuleCtx
-
def
removeGlobalImport(symbol: scala.meta.Symbol)(implicit index: util.SemanticdbIndex): 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
- RuleCtxImpl → PatchOps
-
def
removeImportee(importee: Importee): 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}
producesimport a.c
.Note,
importee
instance is by reference, so removing quasiquotes (example,removeImportee(importee"b")
) does nothing.- Definition Classes
- RuleCtxImpl → PatchOps
-
def
removeToken(token: scala.meta.Token): Patch
Replace single token with empty string.
Replace single token with empty string.
- Definition Classes
- RuleCtxImpl → PatchOps
-
def
removeTokens(tokens: Tokens): Patch
Replace all tokens with empty string.
Replace all tokens with empty string.
- Definition Classes
- RuleCtxImpl → PatchOps
-
def
renameSymbol(fromSymbol: Global, toName: String)(implicit index: util.SemanticdbIndex): 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
- RuleCtxImpl → PatchOps
-
def
replaceSymbol(fromSymbol: Global, toSymbol: Global)(implicit index: util.SemanticdbIndex): 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
- RuleCtxImpl → PatchOps
-
def
replaceSymbols(toReplace: (String, String)*)(implicit index: util.SemanticdbIndex): Patch
Shorthand for calling replaceSymbol from strings.
Shorthand for calling replaceSymbol from strings.
String values are treated as Symbol.Global.
- Definition Classes
- RuleCtxImpl → PatchOps
-
def
replaceToken(token: scala.meta.Token, toReplace: String): Patch
Replace the entire contents of this Token with toReplace.
Replace the entire contents of this Token with toReplace.
- Definition Classes
- RuleCtxImpl → PatchOps
-
def
replaceTree(from: Tree, to: String): Patch
Replace all tokens of tree contents with toReplace.
Replace all tokens of tree contents with toReplace.
- Definition Classes
- RuleCtxImpl → PatchOps
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def syntax: String
-
def
toString(): String
- Definition Classes
- RuleCtxImpl → AnyRef → Any
-
lazy val
tokenList: TokenList
Traverse tokens as a doubly linked list.
Traverse tokens as a doubly linked list. *
- Definition Classes
- RuleCtxImpl → RuleCtx
-
lazy val
tokens: Tokens
The tokenized tokens of this this tree.
The tokenized tokens of this this tree. *
- Definition Classes
- RuleCtxImpl → RuleCtx
-
def
toks(t: Tree): Tokens
- Definition Classes
- RuleCtxImpl → RuleCtx
-
val
tree: Tree
- Definition Classes
- RuleCtxImpl → RuleCtx
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
matching: MatchingParens
- Definition Classes
- RuleCtx
- Annotations
- @deprecated
- Deprecated
(Since version 0.5.0) Renamed to matchingParens
-
def
rename(name: Name, toReplace: String): patch.Patch
- Definition Classes
- PatchOps
- Annotations
- @deprecated
- Deprecated
(Since version 0.5.0) Use replaceTree instead