Skip to content

Analyzer rule to check for a required base package - handle imports #434

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

Merged
merged 3 commits into from
Mar 16, 2023
Merged

Analyzer rule to check for a required base package - handle imports #434

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
9ec4d1b
Handle imports when checking required base package
sebaciv Mar 15, 2023
1c2d0aa
Handle imports when checking required base package - rename
sebaciv Mar 15, 2023
ceb0e54
Handle imports when checking required base package - simplify code
sebaciv Mar 16, 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
9 changes: 8 additions & 1 deletion commons-analyzer/src/main/scala/com/avsystem/commons/analyzer/BasePackage.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ class BasePackage(g: Global) extends AnalyzerRule(g, "basePackage") {

import global._

object SkipImports {
@tailrec def unapply(stats: List[Tree]): Some[List[Tree]] = stats match {
case Import(_, _) :: tail => unapply(tail)
case stats => Some(stats)
}
}

def analyze(unit: CompilationUnit): Unit = if (argument != null) {
val requiredBasePackage = argument

@tailrec def validate(tree: Tree): Unit = tree match {
case PackageDef(pid, _) if pid.symbol.hasPackageFlag && pid.symbol.fullName == requiredBasePackage =>
case PackageDef(_, List(stat)) => validate(stat)
case PackageDef(_, SkipImports(List(stat))) => validate(stat)
case t => report(t.pos, s"`$requiredBasePackage` must be one of the base packages in this file")
}

Expand Down
35 changes: 35 additions & 0 deletions commons-analyzer/src/test/scala/com/avsystem/commons/analyzer/BasePackageTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,36 @@ class BasePackageTest extends AnyFunSuite with AnalyzerTest {
|""".stripMargin)
}

test("base package object with imports") {
assertNoErrors(
"""
|package com.avsystem
|
|import scala.collection.mutable.Seq
|import scala.collection.mutable.Set
|
|package object commons
|""".stripMargin)
}

test("no base package") {
assertErrors(1,
"""
|object bar
|""".stripMargin)
}

test("no base package with imports") {
assertErrors(1,
"""
|import scala.collection.mutable.Seq
|import scala.collection.mutable.Set
|
|object bar
|""".stripMargin)
}


test("wrong base package") {
assertErrors(1,
"""
Expand All @@ -68,4 +91,16 @@ class BasePackageTest extends AnyFunSuite with AnalyzerTest {
|object bar
|""".stripMargin)
}

test("unchained subpackage with imports") {
assertErrors(1,
"""
|package com.avsystem.commons.core
|
|import scala.collection.mutable.Seq
|import scala.collection.mutable.Set
|
|object bar
|""".stripMargin)
}
}
2 changes: 1 addition & 1 deletion docs/Analyzer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Here's a list of currently supported rules:
| `discardedMonixTask` | warning | Makes sure that expressions evaluating to Monix `Task`s are not accidentally discarded by conversion to `Unit` |
| `throwableObjects` | warning | Makes sure that objects are never used as `Throwable`s (unless they have stack traces disabled) |
| `constantDeclarations` | off | Checks if constants are always declared as `final val`s with `UpperCamelCase` and no explicit type annotation for literal values |
| `basePackage | warning | Checks if all sources are within the specified base package |
| `basePackage` | warning | Checks if all sources are within the specified base package |

Rules may be enabled and disabled in `build.sbt` with Scala compiler options:

Expand Down