Skip to content

Fix #18234: Warn of identifiers with $ in their name #18563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fernandofpd wants to merge 3 commits into from
+598 −1
Closed

Fix #18234: Warn of identifiers with $ in their name #18563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
662d54e
Fix #18234: Warn of identifiers with $ in their name
fernandofpd Sep 17, 2023
ad36307
Fix phase name & description. Add to same megaphase as CheckUnused
fernandofpd Oct 8, 2023
2727c77
Add more pos tests
fernandofpd Oct 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion compiler/src/dotty/tools/dotc/Compiler.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ class Compiler {
protected def frontendPhases: List[List[Phase]] =
List(new Parser) :: // Compiler frontend: scanner, parser
List(new TyperPhase) :: // Compiler frontend: namer, typer
List(new CheckUnused.PostTyper) :: // Check for unused elements
List(new CheckUnused.PostTyper, // Check for unused elements
new CheckDollarInIdentifier) :: // Warn if identifier contains a dollar sign $
List(new CheckShadowing) :: // Check shadowing elements
List(new YCheckPositions) :: // YCheck positions
List(new sbt.ExtractDependencies) :: // Sends information on classes' dependencies to sbt via callbacks
Expand Down
1 change: 1 addition & 0 deletions compiler/src/dotty/tools/dotc/config/ScalaSettings.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ private sealed trait WarningSettings:
),
default = Nil
)
val WdollarCheck: Setting[Boolean] = BooleanSetting("-Wdollar-check", "Warn if identifier contains a dollar sign")
object WunusedHas:
def isChoiceSet(s: String)(using Context) = Wunused.value.pipe(us => us.contains(s))
def allOr(s: String)(using Context) = Wunused.value.pipe(us => us.contains("all") || us.contains(s))
Expand Down
89 changes: 89 additions & 0 deletions compiler/src/dotty/tools/dotc/transform/CheckDollarInIdentifier.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
package dotty.tools.dotc.transform

import dotty.tools.dotc.ast.tpd
import dotty.tools.dotc.ast.tpd.Tree
import dotty.tools.dotc.core.Contexts.Context
import dotty.tools.dotc.transform.MegaPhase.MiniPhase
import dotty.tools.dotc.core.Contexts.*
import dotty.tools.dotc.core.StdNames.nme
import dotty.tools.dotc.report


class CheckDollarInIdentifier extends MiniPhase:
import CheckDollarInIdentifier.ShouldNotContainDollarSignError

override def phaseName: String = CheckDollarInIdentifier.phaseName

override def description: String = CheckDollarInIdentifier.description

override def isRunnable(using Context): Boolean =
super.isRunnable &&
ctx.settings.WdollarCheck.value &&
!ctx.isJava

override def transformValDef(tree: tpd.ValDef)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)

override def transformDefDef(tree: tpd.DefDef)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)

override def transformTypeDef(tree: tpd.TypeDef)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)

override def transformTemplate(tree: tpd.Template)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)

override def transformCaseDef(tree: tpd.CaseDef)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)

override def transformPackageDef(tree: tpd.PackageDef)(using Context): tpd.Tree =
reportDollarInIdentifier(tree)


private val allowedValTermNames = List(
nme.DOLLAR_VALUES,
nme.ordinalDollar_,
).map(_.toString)

private val allowedDefTermNames = List(
nme.DOLLAR_NEW,
nme.ANON_FUN,
).map(_.toString)

private def allowedTerms[T <: Tree](tree: T): List[String] =
tree match
case _: tpd.ValDef => allowedValTermNames
case _: tpd.DefDef => allowedDefTermNames
case _ => Nil

private def containsAllowedTerms[T <: Tree](tree: T, name: String): Boolean =
allowedTerms(tree).contains(name)

private def symbolName[T <: Tree](tree: T)(using Context): String =
tree match
case typeDef: tpd.TypeDef =>
typeDef.symbol.toString match {
case s"module class $className$$" => className // to catch the compiled singleton class which includes a $ at the end
case _ => tree.symbol.name.toString
}
case _ => tree.symbol.name.toString

private def reportDollarInIdentifier[T <: Tree](tree: T)(using Context): T =
val name = symbolName(tree)
val originalSrcPos = tree.srcPos.sourcePos
val originalSpan = originalSrcPos.span

// only report source-derived (non-synthetic) spans
if name.contains("$") && !containsAllowedTerms(tree, name) && !originalSpan.isSynthetic then
val srcPos = originalSrcPos.withSpan(originalSrcPos.span.focus) // focus span to place a single `^` at identifier position
report.warning(ShouldNotContainDollarSignError, srcPos)

tree


object CheckDollarInIdentifier:
val phaseName: String = "checkDollarInIdentifier"
val description: String = "warns if identifiers contain dollar sign, $"

private val ShouldNotContainDollarSignError = s"identifiers should not include dollar sign"

