Merge pull request #226 from romanowski/docs/update

Docs/update

Author: romanowski

README.md

@@ -6,6 +6,8 @@
 
 Scala CLI is an experimental tool to run/compile/test Scala that aims at being a better `scala` command. It shares some similarities with build tools, but doesn't aim at supporting multi-module projects, nor to be extended via a task system.
 
+User-facing documentation can be found on our website: [scala-cli.virtuslab.org](https://scala-cli.virtuslab.org/).
+
 ## Developer docs
 
 ### Requirements

build.sc

@@ -261,6 +261,11 @@ class Build(val crossScalaVersion: String)
     def runClasspath = T {
       super.runClasspath() ++ Seq(localRepoJar())
     }
+
+    // uncomment below to debug tests in attach mode on 5005 port
+    // def forkArgs = T {
+    //   super.forkArgs() ++ Seq("-agentlib:jdwp=transport=dt_socket,server=n,address=localhost:5005,suspend=y")
+    // }
   }
 }
 

docs

@@ -1,5 +1,5 @@
 // using scala 3.0.2
-// using com.lihaoyi::os-lib:0.7.8
+// using lib com.lihaoyi::os-lib:0.7.8
 
 import scala.util.matching.Regex
 

docs_checker/check.scala

@@ -5,4 +5,6 @@
 
 # Cookbook
 
-This part contains a set of recipes how to use scala-cli within given situations.
+This part contains a set of recipes how to use scala-cli within given situations. The cookbooks are intended to provide a solution to task at hand without providing too many details. 
+
+For more in-depth analysis please check out provided [Guides](../guides/ide.md)

examples/index/README.md

@@ -76,7 +76,7 @@ All the features from non-scripts are working with Scala Scripts, such as waitin
 
 ### Package
 
-Run `package` to the Scala CLI to package your script to Leighweight JAR file.
+Run `package` to the Scala CLI to package your script to lightweight executable JAR file.
 
 ```bash
 scala-cli package HelloScript.sc

examples/scala-scripts/README.md

@@ -12,7 +12,7 @@ print all files located in path passed as the first argument
 Create a file name `ls.sc`
 ```scala
 #!/usr/bin/env scala-cli
-using "com.lihaoyi::os-lib:0.7.8"
+// using lib "com.lihaoyi::os-lib:0.7.8"
 val cwd = if(args.nonEmpty) os.Path(args(0), os.pwd) else os.pwd
 println(os.list(cwd).map(_.last).mkString("\n"))
 ```

examples/scripting/README.md

@@ -9,7 +9,7 @@ SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
 if [[ -z "${ASCIINEMA_REC}" ]]; then
   # Warm up scala-cli
   echo "println(1)" | scala-cli -
-  echo "// using \"org.scalameta::munit:0.7.29\"" | scala-cli test -
+  echo "// using lib \"org.scalameta::munit:0.7.29\"" | scala-cli test -
   # or do other preparation (e.g. create code)
 else
   . $SCRIPT_DIR/../demo-magic.sh
@@ -34,7 +34,7 @@ EOF
   clear
 
   cat <<EOF | updateFile demo.test.scala
-// using "org.scalameta::munit:0.7.29"
+// using lib "org.scalameta::munit:0.7.29"
 
 class demoTest extends munit.FunSuite {
   test("test nice args") {

gifs/scenarios/demo.sh

@@ -65,6 +65,18 @@ final case class CrossSources(
 
 object CrossSources {
 
+  private def withinTestSubDirectory(p: ScopePath, inputs: Inputs): Boolean =
+    p.root.exists { path =>
+      val fullPath = path / p.path
+      inputs.elements.exists {
+        case Inputs.Directory(path) =>
+          // Is this file subdirectory of given dir and if we have a subdiretory 'test' on the way
+          fullPath.startsWith(path) &&
+            fullPath.relativeTo(path).segments.contains("test")
+        case _ => false
+      }
+    }
+
   def forInputs(
     inputs: Inputs,
     preprocessors: Seq[Preprocessor]
@@ -88,11 +100,23 @@ object CrossSources {
 
     val scopedRequirements       = preprocessedSources.flatMap(_.scopedRequirements)
     val scopedRequirementsByRoot = scopedRequirements.groupBy(_.path.root)
-    def baseReqs(path: ScopePath): BuildRequirements =
-      scopedRequirementsByRoot
-        .getOrElse(path.root, Nil)
-        .flatMap(_.valueFor(path).toSeq)
-        .foldLeft(BuildRequirements())(_ orElse _)
+    def baseReqs(path: ScopePath): BuildRequirements = {
+      val fromDirectives =
+        scopedRequirementsByRoot
+          .getOrElse(path.root, Nil)
+          .flatMap(_.valueFor(path).toSeq)
+          .foldLeft(BuildRequirements())(_ orElse _)
+
+      // Scala-cli treats all `.test.scala` files tests as well as
+      // files from witin `test` subdirectory from provided input directories
+      // If file has `using target <scope>` directive this take precendeces.
+      if (
+        fromDirectives.scope.isEmpty &&
+        (path.path.last.endsWith(".test.scala") || withinTestSubDirectory(path, inputs))
+      )
+        fromDirectives.copy(scope = Some(BuildRequirements.ScopeRequirement(Scope.Test)))
+      else fromDirectives
+    }
 
     val buildOptions = for {
       s   <- preprocessedSources