Skip to content

Back port of documentation changes to main #3616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gedochao merged 1 commit into from
Apr 4, 2025
Merged

Back port of documentation changes to main #3616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/CustomJar.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,19 @@ import scala.util.{Failure, Success, Try}
@DirectiveUsage(
"`//> using jar `_path_ | `//> using jars `_path1_ _path2_ …",
"""`//> using jar` _path_
|
|`//> using jars` _path1_ _path2_ …
|
|`//> using test.jar` _path_
|
|`//> using test.jars` _path1_ _path2_ …
|
|`//> using source.jar` _path_
|
|`//> using source.jars` _path1_ _path2_ …
|
|`//> using test.source.jar` _path_
|
|`//> using test.source.jars` _path1_ _path2_ …
|""".stripMargin
)
Expand Down
8 changes: 8 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/Dependency.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,27 @@ import scala.cli.commands.SpecificationLevel
@DirectiveUsage(
"//> using dep org:name:ver | //> using deps org:name:ver org2:name2:ver2",
"""`//> using dep` _org_`:`name`:`ver
|
|`//> using deps` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using dependencies` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using test.dep` _org_`:`name`:`ver
|
|`//> using test.deps` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using test.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using compileOnly.dep` _org_`:`name`:`ver
|
|`//> using compileOnly.deps` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using compileOnly.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using scalafix.dep` _org_`:`name`:`ver
|
|`//> using scalafix.deps` _org_`:`name`:`ver _org_`:`name`:`ver
|
|`//> using scalafix.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver
|""".stripMargin
)
Expand Down
2 changes: 2 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaProps.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ import scala.cli.commands.SpecificationLevel
@DirectiveUsage(
"//> using javaProp _key=val_",
"""`//> using javaProp` _key=value_
|
|`//> using javaProp` _key_
|
|`//> using test.javaProp` _key=value_
|
|`//> using test.javaProp` _key_
|""".stripMargin
)
Expand Down
2 changes: 2 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/JavacOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ import scala.cli.commands.SpecificationLevel
@DirectiveUsage(
"//> using javacOpt _options_",
"""`//> using javacOpt` _options_
|
|`//> using javacOptions` _options_
|
|`//> using test.javacOpt` _options_
|
|`//> using test.javacOptions` _options_
|""".stripMargin
)
Expand Down
1 change: 1 addition & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/Platform.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import scala.cli.commands.SpecificationLevel
@DirectiveUsage(
"//> using platform (jvm|scala-js|js|scala-native|native)+",
"""`//> using platform` (`jvm`|`scala-js`|`js`|`scala-native`|`native`)+
|
|`//> using platforms` (`jvm`|`scala-js`|`js`|`scala-native`|`native`)+
|""".stripMargin
)
Expand Down
3 changes: 3 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/Publish.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,15 @@ import scala.cli.commands.SpecificationLevel
|`//> using publish.license` value
|
|`//> using publish.vcs` value
|
|`//> using publish.scm` value
|
|`//> using publish.versionControl` value
|
|`//> using publish.description` value
|
|`//> using publish.developer` value
|
|`//> using publish.developers` value1 value2
|
|`//> using publish.scalaVersionSuffix` value
Expand Down
2 changes: 2 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/Resources.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ import scala.cli.commands.SpecificationLevel
|
|//> using resourceDirs _path1_ _path2_ …""".stripMargin,
"""`//> using resourceDir` _path_
|
|`//> using resourceDirs` _path1_ _path2_ …
|
|`//> using test.resourceDir` _path_
|
|`//> using test.resourceDirs` _path1_ _path2_ …
|
|""".stripMargin
Expand Down
8 changes: 8 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/ScalaJs.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,39 +37,47 @@ import scala.util.Try
|`//> using jsMode` _value_
|
|`//> using jsNoOpt` _true|false_
|
|`//> using jsNoOpt`
|
|`//> using jsModuleKind` _value_
|
|`//> using jsCheckIr` _true|false_
|
|`//> using jsCheckIr`
|
|`//> using jsEmitSourceMaps` _true|false_
|
|`//> using jsEmitSourceMaps`
|
|`//> using jsEsModuleImportMap` _value_
|
|`//> using jsSmallModuleForPackage` _value1_ _value2_ …
|
|`//> using jsDom` _true|false_
|
|`//> using jsDom`
|
|`//> using jsHeader` _value_
|
|`//> using jsAllowBigIntsForLongs` _true|false_
|
|`//> using jsAllowBigIntsForLongs`
|
|`//> using jsAvoidClasses` _true|false_
|
|`//> using jsAvoidClasses`
|
|`//> using jsAvoidLetsAndConsts` _true|false_
|
|`//> using jsAvoidLetsAndConsts`
|
|`//> using jsModuleSplitStyleStr` _value_
|
|`//> using jsEsVersionStr` _value_
|
|`//> using jsEmitWasm` _true|false_
|
|`//> using jsEmitWasm`
|""".stripMargin
)
Expand Down
3 changes: 3 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/ScalaNative.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,17 @@ import scala.cli.commands.SpecificationLevel
|`//> using nativeClang` _value_
|
|`//> using nativeClangPP` _value_
|
|`//> using nativeClangPp` _value_
|
|`//> using nativeEmbedResources` _true|false_
|
|`//> using nativeEmbedResources`
|
|`//> using nativeTarget` _application|library-dynamic|library-static_
|
|`//> using nativeMultithreading` _true|false_
|
|`//> using nativeMultithreading`
""".stripMargin.trim
)
Expand Down
6 changes: 6 additions & 0 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/ScalacOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,19 @@ import scala.cli.commands.SpecificationLevel
@DirectiveUsage(
"using option _option_ | using options _option1_ _option2_ …",
"""`//> using scalacOption` _option_
|
|`//> using option` _option_
|
|`//> using scalacOptions` _option1_ _option2_ …
|
|`//> using options` _option1_ _option2_ …
|
|`//> using test.scalacOption` _option_
|
|`//> using test.option` _option_
|
|`//> using test.scalacOptions` _option1_ _option2_ …
|
|`//> using test.options` _option1_ _option2_ …
|
|""".stripMargin
Expand Down
39 changes: 39 additions & 0 deletions website/docs/reference/directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,19 @@ Generate BuildInfo for project
Add Scala compiler options

`//> using scalacOption` _option_

`//> using option` _option_

`//> using scalacOptions` _option1_ _option2_ …

`//> using options` _option1_ _option2_ …

`//> using test.scalacOption` _option_

`//> using test.option` _option_

`//> using test.scalacOptions` _option1_ _option2_ …

`//> using test.options` _option1_ _option2_ …


Expand Down Expand Up @@ -81,15 +87,19 @@ Method used to compute the version for BuildInfo
Manually add JAR(s) to the class path

`//> using jar` _path_

`//> using jars` _path1_ _path2_ …

`//> using test.jar` _path_

`//> using test.jars` _path1_ _path2_ …

`//> using source.jar` _path_

`//> using source.jars` _path1_ _path2_ …

`//> using test.source.jar` _path_

`//> using test.source.jars` _path1_ _path2_ …


Expand Down Expand Up @@ -121,19 +131,27 @@ Manually add sources to the project. Does not support chaining, sources are adde
Add dependencies

`//> using dep` _org_`:`name`:`ver

`//> using deps` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using dependencies` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using test.dep` _org_`:`name`:`ver

`//> using test.deps` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using test.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using compileOnly.dep` _org_`:`name`:`ver

`//> using compileOnly.deps` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using compileOnly.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using scalafix.dep` _org_`:`name`:`ver

`//> using scalafix.deps` _org_`:`name`:`ver _org_`:`name`:`ver

`//> using scalafix.dependencies` _org_`:`name`:`ver _org_`:`name`:`ver


Expand Down Expand Up @@ -209,9 +227,11 @@ Add Java options which will be passed when running an application.
Add Java properties

`//> using javaProp` _key=value_

`//> using javaProp` _key_

`//> using test.javaProp` _key=value_

`//> using test.javaProp` _key_


Expand All @@ -225,9 +245,11 @@ Add Java properties
Add Javac options which will be passed when compiling sources.

`//> using javacOpt` _options_

`//> using javacOptions` _options_

`//> using test.javacOpt` _options_

`//> using test.javacOptions` _options_


Expand Down Expand Up @@ -304,6 +326,7 @@ Set parameters for packaging
Set the default platform to Scala.js or Scala Native

`//> using platform` (`jvm`|`scala-js`|`js`|`scala-native`|`native`)+

`//> using platforms` (`jvm`|`scala-js`|`js`|`scala-native`|`native`)+


Expand All @@ -329,12 +352,15 @@ Set parameters for publishing
`//> using publish.license` value

`//> using publish.vcs` value

`//> using publish.scm` value

`//> using publish.versionControl` value

`//> using publish.description` value

`//> using publish.developer` value

`//> using publish.developers` value1 value2

`//> using publish.scalaVersionSuffix` value
Expand Down Expand Up @@ -447,9 +473,11 @@ Accepts predefined repositories supported by Coursier (like `sonatype:snapshots`
Manually add a resource directory to the class path

`//> using resourceDir` _path_

`//> using resourceDirs` _path1_ _path2_ …

`//> using test.resourceDir` _path_

`//> using test.resourceDirs` _path1_ _path2_ …


Expand Down Expand Up @@ -478,14 +506,17 @@ Add Scala Native options
`//> using nativeClang` _value_

`//> using nativeClangPP` _value_

`//> using nativeClangPp` _value_

`//> using nativeEmbedResources` _true|false_

`//> using nativeEmbedResources`

`//> using nativeTarget` _application|library-dynamic|library-static_

`//> using nativeMultithreading` _true|false_

`//> using nativeMultithreading`

#### Examples
Expand Down Expand Up @@ -540,39 +571,47 @@ Add Scala.js options
`//> using jsMode` _value_

`//> using jsNoOpt` _true|false_

`//> using jsNoOpt`

`//> using jsModuleKind` _value_

`//> using jsCheckIr` _true|false_

`//> using jsCheckIr`

`//> using jsEmitSourceMaps` _true|false_

`//> using jsEmitSourceMaps`

`//> using jsEsModuleImportMap` _value_

`//> using jsSmallModuleForPackage` _value1_ _value2_ …

`//> using jsDom` _true|false_

`//> using jsDom`

`//> using jsHeader` _value_

`//> using jsAllowBigIntsForLongs` _true|false_

`//> using jsAllowBigIntsForLongs`

`//> using jsAvoidClasses` _true|false_

`//> using jsAvoidClasses`

`//> using jsAvoidLetsAndConsts` _true|false_

`//> using jsAvoidLetsAndConsts`

`//> using jsModuleSplitStyleStr` _value_

`//> using jsEsVersionStr` _value_

`//> using jsEmitWasm` _true|false_

`//> using jsEmitWasm`


Expand Down
Loading
Loading