Skip to content

Commit 4c7d609

Browse files
MaciejG604MaciejG604
committed
Update docs about toolkit
1 parent c3cc2cf commit 4c7d609

File tree

8 files changed

+36
-30
lines changed

8 files changed

+36
-30
lines changed

‎modules/cli/src/main/scala/scala/cli/commands/shared/SharedOptions.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,8 @@ final case class SharedOptions(
210210
@Tag(tags.must)
211211
compilationOutput: Option[String] = None,
212212
@Group(HelpGroup.Scala.toString)
213-
@HelpMessage("Add toolkit to classPath")
214-
@ValueDescription("version|latest")
213+
@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}")
214+
@ValueDescription("version|default")
215215
@Name("toolkit")
216216
@Tag(tags.implementation)
217217
@Tag(tags.inShortHelp)

‎modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ import scala.cli.commands.SpecificationLevel
2020

2121
@DirectiveGroupName("Toolkit")
2222
@DirectiveExamples("//> using toolkit 0.1.0")
23-
@DirectiveExamples("//> using toolkit latest")
24-
@DirectiveExamples("//> using test.toolkit latest")
23+
@DirectiveExamples("//> using toolkit default")
24+
@DirectiveExamples("//> using test.toolkit default")
2525
@DirectiveUsage(
2626
"//> using toolkit _version_",
2727
"`//> using toolkit` _version_"
2828
)
29-
@DirectiveDescription("Use a toolkit as dependency")
29+
@DirectiveDescription(
30+
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}"
31+
)
3032
@DirectiveLevel(SpecificationLevel.SHOULD)
3133
final case class Toolkit(
3234
toolkit: Option[Positioned[String]] = None,

‎website/docs/guides/introduction/toolkit.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ sidebar_position: 7
55

66
import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";
77

8+
:::caution
9+
Newer versions of toolkits dropped support for Scala 2.12
10+
:::
11+
812
# Scala Toolkit
913

1014
[Scala Toolkit](https://github.com/scala/toolkit) is an ongoing
@@ -20,15 +24,15 @@ println(os.pwd)
2024
```
2125

2226
```bash
23-
scala-cli UseOsLib.sc --toolkit latest
27+
scala-cli UseOsLib.sc --toolkit default
2428
```
2529

2630
</ChainedSnippets>
2731

2832
Similarly, you can achieve the same with the `using toolkit` directive:
2933

3034
```scala compile
31-
//> using toolkit latest
35+
//> using toolkit default
3236
@main def printPwd: Unit = println(os.pwd)
3337
```
3438

@@ -47,7 +51,7 @@ And so, you can use it like this:
4751
<ChainedSnippets>
4852

4953
```scala title=Something.test.scala
50-
//> using toolkit latest
54+
//> using toolkit default
5155
class Something extends munit.FunSuite {
5256
test("foo") {
5357
assert(true)
@@ -67,7 +71,7 @@ you can always use the `using test.toolkit` directive.
6771
<ChainedSnippets>
6872

6973
```scala title=project.scala
70-
//> using test.toolkit latest
74+
//> using test.toolkit default
7175
```
7276

7377
```scala title=Another.test.scala
@@ -110,16 +114,16 @@ object Hello extends IOApp.Simple {
110114
```
111115

112116
```bash
113-
scala-cli UseTypelevel.scala --toolkit org.typelevel:latest
114-
scala-cli UseTypelevel.scala --toolkit typelevel:latest # typelevel has a shorter alias defined
117+
scala-cli UseTypelevel.scala --toolkit org.typelevel:default
118+
scala-cli UseTypelevel.scala --toolkit typelevel:default # typelevel has a shorter alias defined
115119
```
116120

117121
</ChainedSnippets>
118122

119123
Similarly, you can achieve the same with the `using toolkit` directive:
120124

121125
```scala compile
122-
//> using toolkit org.typelevel:latest
126+
//> using toolkit org.typelevel:default
123127

124128
import cats.effect.*
125129
import fs2.io.file.Files
@@ -134,7 +138,7 @@ object Hello extends IOApp.Simple {
134138
Or with the alias:
135139

136140
```scala compile
137-
//> using toolkit typelevel:latest
141+
//> using toolkit typelevel:default
138142

139143
import cats.effect.*
140144
import fs2.io.file.Files

‎website/docs/reference/cli-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1543,7 +1543,7 @@ Copy compilation results to output directory using either relative or absolute p
15431543

15441544
Aliases: `--toolkit`
15451545

1546-
Add toolkit to classPath
1546+
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
15471547

15481548
### `--exclude`
15491549

‎website/docs/reference/directives.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -410,16 +410,16 @@ Set the test framework
410410

411411
### Toolkit
412412

413-
Use a toolkit as dependency
413+
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
414414

415415
`//> using toolkit` _version_
416416

417417
#### Examples
418418
`//> using toolkit 0.1.0`
419419

420-
`//> using toolkit latest`
420+
`//> using toolkit default`
421421

422-
`//> using test.toolkit latest`
422+
`//> using test.toolkit default`
423423

424424

425425
## target directives

‎website/docs/reference/scala-command/cli-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1044,7 +1044,7 @@ Aliases: `--toolkit`
10441044

10451045
`IMPLEMENTATION specific` per Scala Runner specification
10461046

1047-
Add toolkit to classPath
1047+
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
10481048

10491049
### `--exclude`
10501050

‎website/docs/reference/scala-command/directives.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -296,14 +296,14 @@ Set the test framework
296296

297297
### Toolkit
298298

299-
Use a toolkit as dependency
299+
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
300300

301301
`//> using toolkit` _version_
302302

303303
#### Examples
304304
`//> using toolkit 0.1.0`
305305

306-
`//> using toolkit latest`
306+
`//> using toolkit default`
307307

308-
`//> using test.toolkit latest`
308+
`//> using test.toolkit default`
309309

‎website/docs/reference/scala-command/runner-specification.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
584584

585585
**--with-toolkit**
586586

587-
Add toolkit to classPath
587+
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
588588

589589
Aliases: `--toolkit`
590590

@@ -1311,7 +1311,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
13111311

13121312
**--with-toolkit**
13131313

1314-
Add toolkit to classPath
1314+
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
13151315

13161316
Aliases: `--toolkit`
13171317

@@ -1864,7 +1864,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
18641864

18651865
**--with-toolkit**
18661866

1867-
Add toolkit to classPath
1867+
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
18681868

18691869
Aliases: `--toolkit`
18701870

@@ -2447,7 +2447,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
24472447

24482448
**--with-toolkit**
24492449

2450-
Add toolkit to classPath
2450+
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
24512451

24522452
Aliases: `--toolkit`
24532453

@@ -3039,7 +3039,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
30393039

30403040
**--with-toolkit**
30413041

3042-
Add toolkit to classPath
3042+
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
30433043

30443044
Aliases: `--toolkit`
30453045

@@ -3589,7 +3589,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
35893589

35903590
**--with-toolkit**
35913591

3592-
Add toolkit to classPath
3592+
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
35933593

35943594
Aliases: `--toolkit`
35953595

@@ -4214,7 +4214,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
42144214

42154215
**--with-toolkit**
42164216

4217-
Add toolkit to classPath
4217+
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
42184218

42194219
Aliases: `--toolkit`
42204220

@@ -4846,7 +4846,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
48464846

48474847
**--with-toolkit**
48484848

4849-
Add toolkit to classPath
4849+
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
48504850

48514851
Aliases: `--toolkit`
48524852

@@ -5733,7 +5733,7 @@ Aliases: `--help-fmt` ,`--scalafmt-help` ,`--fmt-help`
57335733

57345734
**--with-toolkit**
57355735

5736-
Add toolkit to classPath
5736+
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
57375737

57385738
Aliases: `--toolkit`
57395739

0 commit comments

Comments
 (0)