Skip to content

Commit bcd4033

Browse files
GedochaoGedochao
committed
Add missing reference docs for Scala.js options' directives
1 parent bee68ef commit bcd4033

File tree

3 files changed

+114
-12
lines changed

3 files changed

+114
-12
lines changed

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

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,29 @@ import scala.build.EitherCps.{either, value}
66
import scala.build.Ops.EitherOptOps
77
import scala.build.directives.*
88
import scala.build.errors.BuildException
9+
import scala.build.internal.Constants
910
import scala.build.options.{BuildOptions, ScalaJsMode, ScalaJsOptions}
1011
import scala.build.{Positioned, options}
1112
import scala.cli.commands.SpecificationLevel
1213
import scala.util.Try
1314

1415
@DirectiveGroupName("Scala.js options")
16+
@DirectiveExamples(s"//> using jsVersion ${Constants.scalaJsVersion}")
17+
@DirectiveExamples("//> using jsMode mode")
18+
@DirectiveExamples("//> using jsNoOpt")
1519
@DirectiveExamples("//> using jsModuleKind common")
20+
@DirectiveExamples("//> using jsCheckIr")
21+
@DirectiveExamples("//> using jsEmitSourceMaps")
22+
@DirectiveExamples("//> using jsEsModuleImportMap importmap.json")
23+
@DirectiveExamples("//> using jsSmallModuleForPackage test")
24+
@DirectiveExamples("//> using jsDom")
25+
@DirectiveExamples("//> using jsHeader \"#!/usr/bin/env node\n\"")
26+
@DirectiveExamples("//> using jsAllowBigIntsForLongs")
27+
@DirectiveExamples("//> using jsAvoidClasses")
28+
@DirectiveExamples("//> using jsAvoidLetsAndConsts")
29+
@DirectiveExamples("//> using jsModuleSplitStyleStr smallestmodules")
30+
@DirectiveExamples("//> using jsEsVersionStr es2017")
31+
@DirectiveExamples("//> using jsEmitWasm")
1632
@DirectiveUsage(
1733
"//> using jsVersion|jsMode|jsModuleKind|… _value_",
1834
"""
@@ -21,32 +37,40 @@ import scala.util.Try
2137
|`//> using jsMode` _value_
2238
|
2339
|`//> using jsNoOpt` _true|false_
40+
|`//> using jsNoOpt`
2441
|
2542
|`//> using jsModuleKind` _value_
2643
|
27-
|`//> using jsSmallModuleForPackage` _value1_ _value2_ …
28-
|
2944
|`//> using jsCheckIr` _true|false_
45+
|`//> using jsCheckIr`
3046
|
3147
|`//> using jsEmitSourceMaps` _true|false_
48+
|`//> using jsEmitSourceMaps`
49+
|
50+
|`//> using jsEsModuleImportMap` _value_
51+
|
52+
|`//> using jsSmallModuleForPackage` _value1_ _value2_ …
3253
|
3354
|`//> using jsDom` _true|false_
55+
|`//> using jsDom`
3456
|
3557
|`//> using jsHeader` _value_
3658
|
3759
|`//> using jsAllowBigIntsForLongs` _true|false_
60+
|`//> using jsAllowBigIntsForLongs`
3861
|
3962
|`//> using jsAvoidClasses` _true|false_
63+
|`//> using jsAvoidClasses`
4064
|
4165
|`//> using jsAvoidLetsAndConsts` _true|false_
66+
|`//> using jsAvoidLetsAndConsts`
4267
|
4368
|`//> using jsModuleSplitStyleStr` _value_
4469
|
4570
|`//> using jsEsVersionStr` _value_
4671
|
4772
|`//> using jsEmitWasm` _true|false_
48-
|
49-
|`//> using jsEsModuleImportMap` _value_
73+
|`//> using jsEmitWasm`
5074
|""".stripMargin
5175
)
5276
@DirectiveDescription("Add Scala.js options")

‎website/docs/reference/directives.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -507,37 +507,76 @@ Add Scala.js options
507507
`//> using jsMode` _value_
508508

509509
`//> using jsNoOpt` _true|false_
510+
`//> using jsNoOpt`
510511

511512
`//> using jsModuleKind` _value_
512513

513-
`//> using jsSmallModuleForPackage` _value1_ _value2_ …
514-
515514
`//> using jsCheckIr` _true|false_
515+
`//> using jsCheckIr`
516516

517517
`//> using jsEmitSourceMaps` _true|false_
518+
`//> using jsEmitSourceMaps`
519+
520+
`//> using jsEsModuleImportMap` _value_
521+
522+
`//> using jsSmallModuleForPackage` _value1_ _value2_ …
518523

