diff --git a/build.sbt b/build.sbt index 4ad4b84a..e38bf58b 100644 --- a/build.sbt +++ b/build.sbt @@ -2,7 +2,7 @@ name := "flatgraph" ThisBuild / organization := "io.joern" ThisBuild / scalaVersion := scala3 -val scala3 = "3.3.6" +val scala3 = "3.3.7" // ^ n.b. should always be the current scala LTS release, see // https://www.scala-lang.org/blog/2022/08/17/long-term-compatibility-plans.html#library-maintainers val scala2_12 = "2.12.20" @@ -209,7 +209,6 @@ ThisBuild / scalacOptions ++= Seq( "-feature", "--release", "8", "-language:implicitConversions", - "-old-syntax", "-no-indent" ) diff --git a/domain-classes-generator/src/main/scala/flatgraph/codegen/DomainClassesGenerator.scala b/domain-classes-generator/src/main/scala/flatgraph/codegen/DomainClassesGenerator.scala index f11c3770..6be819ec 100644 --- a/domain-classes-generator/src/main/scala/flatgraph/codegen/DomainClassesGenerator.scala +++ b/domain-classes-generator/src/main/scala/flatgraph/codegen/DomainClassesGenerator.scala @@ -976,19 +976,19 @@ class DomainClassesGenerator(schema: Schema) { | |@scala.annotation.implicitNotFound( | \"\"\"If you're using flatgraph purely without a schema and associated generated domain classes, you can - | |start with `given DocSearchPackages = DocSearchPackages.default`. - | |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - | |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - | |\"\"\".stripMargin) + |start with `given DocSearchPackages = DocSearchPackages.default`. + |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. + |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` + |\"\"\") | def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = | flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) | |@scala.annotation.implicitNotFound( | \"\"\"If you're using flatgraph purely without a schema and associated generated domain classes, you can - | |start with `given DocSearchPackages = DocSearchPackages.default`. - | |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - | |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - | |\"\"\".stripMargin) + |start with `given DocSearchPackages = DocSearchPackages.default`. + |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. + |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` + |\"\"\") | def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = | flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true) | diff --git a/help/src/main/scala/flatgraph/help/Language.scala b/help/src/main/scala/flatgraph/help/Language.scala index e4d146b1..e043e182 100644 --- a/help/src/main/scala/flatgraph/help/Language.scala +++ b/help/src/main/scala/flatgraph/help/Language.scala @@ -21,10 +21,10 @@ class HelpSteps[A](iterator: Iterator[A]) extends AnyVal { */ @Doc(info = "print help/documentation based on the current elementType `A`.") @implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help[B >: A](implicit elementType: ClassTag[B], searchPackages: DocSearchPackages, @@ -34,10 +34,10 @@ class HelpSteps[A](iterator: Iterator[A]) extends AnyVal { @Doc(info = "print verbose help/documentation based on the current elementType `A`.") @implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose[B >: A](implicit elementType: ClassTag[B], searchPackages: DocSearchPackages, diff --git a/test-schemas-domain-classes/src/main/scala/testdomains/codepropertygraphminified/CpgMinified.scala b/test-schemas-domain-classes/src/main/scala/testdomains/codepropertygraphminified/CpgMinified.scala index d55451e8..ef1cfcd4 100644 --- a/test-schemas-domain-classes/src/main/scala/testdomains/codepropertygraphminified/CpgMinified.scala +++ b/test-schemas-domain-classes/src/main/scala/testdomains/codepropertygraphminified/CpgMinified.scala @@ -8,18 +8,18 @@ object CpgMinified { val defaultDocSearchPackage = DocSearchPackages.default.withAdditionalPackage(getClass.getPackage.getName) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true) diff --git a/test-schemas-domain-classes/src/main/scala/testdomains/empty/Empty.scala b/test-schemas-domain-classes/src/main/scala/testdomains/empty/Empty.scala index 0d53cb05..0439ac73 100644 --- a/test-schemas-domain-classes/src/main/scala/testdomains/empty/Empty.scala +++ b/test-schemas-domain-classes/src/main/scala/testdomains/empty/Empty.scala @@ -8,18 +8,18 @@ object Empty { val defaultDocSearchPackage = DocSearchPackages.default.withAdditionalPackage(getClass.getPackage.getName) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true) diff --git a/test-schemas-domain-classes/src/main/scala/testdomains/generic/GenericDomain.scala b/test-schemas-domain-classes/src/main/scala/testdomains/generic/GenericDomain.scala index 8f9dbcf5..50f10b3d 100644 --- a/test-schemas-domain-classes/src/main/scala/testdomains/generic/GenericDomain.scala +++ b/test-schemas-domain-classes/src/main/scala/testdomains/generic/GenericDomain.scala @@ -8,18 +8,18 @@ object GenericDomain { val defaultDocSearchPackage = DocSearchPackages.default.withAdditionalPackage(getClass.getPackage.getName) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true) diff --git a/test-schemas-domain-classes/src/main/scala/testdomains/gratefuldead/GratefulDead.scala b/test-schemas-domain-classes/src/main/scala/testdomains/gratefuldead/GratefulDead.scala index 8a7215b6..95c38031 100644 --- a/test-schemas-domain-classes/src/main/scala/testdomains/gratefuldead/GratefulDead.scala +++ b/test-schemas-domain-classes/src/main/scala/testdomains/gratefuldead/GratefulDead.scala @@ -8,18 +8,18 @@ object GratefulDead { val defaultDocSearchPackage = DocSearchPackages.default.withAdditionalPackage(getClass.getPackage.getName) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true) diff --git a/test-schemas-domain-classes/src/main/scala/testdomains/hierarchical/Hierarchical.scala b/test-schemas-domain-classes/src/main/scala/testdomains/hierarchical/Hierarchical.scala index 1632eaa5..a2e2fae3 100644 --- a/test-schemas-domain-classes/src/main/scala/testdomains/hierarchical/Hierarchical.scala +++ b/test-schemas-domain-classes/src/main/scala/testdomains/hierarchical/Hierarchical.scala @@ -8,18 +8,18 @@ object Hierarchical { val defaultDocSearchPackage = DocSearchPackages.default.withAdditionalPackage(getClass.getPackage.getName) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def help(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = false) @scala.annotation.implicitNotFound("""If you're using flatgraph purely without a schema and associated generated domain classes, you can - |start with `given DocSearchPackages = DocSearchPackages.default`. - |If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. - |If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` - |""".stripMargin) +start with `given DocSearchPackages = DocSearchPackages.default`. +If you have generated domain classes, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage`. +If you have additional custom extension steps that specify help texts via @Doc annotations, use `given DocSearchPackages = MyDomain.defaultDocSearchPackage.withAdditionalPackage("my.custom.package)"` +""") def helpVerbose(implicit searchPackageNames: DocSearchPackages, availableWidthProvider: AvailableWidthProvider) = flatgraph.help.TraversalHelp(searchPackageNames).forTraversalSources(verbose = true)