You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# LiquidJava VS Code Extension
2
2
3
-
The **LiquidJava VS Code extension** adds support for **refinement types**, extending the Java standard type system directly inside VS Code, using the [LiquidJava](https://github.com/CatarinaGamboa/liquidjava) verifier. It provides error diagnostics and syntax highlighting for refinements.
3
+
The **LiquidJava VS Code extension** adds support for **refinement types**, extending the Java standard type system directly inside VS Code, using the [LiquidJava](https://github.com/liquid-java/liquidjava) verifier. It provides error diagnostics and syntax highlighting for refinements.
4
4
5
5
## Getting Started
6
6
@@ -14,7 +14,7 @@ To try out the extension on an example project without setting up your local env
14
14
15
15
The codespace will open in your browser and automatically install the LiquidJava extension shortly.
16
16
17
-
[](https://codespaces.new/CatarinaGamboa/liquidjava-examples)
17
+
[](https://codespaces.new/liquid-java/liquidjava-examples)
### Extend your Java code with Liquid Types and catch bugs earlier!
6
6
@@ -15,7 +15,7 @@ a = -8; // type error!
15
15
### Installation
16
16
17
17
This extension depends on the [Language Support for Java(TM) by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) VS Code extension.
18
-
Additionally, to use LiquidJava in your project, you'll need the following dependency, which includes the LiquidJava API annotations:
18
+
Additionally, to use LiquidJava in your project, you'll need the following dependency, which includes the LiquidJava annotations:
19
19
20
20
#### Maven
21
21
```xml
@@ -45,7 +45,7 @@ Liquid types, or refinement types, extend a language with **logical predicates**
45
45
46
46
#### Refinements
47
47
48
-
To refine a variable, parameter or return value, use the annotation `@Refinement` with a predicate as argument. The predicate must be a boolean expression that uses the name of the variable being refined (or `_`) to refer to its value. Some examples include:
48
+
To refine a variable, parameter or return value, use the `@Refinement`annotation with a predicate as an argument. The predicate must be a boolean expression that uses the name of the variable being refined (or `_`) to refer to its value. Some examples include:
49
49
50
50
```java
51
51
// x must be greater than 0
@@ -137,8 +137,10 @@ s.pop(); // type error!
137
137
138
138
```
139
139
140
-
You can find more examples of how to use LiquidJava on the [LiquidJava Website](https://catarinagamboa.github.io/liquidjava.html). For more information, check the following repositories:
141
-
-[liquidjava](https://github.com/CatarinaGamboa/liquidjava): Main repository with API, verifier and some examples
142
-
-[vscode-liquidjava](https://github.com/CatarinaGamboa/vscode-liquidjava): Source code of this VS Code extension
143
-
-[liquidjava-examples](https://github.com/CatarinaGamboa/liquidjava-examples): Repository with more usage examples of LiquidJava
144
-
-[liquid-java-external-libs](https://github.com/CatarinaGamboa/liquid-java-external-libs): Examples of how to use LiquidJava with external libraries
140
+
You can find more examples of how to use LiquidJava on the [LiquidJava Website](https://liquid-java.github.io). To learn how to use LiquidJava, you can also follow the [LiquidJava tutorial](https://github.com/liquid-java/liquidjava-tutorial).
141
+
142
+
For more information, check the following repositories:
143
+
-[liquidjava](https://github.com/liquid-java/liquidjava): Includes the API, verifier and some examples
144
+
-[vscode-liquidjava](https://github.com/liquid-java/vscode-liquidjava): Source code of this VS Code extension
145
+
-[liquidjava-examples](https://github.com/liquid-java/liquidjava-examples): Examples of how to use LiquidJava
146
+
-[liquid-java-external-libs](https://github.com/liquid-java/liquid-java-external-libs): Examples of how to use LiquidJava to refine external libraries
0 commit comments