519524
`//> using jsDom` _true|false_
525+
`//> using jsDom`
520526

521527
`//> using jsHeader` _value_
522528

523529
`//> using jsAllowBigIntsForLongs` _true|false_
530+
`//> using jsAllowBigIntsForLongs`
524531

525532
`//> using jsAvoidClasses` _true|false_
533+
`//> using jsAvoidClasses`
526534

527535
`//> using jsAvoidLetsAndConsts` _true|false_
536+
`//> using jsAvoidLetsAndConsts`
528537

529538
`//> using jsModuleSplitStyleStr` _value_
530539

531540
`//> using jsEsVersionStr` _value_
532541

533542
`//> using jsEmitWasm` _true|false_
534-
535-
`//> using jsEsModuleImportMap` _value_
543+
`//> using jsEmitWasm`
536544

537545

538546
#### Examples
547+
`//> using jsVersion 1.18.2`
548+
549+
`//> using jsMode mode`
550+
551+
`//> using jsNoOpt`
552+
539553
`//> using jsModuleKind common`
540554

555+
`//> using jsCheckIr`
556+
557+
`//> using jsEmitSourceMaps`
558+
559+
`//> using jsEsModuleImportMap importmap.json`
560+
561+
`//> using jsSmallModuleForPackage test`
562+
563+
`//> using jsDom`
564+
565+
`//> using jsHeader "#!/usr/bin/env node
566+
"`
567+
568+
`//> using jsAllowBigIntsForLongs`
569+
570+
`//> using jsAvoidClasses`
571+
572+
`//> using jsAvoidLetsAndConsts`
573+
574+
`//> using jsModuleSplitStyleStr smallestmodules`
575+
576+
`//> using jsEsVersionStr es2017`
577+
578+
`//> using jsEmitWasm`
579+
541580
### Test framework
542581

543582
Set the test framework

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

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -315,37 +315,76 @@ Add Scala.js options
315315
`//> using jsMode` _value_
316316

317317
`//> using jsNoOpt` _true|false_
318+
`//> using jsNoOpt`
318319

319320
`//> using jsModuleKind` _value_
320321

321-
`//> using jsSmallModuleForPackage` _value1_ _value2_ …
322-
323322
`//> using jsCheckIr` _true|false_
323+
`//> using jsCheckIr`
324324

325325
`//> using jsEmitSourceMaps` _true|false_
326+
`//> using jsEmitSourceMaps`
327+
328+
`//> using jsEsModuleImportMap` _value_
329+
330+
`//> using jsSmallModuleForPackage` _value1_ _value2_ …
326331

327332
`//> using jsDom` _true|false_
333+
`//> using jsDom`
328334

329335
`//> using jsHeader` _value_
330336

331337
`//> using jsAllowBigIntsForLongs` _true|false_
338+
`//> using jsAllowBigIntsForLongs`
332339

333340
`//> using jsAvoidClasses` _true|false_
341+
`//> using jsAvoidClasses`
334342

335343
`//> using jsAvoidLetsAndConsts` _true|false_
344+
`//> using jsAvoidLetsAndConsts`
336345

337346
`//> using jsModuleSplitStyleStr` _value_
338347

339348
`//> using jsEsVersionStr` _value_
340349

341350
`//> using jsEmitWasm` _true|false_
342-
343-
`//> using jsEsModuleImportMap` _value_
351+
`//> using jsEmitWasm`
344352

345353

346354
#### Examples
355+
`//> using jsVersion 1.18.2`
356+
357+
`//> using jsMode mode`
358+
359+
`//> using jsNoOpt`
360+
347361
`//> using jsModuleKind common`
348362

363+
`//> using jsCheckIr`
364+
365+
`//> using jsEmitSourceMaps`
366+
367+
`//> using jsEsModuleImportMap importmap.json`
368+
369+
`//> using jsSmallModuleForPackage test`
370+
371+
`//> using jsDom`
372+
373+
`//> using jsHeader "#!/usr/bin/env node
374+
"`
375+
376+
`//> using jsAllowBigIntsForLongs`
377+
378+
`//> using jsAvoidClasses`
379+
380+
`//> using jsAvoidLetsAndConsts`
381+
382+
`//> using jsModuleSplitStyleStr smallestmodules`
383+
384+
`//> using jsEsVersionStr es2017`
385+
386+
`//> using jsEmitWasm`
387+
349388
### Test framework
350389

351390
Set the test framework

0 commit comments

Comments
 (0)