Skip to content

Commit 5e2c6cd

Browse files
committed
updated site
1 parent 4daf81f commit 5e2c6cd

16 files changed

+55
-55
lines changed

2.x/docs/en/guide/sbt-components.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ <h1 class="menu-title">The Book of sbt</h1>
177177
<main>
178178
<h1 id="sbt-components"><a class="header" href="#sbt-components">sbt components</a></h1>
179179
<h2 id="sbt-runner"><a class="header" href="#sbt-runner">sbt runner</a></h2>
180-
<p>An sbt build is executed using the <code>sbt</code> runner, also called "sbt-the-shell-script" to distinguish from other components. Important thing to note is that sbt runner is designed to run <strong>any version</strong> of sbt.</p>
180+
<p>An sbt build is executed using the <code>sbt</code> runner, also called "sbt-the-shell-script" to distinguish from other components. It's important to note is that sbt runner is designed to run <strong>any version</strong> of sbt.</p>
181181
<h3 id="specifying-sbt-version-with-projectbuildproperties"><a class="header" href="#specifying-sbt-version-with-projectbuildproperties">Specifying sbt version with project/build.properties</a></h3>
182-
<p>The sbt runner executes a subcomponent called sbt launcher, which reads <code>project/build.properties</code> to determine the sbt version for the build, and downloads the artifacts if needed:</p>
182+
<p>The sbt runner executes a subcomponent called sbt launcher, which reads <code>project/build.properties</code> to determine the sbt version for the build, and downloads the artifacts if they haven't been cached:</p>
183183
<pre><code>sbt.version=2.0.0-alpha7
184184
</code></pre>
185185
<p>This means that:</p>
@@ -192,16 +192,16 @@ <h3 id="sbtn-sbt---client"><a class="header" href="#sbtn-sbt---client">sbtn (<co
192192
<h2 id="sbt-server"><a class="header" href="#sbt-server">sbt server</a></h2>
193193
<p>The sbt server is the actual build tool whose version is specified using <code>project/build.properties</code>. The sbt server acts as a cashier to take commands from sbtn and editors.</p>
194194
<h3 id="coursier"><a class="header" href="#coursier">Coursier</a></h3>
195-
<p>The sbt server runs <a href="https://get-coursier.io/">Couriser</a> as a subcomponent to resolve Scala libary, Scala compiler, and any other library dependencies your build needs.</p>
195+
<p>The sbt server runs <a href="https://get-coursier.io/">Couriser</a> as a subcomponent to resolve Scala library, Scala compiler, and any other library dependencies your build needs.</p>
196196
<h3 id="zinc"><a class="header" href="#zinc">Zinc</a></h3>
197197
<p>Zinc is the incremental compiler for Scala, developed and maintained by sbt project.
198-
An often overlooked aspect of Zinc is that Zinc provides a stable API to invoke <strong>any modern versions</strong> of Scala compiler. Combined with the fact that Coursier can resolve any Scala versions, by installing the sbt runner, you can invoke any modern versions of Scala just by writing a single line <code>build.sbt</code>:</p>
198+
An often overlooked aspect of Zinc is that Zinc provides a stable API to invoke <strong>any modern versions</strong> of Scala compiler. Combined with the fact that Coursier can resolve any Scala version, with sbt we can invoke any modern versions of Scala just by writing a single line <code>build.sbt</code>:</p>
199199
<pre><code class="language-scala">scalaVersion := "3.3.1"
200200
</code></pre>
201201
<h3 id="bsp-server"><a class="header" href="#bsp-server">BSP server</a></h3>
202202
<p>The sbt server supports <a href="https://build-server-protocol.github.io/">Build Server Protocol (BSP)</a> to list build targets, build them, etc.
203203
This allows IDEs like IntelliJ and Metals to communicate with a running sbt server programmatically.</p>
204-
<h2 id="connecting-with-sbt-server"><a class="header" href="#connecting-with-sbt-server">Connecting with sbt server</a></h2>
204+
<h2 id="connecting-to-sbt-server"><a class="header" href="#connecting-to-sbt-server">Connecting to sbt server</a></h2>
205205
<p>Let's look at three ways of connecting to the sbt server.</p>
206206
<h3 id="sbt-shell-using-sbtn"><a class="header" href="#sbt-shell-using-sbtn">sbt shell using sbtn</a></h3>
207207
<p>Run <code>sbt --client</code> in the working directory of your build:</p>

2.x/docs/en/guide/why-sbt-exists.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h1 class="menu-title">The Book of sbt</h1>
177177
<main>
178178
<h1 id="why-sbt-exists"><a class="header" href="#why-sbt-exists">Why sbt exists</a></h1>
179179
<h2 id="preliminaries"><a class="header" href="#preliminaries">Preliminaries</a></h2>
180-
<p>In Scala, a library or a executable programs used be compiled using the Scala compiler, <code>scalac</code>, or so it is documented in <a href="https://docs.scala-lang.org/scala3/book/taste-hello-world.html">Scala 3 Book</a> at first:</p>
180+
<p>In Scala, a library or a program is compiled using the Scala compiler, <code>scalac</code>, as documented in the <a href="https://docs.scala-lang.org/scala3/book/taste-hello-world.html">Scala 3 Book</a>:</p>
181181
<pre><code class="language-scala">@main def hello() = println("Hello, World!")
182182
</code></pre>
183183
<pre><code class="language-bash">$ scalac hello.scala
@@ -186,25 +186,25 @@ <h2 id="preliminaries"><a class="header" href="#preliminaries">Preliminaries</a>
186186
</code></pre>
187187
<p>This process gets tedious and slow if we were to invoke <code>scalac</code> directly since we'd have to pass all the Scala source file names.</p>
188188
<p>Furthermore, most non-trivial programs will likely have library dependencies, and will therefore also depend transitively on their dependencies.
189-
This is doubly compilicated for Scala ecosystem because we have Scala 2.12, 2.13 ecosystem, Scala 3.x ecosystem, JVM, JS, and Native platforms.</p>
190-
<p>Rather than working with JAR files and <code>scalac</code>, we can avoid the manual toil by introducing a higher-level subproject abstraction and by using a build tool.</p>
189+
This is doubly complicated for Scala ecosystem because we have Scala 2.12, 2.13 ecosystem, Scala 3.x ecosystem, JVM, JS, and Native platforms.</p>
190+
<p>Rather than working with JAR files and <code>scalac</code>, we can avoid manual toil by introducing a higher-level subproject abstraction and by using a build tool.</p>
191191
<h2 id="sbt"><a class="header" href="#sbt">sbt</a></h2>
192192
<p><em>sbt</em> is a simple build tool created for Scala and Java.
193193
It lets us declare subprojects and their various dependencies and custom tasks to ensure that we'll always get a fast, repeatable build.</p>
194194
<p>To accomplish this goal, sbt does several things:</p>
195195
<ul>
196196
<li>The version of sbt itself is tracked in <code>project/build.properties</code>.</li>
197-
<li>Defines a domain-specific language (DSL) called <strong>build.sbt DSL</strong> that can declare Scala version and other subproject information in <code>build.sbt</code>.</li>
197+
<li>Defines a domain-specific language (DSL) called <strong>build.sbt DSL</strong> that can declare the Scala version and other subproject information in <code>build.sbt</code>.</li>
198198
<li>Uses Coursier to fetch subprojects dependencies and their dependencies.</li>
199199
<li>Invokes Zinc to incrementally compile Scala and Java sources.</li>
200200
<li>Automatically runs tasks in parallel whenever possible.</li>
201201
<li>Defines conventions on how packages are published to Maven repositories to interoperate with the wider JVM ecosystem.</li>
202202
</ul>
203-
<p>To a large extent, sbt normalizes the commands needed to build a given program or library.</p>
203+
<p>To a large extent, sbt standardizes the commands needed to build a given program or library.</p>
204204
<h2 id="why-buildsbt-dsl"><a class="header" href="#why-buildsbt-dsl">Why build.sbt DSL?</a></h2>
205205
<p>build.sbt DSL makes sbt a unique build tool,
206206
as opposed to other tools that use configuration file formats like YAML, TOML, and XML.
207-
Originally developed around 2010 ~ 2013, <code>build.sbt</code> can start almost like a YAML file, declaring just <code>scalaVersion</code> and <code>libraryDependencies</code>,
207+
Originally developed beween 2010 and 2013, <code>build.sbt</code> can start almost like a YAML file, declaring just <code>scalaVersion</code> and <code>libraryDependencies</code>,
208208
but it can supports more features to keep the build definition organized as the build grows larger:</p>
209209
<ul>
210210
<li>To avoid repeating the same information, like the version number for a library, <code>build.sbt</code> can declare variables using <code>val</code>.</li>

2.x/docs/en/print.html

+11-11
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@ <h3 id="credits"><a class="header" href="#credits">Credits</a></h3>
612612
<p>It is <em>highly recommended</em> to read the Getting Started Guide!</p>
613613
<div style="break-before: page; page-break-before: always;"></div><h1 id="why-sbt-exists"><a class="header" href="#why-sbt-exists">Why sbt exists</a></h1>
614614
<h2 id="preliminaries"><a class="header" href="#preliminaries">Preliminaries</a></h2>
615-
<p>In Scala, a library or a executable programs used be compiled using the Scala compiler, <code>scalac</code>, or so it is documented in <a href="https://docs.scala-lang.org/scala3/book/taste-hello-world.html">Scala 3 Book</a> at first:</p>
615+
<p>In Scala, a library or a program is compiled using the Scala compiler, <code>scalac</code>, as documented in the <a href="https://docs.scala-lang.org/scala3/book/taste-hello-world.html">Scala 3 Book</a>:</p>
616616
<pre><code class="language-scala">@main def hello() = println("Hello, World!")
617617
</code></pre>
618618
<pre><code class="language-bash">$ scalac hello.scala
@@ -621,25 +621,25 @@ <h2 id="preliminaries"><a class="header" href="#preliminaries">Preliminaries</a>
621621
</code></pre>
622622
<p>This process gets tedious and slow if we were to invoke <code>scalac</code> directly since we'd have to pass all the Scala source file names.</p>
623623
<p>Furthermore, most non-trivial programs will likely have library dependencies, and will therefore also depend transitively on their dependencies.
624-
This is doubly compilicated for Scala ecosystem because we have Scala 2.12, 2.13 ecosystem, Scala 3.x ecosystem, JVM, JS, and Native platforms.</p>
625-
<p>Rather than working with JAR files and <code>scalac</code>, we can avoid the manual toil by introducing a higher-level subproject abstraction and by using a build tool.</p>
624+
This is doubly complicated for Scala ecosystem because we have Scala 2.12, 2.13 ecosystem, Scala 3.x ecosystem, JVM, JS, and Native platforms.</p>
625+
<p>Rather than working with JAR files and <code>scalac</code>, we can avoid manual toil by introducing a higher-level subproject abstraction and by using a build tool.</p>
626626
<h2 id="sbt"><a class="header" href="#sbt">sbt</a></h2>
627627
<p><em>sbt</em> is a simple build tool created for Scala and Java.
628628
It lets us declare subprojects and their various dependencies and custom tasks to ensure that we'll always get a fast, repeatable build.</p>
629629
<p>To accomplish this goal, sbt does several things:</p>
630630
<ul>
631631
<li>The version of sbt itself is tracked in <code>project/build.properties</code>.</li>
632-
<li>Defines a domain-specific language (DSL) called <strong>build.sbt DSL</strong> that can declare Scala version and other subproject information in <code>build.sbt</code>.</li>
632+
<li>Defines a domain-specific language (DSL) called <strong>build.sbt DSL</strong> that can declare the Scala version and other subproject information in <code>build.sbt</code>.</li>
633633
<li>Uses Coursier to fetch subprojects dependencies and their dependencies.</li>
634634
<li>Invokes Zinc to incrementally compile Scala and Java sources.</li>
635635
<li>Automatically runs tasks in parallel whenever possible.</li>
636636
<li>Defines conventions on how packages are published to Maven repositories to interoperate with the wider JVM ecosystem.</li>
637637
</ul>
638-
<p>To a large extent, sbt normalizes the commands needed to build a given program or library.</p>
638+
<p>To a large extent, sbt standardizes the commands needed to build a given program or library.</p>
639639
<h2 id="why-buildsbt-dsl"><a class="header" href="#why-buildsbt-dsl">Why build.sbt DSL?</a></h2>
640640
<p>build.sbt DSL makes sbt a unique build tool,
641641
as opposed to other tools that use configuration file formats like YAML, TOML, and XML.
642-
Originally developed around 2010 ~ 2013, <code>build.sbt</code> can start almost like a YAML file, declaring just <code>scalaVersion</code> and <code>libraryDependencies</code>,
642+
Originally developed beween 2010 and 2013, <code>build.sbt</code> can start almost like a YAML file, declaring just <code>scalaVersion</code> and <code>libraryDependencies</code>,
643643
but it can supports more features to keep the build definition organized as the build grows larger:</p>
644644
<ul>
645645
<li>To avoid repeating the same information, like the version number for a library, <code>build.sbt</code> can declare variables using <code>val</code>.</li>
@@ -739,9 +739,9 @@ <h3 id="giter8-templates"><a class="header" href="#giter8-templates">Giter8 temp
739739
<p><a href="https://github.com/foundweekends/giter8/wiki/giter8-templates">Giter8 wiki</a> lists over 100 templates that can jump start your new build.</p>
740740
<div style="break-before: page; page-break-before: always;"></div><h1 id="sbt-components"><a class="header" href="#sbt-components">sbt components</a></h1>
741741
<h2 id="sbt-runner"><a class="header" href="#sbt-runner">sbt runner</a></h2>
742-
<p>An sbt build is executed using the <code>sbt</code> runner, also called "sbt-the-shell-script" to distinguish from other components. Important thing to note is that sbt runner is designed to run <strong>any version</strong> of sbt.</p>
742+
<p>An sbt build is executed using the <code>sbt</code> runner, also called "sbt-the-shell-script" to distinguish from other components. It's important to note is that sbt runner is designed to run <strong>any version</strong> of sbt.</p>
743743
<h3 id="specifying-sbt-version-with-projectbuildproperties"><a class="header" href="#specifying-sbt-version-with-projectbuildproperties">Specifying sbt version with project/build.properties</a></h3>
744-
<p>The sbt runner executes a subcomponent called sbt launcher, which reads <code>project/build.properties</code> to determine the sbt version for the build, and downloads the artifacts if needed:</p>
744+
<p>The sbt runner executes a subcomponent called sbt launcher, which reads <code>project/build.properties</code> to determine the sbt version for the build, and downloads the artifacts if they haven't been cached:</p>
745745
<pre><code>sbt.version=2.0.0-alpha7
746746
</code></pre>
747747
<p>This means that:</p>
@@ -754,16 +754,16 @@ <h3 id="sbtn-sbt---client"><a class="header" href="#sbtn-sbt---client">sbtn (<co
754754
<h2 id="sbt-server"><a class="header" href="#sbt-server">sbt server</a></h2>
755755
<p>The sbt server is the actual build tool whose version is specified using <code>project/build.properties</code>. The sbt server acts as a cashier to take commands from sbtn and editors.</p>
756756
<h3 id="coursier"><a class="header" href="#coursier">Coursier</a></h3>
757-
<p>The sbt server runs <a href="https://get-coursier.io/">Couriser</a> as a subcomponent to resolve Scala libary, Scala compiler, and any other library dependencies your build needs.</p>
757+
<p>The sbt server runs <a href="https://get-coursier.io/">Couriser</a> as a subcomponent to resolve Scala library, Scala compiler, and any other library dependencies your build needs.</p>
758758
<h3 id="zinc"><a class="header" href="#zinc">Zinc</a></h3>
759759
<p>Zinc is the incremental compiler for Scala, developed and maintained by sbt project.
760-
An often overlooked aspect of Zinc is that Zinc provides a stable API to invoke <strong>any modern versions</strong> of Scala compiler. Combined with the fact that Coursier can resolve any Scala versions, by installing the sbt runner, you can invoke any modern versions of Scala just by writing a single line <code>build.sbt</code>:</p>
760+
An often overlooked aspect of Zinc is that Zinc provides a stable API to invoke <strong>any modern versions</strong> of Scala compiler. Combined with the fact that Coursier can resolve any Scala version, with sbt we can invoke any modern versions of Scala just by writing a single line <code>build.sbt</code>:</p>
761761
<pre><code class="language-scala">scalaVersion := "3.3.1"
762762
</code></pre>
763763
<h3 id="bsp-server"><a class="header" href="#bsp-server">BSP server</a></h3>
764764
<p>The sbt server supports <a href="https://build-server-protocol.github.io/">Build Server Protocol (BSP)</a> to list build targets, build them, etc.
765765
This allows IDEs like IntelliJ and Metals to communicate with a running sbt server programmatically.</p>
766-
<h2 id="connecting-with-sbt-server"><a class="header" href="#connecting-with-sbt-server">Connecting with sbt server</a></h2>
766+
<h2 id="connecting-to-sbt-server"><a class="header" href="#connecting-to-sbt-server">Connecting to sbt server</a></h2>
767767
<p>Let's look at three ways of connecting to the sbt server.</p>
768768
<h3 id="sbt-shell-using-sbtn"><a class="header" href="#sbt-shell-using-sbtn">sbt shell using sbtn</a></h3>
769769
<p>Run <code>sbt --client</code> in the working directory of your build:</p>

2.x/docs/en/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

2.x/docs/en/searchindex.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)