Skip to content

Commit 0bab614

Browse files
committed
NIT fix readme formatting
1 parent b02382e commit 0bab614

File tree

1 file changed

+37
-14
lines changed

1 file changed

+37
-14
lines changed

README.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
21
# scala-cli
32

43
[![Build status](https://github.com/VirtusLab/scala-cli/workflows/CI/badge.svg)](https://github.com/VirtusLab/scala-ci/actions?query=workflow%3ACI)
54
[![Maven Central](https://img.shields.io/maven-central/v/org.virtuslab.scala-cli/cli_3.svg)](https://maven-badges.herokuapp.com/maven-central/org.virtuslab.scala-cli/cli_3)
65
[![Discord](https://img.shields.io/discord/632277896739946517.svg?label=&logo=discord&logoColor=ffffff&color=404244&labelColor=6A7EC2)](https://discord.gg/KzQdYkZZza)
76

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.
7+
Scala CLI is an experimental tool to run/compile/test Scala that aims at being a better `scala` command. It shares some
8+
similarities with build tools, but doesn't aim at supporting multi-module projects, nor to be extended via a task
9+
system.
910

1011
User-facing documentation can be found on our website: [scala-cli.virtuslab.org](https://scala-cli.virtuslab.org/).
1112

@@ -15,7 +16,8 @@ User-facing documentation can be found on our website: [scala-cli.virtuslab.org]
1516

1617
Building Scala CLI requires JVM 17 to work properly.
1718

18-
In theory, our build is able to download and install for its own needs JVM 17 on some OSes however it may not work in Intellij / Metals out of the box.
19+
In theory, our build is able to download and install for its own needs JVM 17 on some OSes however it may not work in
20+
Intellij / Metals out of the box.
1921

2022
The Scala CLI sources ship with Mill launchers, so that Mill itself doesn't need to be installed on your system.
2123

@@ -40,17 +42,20 @@ The Scala CLI sources ship with Mill launchers, so that Mill itself doesn't need
4042
```
4143

4244
Filter test suites with
45+
4346
```bash
4447
./mill integration.test.jvm 'scala.cli.integration.RunTestsDefault.*'
4548
./mill integration.test.jvm 'scala.cli.integration.RunTestsDefault.Multiple scripts'
4649
```
4750

4851
Pass the `--debug` option to debug integration tests:
52+
4953
```bash
5054
./mill integration.test.jvm 'scala.cli.integration.RunTestsDefault.*' --debug
5155
```
5256

5357
The debug option uses 5005 port by default. It is possible to change it as follows:
58+
5459
```bash
5560
./mill integration.test.jvm 'scala.cli.integration.RunTestsDefault.*' --debug:5006
5661
```
@@ -66,11 +71,13 @@ The debug option uses 5005 port by default. It is possible to change it as follo
6671
#### Generate native packages
6772

6873
Build native packagers:
74+
6975
* `deb` for linux
7076
* `msi` for windows
7177
* `dmg` and `pkg` for macOS
7278

7379
(generating native packager for specified format)
80+
7481
```bash
7582
./mill -i scala package ..arguments... --deb --output 'path.deb'
7683
./mill -i scala package ..arguments... --dmg --output 'path.dmg'
@@ -126,11 +133,14 @@ as binaries. In the latter case, Scala CLI downloads on-the-fly binaries from th
126133
repositories' GitHub release assets, and runs them as external processes.
127134

128135
For example, here are a few external projects used by Scala CLI:
129-
- [scala-js-cli-native-image](https://github.com/scala-cli/scala-js-cli-native-image): provides a binary running the Scala.js linker
130-
- [scala-cli-signing](https://github.com/scala-cli/scala-cli-signing): provides both libraries and binaries to handle PGP concerns in Scala CLI
136+
137+
- [scala-js-cli-native-image](https://github.com/scala-cli/scala-js-cli-native-image): provides a binary running the
138+
Scala.js linker
139+
- [scala-cli-signing](https://github.com/scala-cli/scala-cli-signing): provides both libraries and binaries to handle
140+
PGP concerns in Scala CLI
131141
- [libsodiumjni](https://github.com/scala-cli/libsodiumjni): provides minimal JNI bindings for
132-
[libsodium](https://github.com/jedisct1/libsodium), that is used by Scala CLI to encrypt secrets
133-
uploaded as GitHub repository secrets in the `publish setup` sub-command
142+
[libsodium](https://github.com/jedisct1/libsodium), that is used by Scala CLI to encrypt secrets
143+
uploaded as GitHub repository secrets in the `publish setup` sub-command
134144

135145
For the full list of those projects and their description, see the
136146
[scala-cli repository list](https://github.com/orgs/scala-cli/repositories) and the READMEs
@@ -142,7 +152,8 @@ generate these binaries on the GitHub-provided GitHub actions hosts).
142152

143153
### Website
144154

145-
The Scala CLI website is built with [Docusaurus](https://v1.docusaurus.io/en/) and uses [Infima](https://infima.dev/docs/layout/spacing) for styling.
155+
The Scala CLI website is built with [Docusaurus](https://v1.docusaurus.io/en/) and
156+
uses [Infima](https://infima.dev/docs/layout/spacing) for styling.
146157

147158
Ensure you are using Node >= 16.14.2.
148159

@@ -165,19 +176,22 @@ yarn run start
165176

166177
### Verifying the documentation
167178

168-
We have a built-in tool to validate `.md` files called [Sclicheck](/sclicheck/Readme.md).
179+
We have a built-in tool to validate `.md` files called [Sclicheck](/sclicheck/Readme.md).
169180
All `Sclicheck` tests can be run with `Mill` + `munit`: (and this is what we run on the CI, too)
181+
170182
```bash
171183
./mill -i docs-tests.test
172184
```
173185

174186
The former also includes testing gifs and `Sclicheck` itself.
175187
To just check the documents, run:
188+
176189
```bash
177190
./mill -i docs-tests.test 'sclicheck.DocTests.*'
178191
```
179192

180193
You can also check all root docs, commands, reference docs, guides or cookbooks:
194+
181195
```bash
182196
./mill -i docs-tests.test 'sclicheck.DocTests.root*'
183197
./mill -i docs-tests.test 'sclicheck.DocTests.guide*'
@@ -187,28 +201,37 @@ You can also check all root docs, commands, reference docs, guides or cookbooks:
187201
```
188202

189203
Similarly, you can check single files:
204+
190205
```bash
191206
./mill -i docs-tests.test 'sclicheck.DocTests.<category> <doc-name>'
192207
```
208+
193209
For example, to run the check on `compile.md`
210+
194211
```bash
195212
./mill -i docs-tests.test 'sclicheck.DocTests.command compile'
196213
```
197214

198215
## Scala CLI logos
199216

200-
Package with various logos for scala-cli can be found on [google drive](https://drive.google.com/drive/u/1/folders/1M6JeQXmO4DTBeRBKAFJ5HH2p_hbfQnqS)
217+
Package with various logos for scala-cli can be found
218+
on [google drive](https://drive.google.com/drive/u/1/folders/1M6JeQXmO4DTBeRBKAFJ5HH2p_hbfQnqS)
201219

202220
## Launcher script
203221

204-
There is a script `scala-cli-src` in the repository root that is intended to work exactly like released scala-cli, but using a binary compiled the worktree.
222+
There is a script `scala-cli-src` in the repository root that is intended to work exactly like released scala-cli, but
223+
using a binary compiled the worktree.
205224
Just add it to your PATH to get the already-released-scala-cli experience.
206225

207226
## Releases
208227

209-
Instructions on how to release - [Release Procedure](https://github.com/VirtusLab/scala-cli/blob/main/.github/release/release-procedure.md)
210-
228+
Instructions on how to
229+
release - [Release Procedure](https://github.com/VirtusLab/scala-cli/blob/main/.github/release/release-procedure.md)
211230

212231
## Debugging BSP server
213232

214-
The easiest way to debug BSP sever is using `scala-cli-src` script with `--bsp-debug-port 5050` flag (the port should be unique to the workspace where BSP will be debugged). In such case BSP will be launched using local source and will run on JVM. It will also expects a debugger running in the listen mode using provided port (so the initialization of the connection can be debugged). In such case we recommend to have option to auto rerun debugging session off (so there is always a debugger instance ready to be used).
233+
The easiest way to debug BSP sever is using `scala-cli-src` script with `--bsp-debug-port 5050` flag (the port should be
234+
unique to the workspace where BSP will be debugged). In such case BSP will be launched using local source and will run
235+
on JVM. It will also expects a debugger running in the listen mode using provided port (so the initialization of the
236+
connection can be debugged). In such case we recommend to have option to auto rerun debugging session off (so there is
237+
always a debugger instance ready to be used).

0 commit comments

Comments
 (0)