RuleCtx
Related Docs:
object RuleCtx
| package rule
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.
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.
Add the string toAdd to the first token of tree.
Add the string toAdd to the first token of tree. Does not remove tokens.
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.
Add the string toAdd to the last token of tree.
Add the string toAdd to the last token of tree. Does not remove tokens.
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.
Find comments/docstrings associated with tree nodes.
Find comments/docstrings associated with tree nodes. *
Print out the contents of SemanticdbIndex for this input only.
Print out the contents of SemanticdbIndex for this input only. *
Get SemanticdbIndex for this single tree alone.
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.
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.
Find matching open/close pairs of parens/braces/brackets.
Find matching open/close pairs of parens/braces/brackets. *
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.
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.
Replace single token with empty string.
Replace single token with empty string.
Replace all tokens with empty string.
Replace all tokens with empty string.
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.
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.
Shorthand for calling replaceSymbol from strings.
Shorthand for calling replaceSymbol from strings.
String values are treated as Symbol.Global.
Replace the entire contents of this Token with toReplace.
Replace the entire contents of this Token with toReplace.
Replace all tokens of tree contents with toReplace.
Replace all tokens of tree contents with toReplace.
Traverse tokens as a doubly linked list.
Traverse tokens as a doubly linked list. *
The tokenized tokens of this this tree.
The tokenized tokens of this this 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.
(Since version 0.5.0) Renamed to matchingParens
(Since version 0.5.0) Use replaceTree instead