Skip to content

Commit ea23025

Browse files
committed
bump version to v1.12
1 parent 4febee7 commit ea23025

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ produce an executable jar-file, run the following command:
2727
mvn package
2828
```
2929

30-
This will produce `target/Litterbox-1.11.full.jar`
30+
This will produce `target/Litterbox-1.12.full.jar`
3131

3232

3333
## Using LitterBox
3434

3535
To see an overview of the command line options available in LitterBox type:
3636

3737
```bash
38-
java -jar Litterbox-1.11.full.jar --help
38+
java -jar Litterbox-1.12.full.jar --help
3939
```
4040

4141
### Basic usage
@@ -44,7 +44,7 @@ LitterBox parses the JSON file of a Scratch project, which contains
4444
its source code. Given such a JSON file, LitterBox is invoked as follows:
4545

4646
```bash
47-
java -jar Litterbox-1.11.full.jar check --path <path/to/project.json>
47+
java -jar Litterbox-1.12.full.jar check --path <path/to/project.json>
4848
```
4949

5050
As a result, LitterBox will report any occurrences of bug patterns or
@@ -57,7 +57,7 @@ If you want to check a specific project given its ID (which you can
5757
find in the URL of the project), you can use the following command:
5858

5959
```bash
60-
java -jar Litterbox-1.11.full.jar check --project-id <project-id> --path <path/to/store/downloaded/project>
60+
java -jar Litterbox-1.12.full.jar check --project-id <project-id> --path <path/to/store/downloaded/project>
6161
```
6262

6363
When invoked this way, LitterBox will retrieve the JSON file
@@ -73,7 +73,7 @@ project IDs to check in a text file (one project ID per line) and
7373
invoke LitterBox as follows:
7474

7575
```bash
76-
java -jar Litterbox-1.11.full.jar check --project-list <path/to/projectidlist.txt> --path <path/to/projects>
76+
java -jar Litterbox-1.12.full.jar check --project-list <path/to/projectidlist.txt> --path <path/to/projects>
7777
```
7878

7979
LitterBox will check the given path for the projects.
@@ -90,7 +90,7 @@ filename specified in order to decide whether to produce CSV or JSON
9090
output:
9191

9292
```bash
93-
java -jar Litterbox-1.11.full.jar check --path <path/to/project.json> --output <result.csv>
93+
java -jar Litterbox-1.12.full.jar check --path <path/to/project.json> --output <result.csv>
9494
```
9595

9696
The CSV file will contain a high-level summary of the number of
@@ -102,7 +102,7 @@ analyzed Scratch-project, where all occurrences of bug patterns are
102102
highlighted with comments.
103103

104104
```bash
105-
java -jar Litterbox-1.11.full.jar check --path <path/to/project.json> --annotate <results/>
105+
java -jar Litterbox-1.12.full.jar check --path <path/to/project.json> --annotate <results/>
106106
```
107107

108108

@@ -118,7 +118,7 @@ comma-separated list of bug patterns, e.g.:
118118

119119

120120
```bash
121-
java -jar Litterbox-1.11.full.jar \
121+
java -jar Litterbox-1.12.full.jar \
122122
check \
123123
--path <path/to/project.json> \
124124
--detectors endless_recursion,call_without_definition
@@ -127,7 +127,7 @@ java -jar Litterbox-1.11.full.jar \
127127
A full list of available bug checkers can be retrieved using:
128128

129129
```bash
130-
java -jar Litterbox-1.11.full.jar --help
130+
java -jar Litterbox-1.12.full.jar --help
131131
```
132132

133133
To select all bug patterns, you can also use the term `bugs` in the
@@ -139,7 +139,7 @@ list; to select all code smell checks use `smells`.
139139
The bug patterns can be reported per scripts and procedures instead of for the whole program. In this case, only the bug patterns that can be detected through intra-scripts and intra-procedures analysis are considered.
140140

141141
```bash
142-
java -jar Litterbox-1.11.full.jar check \
142+
java -jar Litterbox-1.12.full.jar check \
143143
--path <path/to/project.json> \
144144
--output <result.csv> \
145145
--detectors script-bugs \
@@ -164,7 +164,7 @@ LitterBox can produce statistics on code metrics of a project (e.g.,
164164
number of blocks, number of sprites, weighted method count):
165165

166166
```bash
167-
java -jar Litterbox-1.11.full.jar \
167+
java -jar Litterbox-1.12.full.jar \
168168
stats \
169169
--path <path/to/project.json> \
170170
--output <statsfile.csv>
@@ -176,7 +176,7 @@ java -jar Litterbox-1.11.full.jar \
176176
LitterBox can generate a Graphviz `.dot` file representing various graphs of the project, such as the Abstract Syntax Tree (AST) or Control Flow Graph (CFG).
177177

