Merge pull request #1932 from tgodzik/update-using-dirs

chore: Remove all deprecated using directive styles

Author: lwronski

modules/build/src/main/scala/scala/build/preprocessing/ExtractedDirectives.scala

@@ -18,13 +18,12 @@ import scala.collection.mutable
 import scala.jdk.CollectionConverters.*
 
 case class ExtractedDirectives(
-  offset: Int,
   directives: Seq[StrictDirective],
   positions: Option[DirectivesPositions]
 ) {
   @targetName("append")
   def ++(other: ExtractedDirectives): ExtractedDirectives =
-    ExtractedDirectives(offset, directives ++ other.directives, positions)
+    ExtractedDirectives(directives ++ other.directives, positions)
 }
 
 case class DirectivesPositions(
@@ -35,16 +34,15 @@ case class DirectivesPositions(
 
 object ExtractedDirectives {
 
-  def empty: ExtractedDirectives = ExtractedDirectives(0, Seq.empty, None)
+  def empty: ExtractedDirectives = ExtractedDirectives(Seq.empty, None)
 
   val changeToSpecialCommentMsg =
-    "Using directive using plain comments are deprecated. Please use a special comment syntax: '//> ...' or '/*> ... */'"
+    "Using directive using plain comments are deprecated. Please use a special comment syntax: '//> ...'"
 
   def from(
     contentChars: Array[Char],
     path: Either[String, os.Path],
     logger: Logger,
-    supportedDirectives: Array[UsingDirectiveKind],
     cwd: ScopePath,
     maybeRecoverOnError: BuildException => Option[BuildException]
   ): Either[BuildException, ExtractedDirectives] = {
@@ -101,31 +99,24 @@ object ExtractedDirectives {
           logger.diagnostic(msg, positions = Seq(position))
         }
 
-      val usedDirectives =
-        if (codeDirectives.nonEmpty) {
-          val msg =
-            "This using directive is ignored. File contains directives outside comments and those have higher precedence."
-          reportWarning(
-            msg,
-            getDirectives(plainCommentDirectives) ++ getDirectives(specialCommentDirectives)
-          )
-          codeDirectives
-        }
-        else if (specialCommentDirectives.nonEmpty) {
-          val msg =
-            s"This using directive is ignored. $changeToSpecialCommentMsg"
-          reportWarning(msg, getDirectives(plainCommentDirectives))
-          specialCommentDirectives
-        }
-        else {
-          reportWarning(changeToSpecialCommentMsg, getDirectives(plainCommentDirectives))
-          plainCommentDirectives
-        }
+      if (codeDirectives.nonEmpty) {
+        val msg =
+          "This using directive is ignored. Only using directives starting with //> are supported."
+        reportWarning(msg, getDirectives(codeDirectives))
+      }
+
+      if (plainCommentDirectives.nonEmpty) {
+        val msg =
+          s"This using directive is ignored. $changeToSpecialCommentMsg"
+        reportWarning(msg, getDirectives(plainCommentDirectives))
+      }
+
+      val usedDirectives = specialCommentDirectives
 
       // All using directives should use just `using` keyword, no @using or require
       reportWarning(
         "Deprecated using directive syntax, please use keyword `using`.",
-        getDirectives(usedDirectives).filter(_.getSyntax != UsingDirectiveSyntax.Using),
+        getDirectives(specialCommentDirectives).filter(_.getSyntax != UsingDirectiveSyntax.Using),
         before = false
       )
 
@@ -136,33 +127,13 @@ object ExtractedDirectives {
             StrictDirective(k.getPath.asScala.mkString("."), l.asScala.toSeq)
         }
 
-      val offset =
-        if (usedDirectives.getKind != UsingDirectiveKind.Code) 0
-        else usedDirectives.getCodeOffset
-      if (supportedDirectives.contains(usedDirectives.getKind))
-        Right(ExtractedDirectives(offset, strictDirectives, directivesPositionsOpt))
-      else {
-        val directiveVales =
-          usedDirectives.getFlattenedMap.values().asScala.toList.flatMap(_.asScala)
-        val values = DirectiveUtil.concatAllValues(ScopedDirective(
-          StrictDirective("", directiveVales),
-          path,
-          cwd
-        ))
-        val directiveErrors = new DirectiveErrors(
-          ::(s"Directive '${usedDirectives.getKind}' is not supported in the given context'", Nil),
-          values.flatMap(_.positions)
-        )
-        maybeRecoverOnError(directiveErrors) match {
-          case Some(e) => Left(e)
-          case None    => Right(ExtractedDirectives.empty)
-        }
-      }
+      Right(ExtractedDirectives(strictDirectives, directivesPositionsOpt))
     }
     else
       maybeCompositeMalformedDirectiveError match {
         case Some(e) => Left(e)
         case None    => Right(ExtractedDirectives.empty)
       }
   }
+
 }

modules/build/src/main/scala/scala/build/preprocessing/MarkdownCodeBlockProcessor.scala

@@ -26,7 +26,6 @@ object MarkdownCodeBlockProcessor {
               contentChars = cb.body.toCharArray,
               path = reportingPath,
               logger = logger,
-              supportedDirectives = UsingDirectiveKind.values(),
               cwd = scopePath / os.up,
               maybeRecoverOnError = maybeRecoverOnError
             )

modules/build/src/main/scala/scala/build/preprocessing/PreprocessingUtil.scala

@@ -32,12 +32,11 @@ object PreprocessingUtil {
     BuildException,
     (DirectivesProcessorOutput[BuildOptions], Option[DirectivesPositions])
   ] = either {
-    val ExtractedDirectives(_, directives0, directivesPositions) =
+    val ExtractedDirectives(directives0, directivesPositions) =
       value(from(
         content.toCharArray,
         path,
         logger,
-        Array(UsingDirectiveKind.PlainComment, UsingDirectiveKind.SpecialComment),
         scopePath,
         maybeRecoverOnError
       ))

modules/build/src/main/scala/scala/build/preprocessing/ScalaPreprocessor.scala

@@ -209,7 +209,6 @@ case object ScalaPreprocessor extends Preprocessor {
       contentWithNoShebang.toCharArray,
       path,
       logger,
-      UsingDirectiveKind.values(),
       scopeRoot,
       maybeRecoverOnError
     ))
@@ -350,7 +349,7 @@ case object ScalaPreprocessor extends Preprocessor {
   ): Either[BuildException, StrictDirectivesProcessingOutput] = either {
     val contentChars = content.toCharArray
 
-    val ExtractedDirectives(codeOffset, directives0, directivesPositions) = extractedDirectives
+    val ExtractedDirectives(directives0, directivesPositions) = extractedDirectives
 
     val updatedOptions = value {
       DirectivesProcessor.process(
@@ -380,28 +379,14 @@ case object ScalaPreprocessor extends Preprocessor {
 
     val unusedDirectives = updatedRequirements.unused
 
-    val updatedContentOpt =
-      if (codeOffset > 0) {
-        val headerBytes = contentChars
-          .iterator
-          .take(codeOffset)
-          .map(c => if (c.isControl) c else ' ')
-          .toArray
-        val mainBytes      = contentChars.drop(codeOffset)
-        val updatedContent = new String(headerBytes ++ mainBytes)
-        if (updatedContent == content) None
-        else Some(updatedContent)
-      }
-      else None
-
     value {
       unusedDirectives match {
         case Seq() =>
           Right(StrictDirectivesProcessingOutput(
             updatedRequirements.global,
             updatedOptions.global,
             updatedRequirements.scoped,
-            updatedContentOpt,
+            strippedContent = None,
             directivesPositions
           ))
         case Seq(h, t*) =>
@@ -426,9 +411,6 @@ case object ScalaPreprocessor extends Preprocessor {
     )
   }
 
-  val changeToSpecialCommentMsg =
-    "Using directive using plain comments are deprecated. Please use a special comment syntax: '//> ...' or '/*> ... */'"
-
   private def parseDependency(str: String, pos: Position): Either[BuildException, AnyDependency] =
     DependencyParser.parse(str) match {
       case Left(msg)  => Left(new DependencyFormatError(str, msg, positionOpt = Some(pos)))

modules/build/src/test/scala/scala/build/tests/DirectiveParsingTest.scala

@@ -61,7 +61,6 @@ class DirectiveParsingTest extends munit.FunSuite {
       code,
       Right(path),
       persistentLogger,
-      UsingDirectiveKind.values(),
       ScopePath.fromPath(path),
       maybeRecoverOnError = e => Some(e)
     )
@@ -111,20 +110,18 @@ class DirectiveParsingTest extends munit.FunSuite {
   }
 
   test("Test warnings about mixing syntax") {
-    testDiagnostics(directive, specialCommentDirective)(Warn("ignored", 1, 0))
-    testDiagnostics(directive, commentDirective)(Warn("ignored", 1, 0))
+    testDiagnostics(directive, specialCommentDirective)(Warn("ignored", 0, 0))
+    testDiagnostics(directive, commentDirective)(Warn("ignored", 0, 0))
     testDiagnostics(specialCommentDirective, commentDirective)(Warn("ignored", 1, 0))
     testDiagnostics(commentDirective, specialCommentDirective)(Warn("deprecated", 0, 0))
   }
 
-  test("Plain comment only result in no ignored warning") {
-    testDiagnostics(commentDirective)(NoWarn("ignored"))
+  test("Plain comment result in ignored warning") {
+    testDiagnostics(commentDirective)(Warn("ignored", 0, 0))
   }
 
   test("@using is deprecated") {
     def addAt(s: String) = s.replace("using ", "@using ")
-    testDiagnostics(addAt(commentDirective))(Warn("syntax", 0, 3), Warn("keyword", 0, 3))
-    testDiagnostics(addAt(directive))(Warn("syntax", 0, 0), Warn("keyword", 0, 0))
     testDiagnostics(addAt(specialCommentDirective))(Warn("syntax", 0, 4), Warn("keyword", 0, 4))
   }
 

modules/build/src/test/scala/scala/build/tests/SourcesTests.scala

@@ -245,27 +245,6 @@ class SourcesTests extends munit.FunSuite {
     }
   }
 
-  test("should fail dependencies in .java  with using keyword") {
-    val testInputs = TestInputs(
-      os.rel / "Something.java" ->
-        """using dep "org3:::name3:3.3"
-          |
-          |public class Something {
-          |  public Int a = 1;
-          |}
-          |""".stripMargin
-    )
-    testInputs.withInputs { (_, inputs) =>
-      val crossSources = CrossSources.forInputs(
-        inputs,
-        preprocessors,
-        TestLogger(),
-        SuppressWarningOptions()
-      )
-      expect(crossSources.isLeft)
-    }
-  }
-
   test("should fail for ammonite imports in .sc - $ivy") {
     val testInputs = TestInputs(
       os.rel / "something.sc" ->

project/deps.sc

@@ -182,7 +182,7 @@ object Deps {
   def swoval          = ivy"com.swoval:file-tree-views:2.1.9"
   def testInterface   = ivy"org.scala-sbt:test-interface:1.0"
   def toolkit         = ivy"org.virtuslab:toolkit:0.1.0"
-  def usingDirectives = ivy"org.virtuslab:using_directives:0.0.10"
+  def usingDirectives = ivy"org.virtuslab:using_directives:0.1.0"
   // Lives at https://github.com/scala-cli/no-crc32-zip-input-stream, see #865
   // This provides a ZipInputStream that doesn't verify CRC32 checksums, that users
   // can enable by setting SCALA_CLI_VENDORED_ZIS=true in the environment, to workaround