Skip to content

Commit b76d5e0

Browse files
committed
NIT Refactor of IDE cookbooks
- fixed formatting - fixed minor typos & grammar
1 parent 1513249 commit b76d5e0

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

website/docs/cookbooks/intellij-sbt-with-bsp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Now, let's say that at some point you decide you need to occasionally run some s
8181
those scripts with Scala CLI and decide it'd be convenient to keep them in the same repository.
8282

8383
<ChainedSnippets>
84-
```bash
84+
```bash ignore
8585
tree scripts
8686
```
8787

website/docs/cookbooks/intellij.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Also, please do note, that the project structure comes directly from Scala CLI a
100100
it from IntelliJ. Instead, being a CLI tool, we have a terminal-first policy, and so, if you want to update the project
101101
structure to include an extra directory, just run the proper command to update the `.bsp` directory.
102102

103-
```bash
103+
```bash ignore
104104
scala-cli setup-ide . ../extra-directory
105105
```
106106

website/docs/cookbooks/vscode.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Setup Scala CLI project in VSCode
2+
title: Setup a Scala CLI project in VSCode
33
sidebar_position: 7
44
---
55

66
Scala CLI can generate the files that are necessary for providing IDE support in Visual Studio Code.
77

8-
For example, here is a simple project in scala-cli which contains only one main and test class.
8+
For example, here is a simple project in scala-cli which contains only one main and one test class.
99

1010
```scala title=HelloWorld.scala
1111
@main
@@ -23,13 +23,14 @@ class MyTests extends munit.FunSuite {
2323
}
2424
```
2525

26-
The following command generates configurations files for VSCode support:
26+
The following command generates configuration files for VSCode support:
2727

2828
```bash
2929
scala-cli setup-ide .
3030
```
3131

32-
There is also another way. The first time you run the `run`|`compile`|`test` commands, the configuration files for the VSCode will be also generated.
32+
There is also another way. The first time you run the `run`|`compile`|`test` commands, the configuration files for the
33+
VSCode will be also generated.
3334

3435
```bash
3536
scala-cli run .
@@ -42,7 +43,8 @@ and then, we launch Visual Studio Code
4243
code .
4344
```
4445

45-
After starting metals, you will see `run/debug` buttons in `HelloWorld.scala` and `test/debug` in `MyTests.test.scala` (assuming the following directory layout).
46+
After starting metals, you will see the `run/debug` buttons in `HelloWorld.scala` and `test/debug` in `MyTests.test.scala` (
47+
assuming the following directory layout).
4648

4749
![layout](/img/source_layout.png)
4850

@@ -56,4 +58,4 @@ And the similar effect after pressing the `test` button.
5658

5759
import VSCodeTest from '@site/static/img/vscode-test.png';
5860

59-
<img src={VSCodeTest} />
61+
<img src={VSCodeTest} />

0 commit comments

Comments
 (0)