2024-02-29 18:53:59 +01:00
|
|
|
## What is this?
|
|
|
|
|
This document describes the relationships between the different "modules" of ZigBrains.
|
|
|
|
|
|
|
|
|
|
These relationships are strictly enforced, and modules that do not directly (or indirectly) depend on another
|
|
|
|
|
module cannot access their classes.
|
|
|
|
|
|
|
|
|
|
The primary purpose of this strictly enforced module system is to avoid code compatible with open source IDEs (IDEA/PyCharm Community)
|
|
|
|
|
from depending on code that only works on proprietary IDEs (IDEA Ultimate/CLion/...).
|
|
|
|
|
|
|
|
|
|
NOTE: These "modules" are in no way related to the module system introduced in Java 9. They're just called the same.
|
|
|
|
|
|
|
|
|
|
The suffix after the module name signifies which IDE it depends on.
|
|
|
|
|
|
|
|
|
|
- IC: IDEA Community
|
|
|
|
|
- CL: CLion
|
|
|
|
|
- EXT: External maven library
|
|
|
|
|
|
|
|
|
|
IC modules MUST NOT depend on CL modules, as this violates the restrictions set forth above.
|
|
|
|
|
|
|
|
|
|
## Modules
|
|
|
|
|
|
|
|
|
|
### Common (IC)
|
|
|
|
|
|
2024-03-12 11:24:32 +01:00
|
|
|
### LSP-Common (IC)
|
2024-02-29 18:53:59 +01:00
|
|
|
- LSP4J (EXT)
|
2024-03-12 11:24:32 +01:00
|
|
|
|
|
|
|
|
### LSP (IC)
|
2024-02-29 18:53:59 +01:00
|
|
|
- Apache Commons Lang 3 (EXT)
|
2024-03-12 11:24:32 +01:00
|
|
|
- Common (IC)
|
|
|
|
|
- LSP-Common (IC)
|
2024-02-29 18:53:59 +01:00
|
|
|
|
|
|
|
|
### Zig (IC)
|
|
|
|
|
- Grammarkit (EXT)
|
|
|
|
|
- Common (IC)
|
|
|
|
|
- LSP (IC)
|
|
|
|
|
|
|
|
|
|
### Project (IC)
|
|
|
|
|
- Common (IC)
|
|
|
|
|
- Zig (IC)
|
|
|
|
|
|
|
|
|
|
### Zon (IC)
|
|
|
|
|
- Grammarkit (EXT)
|
|
|
|
|
- Common (IC)
|
|
|
|
|
|
2024-03-12 11:24:32 +01:00
|
|
|
### Debugger (IU/CL)
|
|
|
|
|
- Common (IC)
|
|
|
|
|
- LSP-Common (IC)
|
2024-02-29 18:53:59 +01:00
|
|
|
- Zig (IC)
|
|
|
|
|
- Project (IC)
|
