From 75bab6031774583318f836de4f3dc115fb78de60 Mon Sep 17 00:00:00 2001 From: Maciej Gajek Date: Tue, 12 Dec 2023 10:52:54 +0100 Subject: [PATCH] Update docs about toolkit --- .../cli/commands/shared/SharedOptions.scala | 4 ++-- .../preprocessing/directives/Toolkit.scala | 8 +++++--- website/docs/guides/introduction/toolkit.md | 20 +++++++++++-------- website/docs/reference/cli-options.md | 2 +- website/docs/reference/directives.md | 6 +++--- .../reference/scala-command/cli-options.md | 2 +- .../reference/scala-command/directives.md | 6 +++--- .../scala-command/runner-specification.md | 18 ++++++++--------- 8 files changed, 36 insertions(+), 30 deletions(-) diff --git a/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala index 5c28b5ef48..57064793df 100644 --- a/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala +++ b/modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala @@ -210,8 +210,8 @@ final case class SharedOptions( @Tag(tags.must) compilationOutput: Option[String] = None, @Group(HelpGroup.Scala.toString) - @HelpMessage("Add toolkit to classPath") - @ValueDescription("version|latest") + @HelpMessage(s"Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: ${Constants.toolkitDefaultVersion}, 'default' version for typelevel toolkit: ${Constants.typelevelToolkitDefaultVersion}") + @ValueDescription("version|default") @Name("toolkit") @Tag(tags.implementation) @Tag(tags.inShortHelp) diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala index df705bec78..c34da0957e 100644 --- a/modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala +++ b/modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala @@ -20,13 +20,15 @@ import scala.cli.commands.SpecificationLevel @DirectiveGroupName("Toolkit") @DirectiveExamples("//> using toolkit 0.1.0") -@DirectiveExamples("//> using toolkit latest") -@DirectiveExamples("//> using test.toolkit latest") +@DirectiveExamples("//> using toolkit default") +@DirectiveExamples("//> using test.toolkit default") @DirectiveUsage( "//> using toolkit _version_", "`//> using toolkit` _version_" ) -@DirectiveDescription("Use a toolkit as dependency") +@DirectiveDescription( + s"Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for Scala toolkit: ${Constants.toolkitDefaultVersion}, 'default' version for typelevel toolkit: ${Constants.typelevelToolkitDefaultVersion}" +) @DirectiveLevel(SpecificationLevel.SHOULD) final case class Toolkit( toolkit: Option[Positioned[String]] = None, diff --git a/website/docs/guides/introduction/toolkit.md b/website/docs/guides/introduction/toolkit.md index 691656206e..9bc1216780 100644 --- a/website/docs/guides/introduction/toolkit.md +++ b/website/docs/guides/introduction/toolkit.md @@ -5,6 +5,10 @@ sidebar_position: 7 import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js"; +:::caution +Newer versions of toolkits dropped support for Scala 2.12 +::: + # Scala Toolkit [Scala Toolkit](https://github.com/scala/toolkit) is an ongoing @@ -20,7 +24,7 @@ println(os.pwd) ``` ```bash -scala-cli UseOsLib.sc --toolkit latest +scala-cli UseOsLib.sc --toolkit default ``` @@ -28,7 +32,7 @@ scala-cli UseOsLib.sc --toolkit latest Similarly, you can achieve the same with the `using toolkit` directive: ```scala compile -//> using toolkit latest +//> using toolkit default @main def printPwd: Unit = println(os.pwd) ``` @@ -47,7 +51,7 @@ And so, you can use it like this: ```scala title=Something.test.scala -//> using toolkit latest +//> using toolkit default class Something extends munit.FunSuite { test("foo") { assert(true) @@ -67,7 +71,7 @@ you can always use the `using test.toolkit` directive. ```scala title=project.scala -//> using test.toolkit latest +//> using test.toolkit default ``` ```scala title=Another.test.scala @@ -110,8 +114,8 @@ object Hello extends IOApp.Simple { ``` ```bash -scala-cli UseTypelevel.scala --toolkit org.typelevel:latest -scala-cli UseTypelevel.scala --toolkit typelevel:latest # typelevel has a shorter alias defined +scala-cli UseTypelevel.scala --toolkit org.typelevel:default +scala-cli UseTypelevel.scala --toolkit typelevel:default # typelevel has a shorter alias defined ``` @@ -119,7 +123,7 @@ scala-cli UseTypelevel.scala --toolkit typelevel:latest # typelevel has a shorte Similarly, you can achieve the same with the `using toolkit` directive: ```scala compile -//> using toolkit org.typelevel:latest +//> using toolkit org.typelevel:default import cats.effect.* import fs2.io.file.Files @@ -134,7 +138,7 @@ object Hello extends IOApp.Simple { Or with the alias: ```scala compile -//> using toolkit typelevel:latest +//> using toolkit typelevel:default import cats.effect.* import fs2.io.file.Files diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md index ed1eceba57..13b9513f33 100644 --- a/website/docs/reference/cli-options.md +++ b/website/docs/reference/cli-options.md @@ -1543,7 +1543,7 @@ Copy compilation results to output directory using either relative or absolute p Aliases: `--toolkit` -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 ### `--exclude` diff --git a/website/docs/reference/directives.md b/website/docs/reference/directives.md index 9c198adef8..0a92be3ddf 100644 --- a/website/docs/reference/directives.md +++ b/website/docs/reference/directives.md @@ -410,16 +410,16 @@ Set the test framework ### Toolkit -Use a toolkit as dependency +Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 `//> using toolkit` _version_ #### Examples `//> using toolkit 0.1.0` -`//> using toolkit latest` +`//> using toolkit default` -`//> using test.toolkit latest` +`//> using test.toolkit default` ## target directives diff --git a/website/docs/reference/scala-command/cli-options.md b/website/docs/reference/scala-command/cli-options.md index cbee2a61e8..e69329cbdb 100644 --- a/website/docs/reference/scala-command/cli-options.md +++ b/website/docs/reference/scala-command/cli-options.md @@ -1044,7 +1044,7 @@ Aliases: `--toolkit` `IMPLEMENTATION specific` per Scala Runner specification -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 ### `--exclude` diff --git a/website/docs/reference/scala-command/directives.md b/website/docs/reference/scala-command/directives.md index 06f72fef87..ffb58b190c 100644 --- a/website/docs/reference/scala-command/directives.md +++ b/website/docs/reference/scala-command/directives.md @@ -296,14 +296,14 @@ Set the test framework ### Toolkit -Use a toolkit as dependency +Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 `//> using toolkit` _version_ #### Examples `//> using toolkit 0.1.0` -`//> using toolkit latest` +`//> using toolkit default` -`//> using test.toolkit latest` +`//> using test.toolkit default` diff --git a/website/docs/reference/scala-command/runner-specification.md b/website/docs/reference/scala-command/runner-specification.md index 3e7a223582..c11822ed79 100644 --- a/website/docs/reference/scala-command/runner-specification.md +++ b/website/docs/reference/scala-command/runner-specification.md @@ -584,7 +584,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -1311,7 +1311,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -1864,7 +1864,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -2447,7 +2447,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -3039,7 +3039,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -3589,7 +3589,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -4214,7 +4214,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -4846,7 +4846,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit` @@ -5733,7 +5733,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help` **--with-toolkit** -Add toolkit to classPath +Add toolkit to classPath (not supported in Scala 2.12), 'default' version for Scala toolkit: 0.2.1, 'default' version for typelevel toolkit: 0.1.20 Aliases: `--toolkit`