Directives API

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

@@ -23,7 +23,7 @@ import scala.build.options.{
   SuppressWarningOptions,
   WithBuildRequirements
 }
-import scala.build.preprocessing.directives.DirectivesPreprocessingUtils.*
+import scala.build.preprocessing.directives.Directives.*
 import scala.build.preprocessing.directives.PartiallyProcessedDirectives.*
 import scala.build.preprocessing.directives.*
 

modules/cli/src/main/scala/scala/cli/commands/fix/BuiltInRules.scala

@@ -20,12 +20,12 @@ import scala.collection.immutable.HashMap
 import scala.util.chaining.scalaUtilChainingOps
 
 object BuiltInRules extends CommandHelpers {
-  private lazy val targetDirectivesKeysSet = DirectivesPreprocessingUtils.requireDirectiveHandlers
+  private lazy val targetDirectivesKeysSet = Directives.requireDirectiveHandlers
     .flatMap(_.keys.flatMap(_.nameAliases)).toSet
-  private lazy val usingDirectivesKeysGrouped = DirectivesPreprocessingUtils.usingDirectiveHandlers
+  private lazy val usingDirectivesKeysGrouped = Directives.usingDirectiveHandlers
     .flatMap(_.keys)
   private lazy val usingDirectivesWithTestPrefixKeysGrouped =
-    DirectivesPreprocessingUtils.usingDirectiveWithReqsHandlers
+    Directives.usingDirectiveWithReqsHandlers
       .flatMap(_.keys)
 
   private lazy val directiveTestPrefix = "test."

modules/directives/src/main/scala/scala/build/preprocessing/directives/DirectiveHandler.scala

@@ -46,35 +46,41 @@ trait DirectiveHandler[+T] { self =>
 
   def map[U](f: T => U): DirectiveHandler[U] =
     new DirectiveHandler[U] {
-      def name                   = self.name
-      def usage                  = self.usage
-      override def usageMd       = self.usageMd
-      def description            = self.description
-      override def descriptionMd = self.descriptionMd
-      override def examples      = self.examples
+      def name: String                   = self.name
+      def usage: String                  = self.usage
+      override def usageMd: String       = self.usageMd
+      def description: String            = self.description
+      override def descriptionMd: String = self.descriptionMd
+      override def examples: Seq[String] = self.examples
 
-      def scalaSpecificationLevel = self.scalaSpecificationLevel
+      def scalaSpecificationLevel: SpecificationLevel = self.scalaSpecificationLevel
 
-      def keys = self.keys
+      def keys: Seq[Key] = self.keys
 
-      def handleValues(scopedDirective: ScopedDirective, logger: Logger) =
+      def handleValues(
+        scopedDirective: ScopedDirective,
+        logger: Logger
+      ): Either[BuildException, ProcessedDirective[U]] =
         self.handleValues(scopedDirective, logger)
           .map(_.map(f))
     }
   def mapE[U](f: T => Either[BuildException, U]): DirectiveHandler[U] =
     new DirectiveHandler[U] {
-      def name                   = self.name
-      def usage                  = self.usage
-      override def usageMd       = self.usageMd
-      def description            = self.description
-      override def descriptionMd = self.descriptionMd
-      override def examples      = self.examples
+      def name: String                   = self.name
+      def usage: String                  = self.usage
+      override def usageMd: String       = self.usageMd
+      def description: String            = self.description
+      override def descriptionMd: String = self.descriptionMd
+      override def examples: Seq[String] = self.examples
 
-      def scalaSpecificationLevel = self.scalaSpecificationLevel
+      def scalaSpecificationLevel: SpecificationLevel = self.scalaSpecificationLevel
 
-      def keys = self.keys
+      def keys: Seq[Key] = self.keys
 
-      def handleValues(scopedDirective: ScopedDirective, logger: Logger) =
+      def handleValues(
+        scopedDirective: ScopedDirective,
+        logger: Logger
+      ): Either[BuildException, ProcessedDirective[U]] =
         self.handleValues(scopedDirective, logger).flatMap(_.mapE(f))
     }
 

modules/build/src/main/scala/scala/build/preprocessing/directives/DirectivesPreprocessingUtils.scala → modules/directives/src/main/scala/scala/build/preprocessing/directives/Directives.scala

@@ -5,13 +5,12 @@ import scala.build.directives.{
   HasBuildOptionsWithRequirements,
   HasBuildRequirements
 }
-import scala.build.errors.{BuildException, UnusedDirectiveError}
 import scala.build.options.{BuildOptions, BuildRequirements, WithBuildRequirements}
 import scala.build.preprocessing.directives
 
-object DirectivesPreprocessingUtils {
+object Directives {
   val usingDirectiveHandlers: Seq[DirectiveHandler[BuildOptions]] =
-    Seq[DirectiveHandler[_ <: HasBuildOptions]](
+    Seq[DirectiveHandler[? <: HasBuildOptions]](
       directives.Benchmarking.handler,
       directives.BuildInfo.handler,
       directives.ComputeVersion.handler,
@@ -37,7 +36,7 @@ object DirectivesPreprocessingUtils {
 
   val usingDirectiveWithReqsHandlers
     : Seq[DirectiveHandler[List[WithBuildRequirements[BuildOptions]]]] =
-    Seq[DirectiveHandler[_ <: HasBuildOptionsWithRequirements]](
+    Seq[DirectiveHandler[? <: HasBuildOptionsWithRequirements]](
       directives.CustomJar.handler,
       directives.Dependency.handler,
       directives.JavaOptions.handler,
@@ -49,10 +48,17 @@ object DirectivesPreprocessingUtils {
     ).map(_.mapE(_.buildOptionsWithRequirements))
 
   val requireDirectiveHandlers: Seq[DirectiveHandler[BuildRequirements]] =
-    Seq[DirectiveHandler[_ <: HasBuildRequirements]](
+    Seq[DirectiveHandler[? <: HasBuildRequirements]](
       directives.RequirePlatform.handler,
       directives.RequireScalaVersion.handler,
       directives.RequireScalaVersionBounds.handler,
       directives.RequireScope.handler
     ).map(_.mapE(_.buildRequirements))
+
+  def allDirectiveHandlers: Seq[DirectiveHandler[BuildRequirements | BuildOptions]] =
+    usingDirectiveHandlers ++ requireDirectiveHandlers
+
+  def getDirectiveHandler(key: String): Option[DirectiveHandler[BuildRequirements | BuildOptions]] =
+    allDirectiveHandlers.find(_.keys.exists(_.nameAliases.contains(key)))
+
 }

modules/directives/src/test/scala/scala/build/preprocessing/directives/DirectivesTest.scala

@@ -0,0 +1,19 @@
+package scala.build.preprocessing.directives
+
+import com.eed3si9n.expecty.Expecty.expect
+
+class DirectivesTest extends munit.FunSuite {
+  test("get directive handler by key") {
+    val key     = "python"
+    val handler = Directives.getDirectiveHandler(key).get
+    expect(handler.keys.flatMap(_.nameAliases).contains(key))
+    expect(handler.isExperimental)
+    expect(handler.name == "Python")
+    expect(handler.description.nonEmpty)
+    expect(handler.descriptionMd.nonEmpty)
+    expect(handler.usage.nonEmpty)
+    expect(handler.usageMd.nonEmpty)
+    expect(handler.examples.nonEmpty)
+  }
+
+}

modules/generate-reference-doc/src/main/scala/scala/cli/doc/GenerateReferenceDoc.scala

@@ -16,7 +16,7 @@ import scala.build.internal.Constants
 import scala.build.internals.EnvVar
 import scala.build.options.{BuildOptions, BuildRequirements, WithBuildRequirements}
 import scala.build.preprocessing.directives.DirectiveHandler
-import scala.build.preprocessing.directives.DirectivesPreprocessingUtils.*
+import scala.build.preprocessing.directives.Directives.*
 import scala.cli.commands.{ScalaCommand, SpecificationLevel, tags}
 import scala.cli.doc.ReferenceDocUtils.*
 import scala.cli.util.ArgHelpers.*