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: docs/tools/code-extension.mdx
+22-22Lines changed: 22 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: VS Code Extension
3
3
description: Visual Studio Code Extension for Lingua Franca.
4
4
---
5
5
6
-
The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-directed editing capability, compilation, diagram synthesis and a project explorer for Lingua Franca programs.
6
+
The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-directed editing capability, compilation, diagram synthesis and a packages explorer for Lingua Franca programs.
7
7
8
8
## Usage
9
9
@@ -23,9 +23,9 @@ Overall, we encourage you to open your project in VS Code using the following st
│ │ ├── lfc_include/ # Directory for storing reusable reactors
28
-
│ │ │ ├── lingo_library/
28
+
│ │ │ ├── installed_library/
29
29
│ ├── include/
30
30
│ ├── src/
31
31
│ │ ├── lib/ # Directory for storing reusable reactors
@@ -47,41 +47,41 @@ To compile the `.lf` source, open the command palette (<kbd>Ctrl</kbd> + <kbd>Sh
47
47
You can also build and immediately afterwards run your code by opening the command palette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and then entering `Lingua Franca: Build and Run`.
48
48
Running the code can also be done from the VS Code terminal by executing the generated file in `./bin`.
49
49
50
-
### Project Explorer
50
+
### Packages Explorer
51
51
52
-
The **Lingua Franca Project Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Project Explorer** displays a **Tree View** with the following structure:
52
+
The **Lingua Franca Packages Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Packages Explorer** displays a **Tree View** with the following structure:
53
53
54
54
```shell
55
55
├── LF Project
56
-
│ ├── Lingo Packages
56
+
│ ├── Installed Packages
57
57
│ ├── Local Libraries
58
58
└── └── Source Files
59
59
```
60
60
61
-
-**Lingo Packages**: Lists libraries installed via the Lingo Package Manager, located in the `build/lfc_include` directory (if any).
61
+
-[**Installed Packages**](#installed-packages): Lists libraries installed via the Lingo Package Manager, located in the `build/lfc_include` directory (if any).
62
62
63
-
-**Local Libraries**: Displays locally defined libraries (e.g., reusable reactors), located in the `src/lib` directory.
63
+
-[**Local Libraries**](#local-libraries): Displays locally defined libraries (e.g., reusable reactors), located in the `src/lib` directory.
64
64
65
-
-**Source Files**: Contains the LF source files created by the developer, located in the `src` directory.
65
+
-[**Source Files**](#source-files): Contains the LF source files created by the developer, located in the `src` directory.
66
66
67
-
The **Source Files** section is always present as it reflects the main LF files in the project. However, the **Lingo Packages** and **Local Libraries** sections appear only if the respective directories and files exist in the workspace.
67
+
The **Source Files** section is always present as it reflects the main LF files in the project. However, the **Installed Packages** and **Local Libraries** sections appear only if the respective directories and files exist in the workspace.
68
68
69
69
Hovering over the **LF Project** item reveals a terminal icon. Clicking this icon opens a terminal window at the project's root directory, allowing you to execute commands directly within that directory.
70
70
71
-
#### Lingo Packages
71
+
#### Installed Packages
72
72
73
-
The **Lingo Packages** section lists libraries installed using the [Lingo Package Manager](https://github.com/lf-lang/lingo). Developers can use the Lingo Package Manager to retrieve and install LF programs from repositories such as the [Lingua Franca Community Organization](https://github.com/LF-Community).
73
+
The **Installed Packages** section lists libraries installed using the [Lingo Package Manager](https://github.com/lf-lang/lingo). Developers can use the Lingo Package Manager to retrieve and install LF programs from repositories such as the [Lingua Franca Community Organization](https://github.com/LF-Community).
74
74
75
75
To install libraries:
76
76
1. Configure the `Lingo.toml` file with the desired libraries.
77
77
2. Run `lingo build` to download the specified dependencies.
78
78
79
-
Once the libraries are installed, they will appear in the `{project_name}/build/lfc_include/` directory. The **Lingo Packages** section will then be structured as follows:
79
+
Once the libraries are installed, they will appear in the `{project_name}/build/lfc_include/` directory. The **Installed Packages** section will then be structured as follows:
80
80
81
81
```shell
82
82
├── LF Project
83
-
│ ├── Lingo Packages
84
-
│ │ ├── lingo_library/
83
+
│ ├── Installed Packages
84
+
│ │ ├── installed_library/
85
85
│ │ │ ├── File_1.lf
86
86
│ │ │ │ ├── Rusable_Reactor_1.lf
87
87
│ │ │ │ ├── Rusable_Reactor_2.lf
@@ -93,19 +93,19 @@ Once the libraries are installed, they will appear in the `{project_name}/build/
93
93
94
94
In this structure:
95
95
-**LF Project**: Represents the root folder of the main project.
96
-
-**lingo_library**: Represents each library listed in `Lingo.toml`, which contains one or more LF programs featuring reusable reactors.
96
+
-**installed_library**: Represents each library listed in `Lingo.toml`, which contains one or more LF programs featuring reusable reactors.
97
97
98
-
The image below shows a visual representation of the **Lingo Packages** section. The **project** icon indicates the LF Project folder (e.g., `AudioClassification`), while the **root-folder** icon represents the downloaded libraries (e.g., the `edgeai` library in the example). The **code file** icon denotes an LF program within a library, and the **bracket** icon represents individual reactors inside the LF program.
98
+
The image below shows a visual representation of the **Installed Packages** section. The **project** icon indicates the LF Project folder (e.g., `AudioClassification`), while the **root-folder** icon represents the downloaded libraries (e.g., the `edgeai` library in the example). The **code file** icon denotes an LF program within a library, and the **bracket** icon represents individual reactors inside the LF program.
The hierarchy categorizes tree items into the following types:
103
103
104
104
1.**`library-root`**: Refers to the root folder of each downloaded library.
105
105
2.**`file`**: Represents an LF program within the library.
106
106
3.**`reactor`**: Refers to individual reactors within the LF program.
107
107
108
-
When focusing on the **Lingo Packages** section, an `edit` command becomes available. Clicking it opens the `Lingo.toml` file in the editor for configuration changes. The following actions are available for items in the **Lingo Packages** section:
108
+
When focusing on the **Installed Packages** section, an `edit` command becomes available. Clicking it opens the `Lingo.toml` file in the editor for configuration changes. The following actions are available for items in the **Installed Packages** section:
109
109
110
110
- For **file** items (from right to left):
111
111
-**Open in Split View**: Opens the file in a split editor view.
@@ -137,14 +137,14 @@ The **Local Libraries** section lists LF programs created by the developer, loca
137
137
138
138
The image below illustrates the **Local Libraries** section. In this depiction, the **"project"** icon represents the LF project folder, while the **"code file"** icon represents the LF program, and the **"bracket"** icon denotes individual reactors within the LF program.
0 commit comments