244 changes: 244 additions & 0 deletions tests/neg/i18234.check
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
-- Error: tests/neg/i18234.scala:40:7 ----------------------------------------------------------------------------------
40 | case $BadCaseStart // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:41:7 ----------------------------------------------------------------------------------
41 | case BadCase$Middle // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:42:7 ----------------------------------------------------------------------------------
42 | case BadCaseEnd$ // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:44:5 ----------------------------------------------------------------------------------
44 |enum $BadEnumStart: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:46:7 ----------------------------------------------------------------------------------
46 | case $BadCase // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:48:5 ----------------------------------------------------------------------------------
48 |enum BadEnum$Middle: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:50:7 ----------------------------------------------------------------------------------
50 | case Bad$Case // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:52:5 ----------------------------------------------------------------------------------
52 |enum BadEnumEnd$: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:54:7 ----------------------------------------------------------------------------------
54 | case BadCase$ // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:56:5 ----------------------------------------------------------------------------------
56 |enum E$numWithEndKeyword: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:68:6 ----------------------------------------------------------------------------------
68 | val $badVal = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:66:7 ----------------------------------------------------------------------------------
66 |object $ObjectStart: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:72:6 ----------------------------------------------------------------------------------
72 | val bad$Val = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:70:7 ----------------------------------------------------------------------------------
70 |object Object$Middle: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:76:6 ----------------------------------------------------------------------------------
76 | val badVal$ = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:74:7 ----------------------------------------------------------------------------------
74 |object ObjectEnd$: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:80:6 ----------------------------------------------------------------------------------
80 | val b$adVal = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:82:7 ----------------------------------------------------------------------------------
82 |object Ob$jectWithEndKeyword: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:89:11 ---------------------------------------------------------------------------------
89 |case class $InlineCaseClassStart(someField: Int) // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:90:11 ---------------------------------------------------------------------------------
90 |case class InlineCaseClass$Middle(someField: Int) // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:91:11 ---------------------------------------------------------------------------------
91 |case class InlineCaseClassEnd$(someField: Int) // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:93:43 ---------------------------------------------------------------------------------
93 |case class InlineCaseClass(goodField: Int, badFiel$d: Int) // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:97:2 ----------------------------------------------------------------------------------
97 | b$adfield: Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:95:11 ---------------------------------------------------------------------------------
95 |case class $CaseClassStart( // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:102:2 ---------------------------------------------------------------------------------
102 | bad$Field: Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:100:11 --------------------------------------------------------------------------------
100 |case class CaseClass$Middle( // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:107:2 ---------------------------------------------------------------------------------
107 | badField$: Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:105:11 --------------------------------------------------------------------------------
105 |case class CaseClassEnd$( // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:111:7 ---------------------------------------------------------------------------------
111 |object CaseClassEnd$: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:118:6 ---------------------------------------------------------------------------------
118 |class $StartClass // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:119:6 ---------------------------------------------------------------------------------
119 |class Middle$Class // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:120:6 ---------------------------------------------------------------------------------
120 |class EndClass$ // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:124:7 ---------------------------------------------------------------------------------
124 | var badM$ember: Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:127:6 ---------------------------------------------------------------------------------
127 | def bad$Method(y: Int) = goodMember // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:128:28 --------------------------------------------------------------------------------
128 | def methodWithBadArgNames(b$ad$arg: Int) = goodMember // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:129:6 ---------------------------------------------------------------------------------
129 | def method$WithEndKeyword() = // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:122:6 ---------------------------------------------------------------------------------
122 |class Cla$$( // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:142:6 ---------------------------------------------------------------------------------
142 |trait $BadTraitStart // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:143:6 ---------------------------------------------------------------------------------
143 |trait BadTrait$Middle // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:144:6 ---------------------------------------------------------------------------------
144 |trait BadTraitEnd$ // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:150:6 ---------------------------------------------------------------------------------
150 | val b$adVal = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:154:6 ---------------------------------------------------------------------------------
154 | val $badVal = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:152:8 ---------------------------------------------------------------------------------
152 |package $BadPackageStart: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:158:6 ---------------------------------------------------------------------------------
158 | val bad$Val = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:156:8 ---------------------------------------------------------------------------------
156 |package BadPackage$Middle: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:162:6 ---------------------------------------------------------------------------------
162 | val badVal$ = 2 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:160:8 ---------------------------------------------------------------------------------
160 |package BadPackageEnd$: // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:5:4 -----------------------------------------------------------------------------------
5 |val $startVal = 1 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:6:4 -----------------------------------------------------------------------------------
6 |val mid$dleVal = 1 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:7:4 -----------------------------------------------------------------------------------
7 |val endVal$ = 1 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:13:4 ----------------------------------------------------------------------------------
13 |def $funcStart() = 3 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:14:4 ----------------------------------------------------------------------------------
14 |def func$Middle() = 3 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:15:4 ----------------------------------------------------------------------------------
15 |def funcEnd$() = 3 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:17:30 ---------------------------------------------------------------------------------
17 |def func1badArg(goodArg: Int, bad$Arg: Int) = 5 // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:18:57 ---------------------------------------------------------------------------------
18 |def func1badArgAndUsageDoesNotThrowWarning(goodArg: Int, bad$Arg: Int) = bad$Arg // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:19:31 ---------------------------------------------------------------------------------
19 |def func2badArgs(goodArg: Int, bad$Arg: Int, bad$arg2: String) = 5 // error // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:19:45 ---------------------------------------------------------------------------------
19 |def func2badArgs(goodArg: Int, bad$Arg: Int, bad$arg2: String) = 5 // error // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:22:2 ----------------------------------------------------------------------------------
22 | badAr$g: Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:30:5 ----------------------------------------------------------------------------------
30 |type $StartType = Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:31:5 ----------------------------------------------------------------------------------
31 |type Middle$Type = Int // error
| ^
| identifiers should not include dollar sign
-- Error: tests/neg/i18234.scala:32:5 ----------------------------------------------------------------------------------
32 |type EndType$ = Int // error
| ^
| identifiers should not include dollar sign
Loading