Skip to content
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

Jump to bottom

Fix using directive docs #1901

Merged
merged 2 commits into from Mar 3, 2023
Merged

Fix using directive docs #1901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
233328d
Remove unsupported kebab-case from test framework directive
lwronski Mar 2, 2023
3ba4b3c
Fix invalid examples of using directive in guide
lwronski Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/directives/src/main/scala/scala/build/preprocessing/directives/Tests.scala
View file
Open in desktop
Expand Up @@ -9,8 +9,8 @@ import scala.cli.commands.SpecificationLevel
@DirectiveGroupName("Test framework")
@DirectiveExamples("//> using testFramework \"utest.runner.Framework\"")
@DirectiveUsage(
"using testFramework _class_name_ | using `test-framework` _class_name_",
"`//> using testFramework `_class_name_ | ``//> using `test-framework` ``_class_name_"
"using testFramework _class_name_",
"`//> using testFramework ` _class_name_"
)
@DirectiveDescription("Set the test framework")
@DirectiveLevel(SpecificationLevel.SHOULD)
Expand Down
8 changes: 4 additions & 4 deletions website/docs/guides/using-directives.md
View file
Open in desktop
Expand Up @@ -112,10 +112,10 @@ Below is a list of the most important `using` directives that Scala CLI supports
- `//> using dep "org::name:version"` - defines dependency to a given library [more in dedicated guide](/docs/guides/dependencies.md)
- `//> using dep "org:name:version"` - defines dependency to a given **java** library, note the `:` instead of `::`
- `//> using dep "org::name:version,url=url"` - defines dependency to a given library with a fallback to its jar url
- `//> using resourceDir "<dir>"` - marks directory as source of resources. Resources accessible at runtime and packaged together with compiled code.
- ``//> using `java-opt` "<opt>"`` - use given java options when running application or tests
- `//> using target ["test"|"main"]` used to marked or unmarked given source as test
- ``//> using `test-framework` <framework> `` - select test framework to use
- `//> using resourceDir "dir"` - marks directory as source of resources. Resources accessible at runtime and packaged together with compiled code.
- `//> using javaOpt "opt"` - use given java options when running application or tests
- `//> using target.scope "test"` used to marked or unmarked given source as test
- `//> using testFramework "framework"` - select test framework to use

There are several reasons that we believe `using` directives are a good solution:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/directives.md
View file
Open in desktop
Expand Up @@ -311,7 +311,7 @@ Add Scala.js options

Set the test framework

`//> using testFramework `_class_name_ | ``//> using `test-framework` ``_class_name_
`//> using testFramework ` _class_name_

#### Examples
`//> using testFramework "utest.runner.Framework"`
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/scala-command/directives.md
View file
Open in desktop
Expand Up @@ -241,7 +241,7 @@ Add Scala.js options

Set the test framework

`//> using testFramework `_class_name_ | ``//> using `test-framework` ``_class_name_
`//> using testFramework ` _class_name_

#### Examples
`//> using testFramework "utest.runner.Framework"`
Expand Down