178178
```bash
179-
java -jar Litterbox-1.11.full.jar dot --path <path/to/project.json> --output <output.dot> [--graph <GraphType>]
179+
java -jar Litterbox-1.12.full.jar dot --path <path/to/project.json> --output <output.dot> [--graph <GraphType>]
180180
```
181181

182182
Available graph types:
@@ -195,7 +195,7 @@ Available graph types:
195195
LitterBox provides a dedicated `mine` command for bulk downloading of Scratch projects. This is useful for creating datasets.
196196

197197
```bash
198-
java -jar Litterbox-1.11.full.jar mine --output <path/to/output/dir> [options]
198+
java -jar Litterbox-1.12.full.jar mine --output <path/to/output/dir> [options]
199199
```
200200

201201
Available options:
@@ -220,7 +220,7 @@ Scratch user CodeClubRik.
220220
Since version 1.7 Litterbox can automatically refactor a given Scratch project to improve its readability:
221221

222222
```bash
223-
java -jar Litterbox-1.11.full.jar \
223+
java -jar Litterbox-1.12.full.jar \
224224
refactoring \
225225
--path <path/to/project.json> \
226226
--output <path/to/output-dir>
@@ -236,7 +236,7 @@ LitterBox can automatically inject known bug patterns into Scratch projects. Thi
236236
creating test datasets or for studying bug fixes:
237237

238238
```bash
239-
java -jar Litterbox-1.11.full.jar inject \
239+
java -jar Litterbox-1.12.full.jar inject \
240240
--path <path/to/project.sb3> \
241241
--output <path/to/output-dir>
242242
```
@@ -255,7 +255,7 @@ For each bug pattern that can be injected, LitterBox creates a separate output f
255255
LitterBox can compare two versions of a project to identify which bugs were fixed, which are new, and which persist:
256256

257257
```bash
258-
java -jar Litterbox-1.11.full.jar diff \
258+
java -jar Litterbox-1.12.full.jar diff \
259259
--before <old_version> \
260260
--after <new_version>
261261
```
@@ -277,24 +277,24 @@ Options:
277277
Example comparing with a prior analysis report:
278278

279279
```bash
280-
java -jar Litterbox-1.11.full.jar diff \
280+
java -jar Litterbox-1.12.full.jar diff \
281281
--before prior_report.json \
282282
--after fixed_project.sb3 \
283283
--output diff_report.json
284284
```
285285

286286
### LLM Interaction
287287

288-
Since version 1.11 LitterBox allows you to ask an LLM about a Scratch program and makes it possible to automatically integrate LLM-provided issue fixes into the program.
288+
Since version 1.12 LitterBox allows you to ask an LLM about a Scratch program and makes it possible to automatically integrate LLM-provided issue fixes into the program.
289289
You can find all features under the `llm` subcommand:
290290
```bash
291-
java -jar Litterbox-1.11.full.jar llm --help
291+
java -jar Litterbox-1.12.full.jar llm --help
292292
```
293293

294294
It supports either the OpenAI API, or a self-hosted Ollama instance.
295295
To provide an OpenAI API key, start LitterBox like
296296
```bash
297-
java -Dlitterbox.llm.openai.api-key=KEY Litterbox-1.11.full.jar llm …
297+
java -Dlitterbox.llm.openai.api-key=KEY Litterbox-1.12.full.jar llm …
298298
```
299299
You can find other configuration options that can be passed via `-D` flags (e.g., model choice, Ollama API endpoint) in `src/main/resources/scratchllm.properties`.
300300

@@ -312,7 +312,7 @@ For our integration of some of the LLM-features into the Scratch browser interfa
312312
To see an overview of the available command line options, type:
313313

314314
```bash
315-
java -jar Litterbox-1.11.full.jar embedded-kittens --help
315+
java -jar Litterbox-1.12.full.jar embedded-kittens --help
316316
```
317317

318318
All the subcommands also accept the `--help` flag to show information about the specific parameters.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>de.uni_passau.fim.se2</groupId>
88
<artifactId>Litterbox</artifactId>
9-
<version>1.12-SNAPSHOT</version>
9+
<version>1.12</version>
1010

1111
<repositories>
1212
<repository>

src/main/java/de/uni_passau/fim/se2/litterbox/Main.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
@CommandLine.Command(
4242
name = "LitterBox",
4343
mixinStandardHelpOptions = true,
44-
version = "LitterBox 1.12-SNAPSHOT",
44+
version = "LitterBox 1.12",
4545
subcommands = {
4646
// general commands
4747
Main.CheckProgramsSubcommand.class,

0 commit comments

Comments
 (0)