Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aexol/treelang
Graph tree mini language for creating translatable structures
https://github.com/aexol/treelang
Last synced: about 1 month ago
JSON representation
Graph tree mini language for creating translatable structures
- Host: GitHub
- URL: https://github.com/aexol/treelang
- Owner: aexol
- Created: 2020-06-09T11:35:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-27T21:19:09.000Z (over 3 years ago)
- Last Synced: 2024-11-22T12:07:35.943Z (about 2 months ago)
- Language: TypeScript
- Size: 105 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TreeLang
:smile: Let's welcome new serialisation format. The only role of the format is to hold the structure without data and types.
If you think graph, there are no arrays there there are only nodes and connections.
Deserialisation is up to you also
## Why?
World is moving towards graph sourced systems.
## Example
So assume we have a file `model.treelang` with the following contnent:
Structure
```
{
Pizzas{
Margerita{
price{
8
}
}
Capriciosa{
price{
10
}
}
}
Ingredients{
Tomatoe{
price{
2
}
}
Dough{
price{
5
}
}
Cheese{
price{
3
}
}
Ham{
price{
3
}
}
}
}
```
That's `34` bytes
### Deserialization
So this graph code could be deserialized as using pseudocode
```
code = Treelang.parse("model.treelang")(`
Pizzas
`)
```
```json
{
"Pizzas": {
"Margheita": {
//...Margherita content
},
"Capriciosa": {
// ...Capriciosa content
}
}
}
```
To define the same structure in json it takes `59` bytes. Of course you can deserialise it in other way this is just an example.
As we can see the size of that .graph file differs from .json file and its only 67% of size
### Real world usage - Tests
```
Webpage{
Pages{
Home{
menuButton
heading1
heading2
testimonials{
Jerry
John
Patricia
}
}
About{
menuButton
Team{
Jennifer
Eve
Tom
Robert
}
}
Contact{
menuButton
form{
email
message
send
}
}
}
}
```
Now using some testing framework I can bind exact string values to my elements and click them without writting this creepy structure:
```json
{
"Webpage": {
"Pages": {
"Home": {
"menuButton": "menuButton",
"heading1": "heading1",
"heading2": "heading2",
"testimonials": {
"Jerry": "Jerry",
"John": "John",
"Patricia": "Patricia"
}
},
"About": {
"menuButton": "menuButton",
"Team": {
"Jennifer": "Jennifer",
"Eve": "Eve",
"Tom": "Tom",
"Robert": "Robert"
}
},
"Contact": {
"menuButton": "menuButton",
"form": {
"email": "email",
"message": "message",
"send": "send"
}
}
}
}
}
```
### Import files
index.treelang
```
Webpage{
Main{
*menu
}
}
```
menu.treelang
```
about
home
```
#### Import index
index.treelang
```
Webpage{
Main{
*menu
}
}
```
menu/index.treelang
```
about
home
*burger
```
menu/burger.treelang
```
cars
planes
motorcycles
```