code0-definition-reader 0.0.11

The rust crate for reading the internal Code0-Definitions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

# Definitions
This repository contains all definitions for Code0. These definitions will be used to create a Flow. It also contains a CLI tool for managing definitions and a reader for reading all definitions.

## Definition CLI

### Setup
First download cargo to use the cli.
[Install Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)

Then run:
```bash
cargo install code0-cli
```

After the cli compiled succesfully you can use it via:
```bash
code0-cli
```

### Usage
(Stay inside the root directory when running the command)

#### Download
Will download the latest Definitions from the Code0 Definition Repository.

If no feature is specified, all features will be downloaded. If a feature is specified, only that feature will be kept & can be loaded by one of the following languages: TypeScript, Rust.

-f (--features) is a list of features that will be downloaded.
-t (--tag) is the version tag of the release you want to select.

```bash
code0-cli download
code0-cli download -t def-0.0.8
code0-cli download -f feature_1 feature_2 feature_3
code0-cli download -t def-0.0.8 -f feature_1 feature_2 feature_3
```

#### General Report
Will create a report of all errors in the definitions.

```bash
code0-cli report
code0-cli report -p /path/to/definitions
```

#### Feature Report
Will create a report of all errors in the definitions for a specific feature. Will also report on all specified functions, data types, and flow types.

```bash
code0-cli feature
code0-cli feature -p /path/to/definitions
code0-cli feature -f feature_name
code0-cli feature -f feature_name -p /path/to/definitions
```

#### Watch for Changes
Will run the report each time a definition file changes.

```bash
code0-cli watch
code0-cli watch -p /path/to/definitions
```

#### Definition
Will search for a specific definition.

```bash
code0-cli definition -n definition_name
code0-cli definition -n definition_name -p /path/to/definitions
```

## TypeScript Definition Package

### Install Package
```bash
npm i @code0-tech/code0-definition-reader --save-dev
```

### Usage

```ts
const features = Definition("./path/to/definitions")

for (const feature in features) {
    const name = feature.name; //name of the feature (e.g. http)
    const dataTypes = fearture.dataTypes; //dataTypes of this feature
    const flowTypes = fearture.flowTypes; //flowTypes of this feature
    const functions = fearture.runtimeFunctions; //runtimeFunctions of this feature
}
```

## Rust Definition Package

### Install Package
```bash
cargo add code0-definition-reader
```

### Usage

```rs
use code0_definition_reader::Definition;

let features = Definition::new("./path/to/definitions");

for feature in features {
    let name = feature.name(); //name of the feature (e.g. rest)
    let data_types = feature.data_types(); //dataTypes of this feature
    let flow_types = feature.flow_types(); //flowTypes of this feature
    let functions = feature.runtime_functions(); //runtimeFunctions of this feature
}
```