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
+45-4Lines changed: 45 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# Definitions
2
+
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.
2
3
3
4
## Definition CLI
4
5
@@ -7,27 +8,46 @@
7
8
8
9
### Usage
9
10
(Stay inside the root directory when running the command)
10
-
### General Report
11
+
12
+
#### Download
13
+
Will download the latest Definitions from the Code0 Definition Repository.
14
+
15
+
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.
16
+
17
+
```bash
18
+
./cargo run download
19
+
./cargo run download -f feature_1 feature_2 feature_3
20
+
```
21
+
22
+
#### General Report
23
+
Will create a report of all errors in the definitions.
24
+
11
25
```bash
12
26
./cargo run report
13
27
./cargo run report -p /path/to/definitions
14
28
```
15
29
16
-
### Feature Report
30
+
#### Feature Report
31
+
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.
32
+
17
33
```bash
18
34
./cargo run feature
19
35
./cargo run feature -p /path/to/definitions
20
36
./cargo run feature -f feature_name
21
37
./cargo run feature -f feature_name -p /path/to/definitions
22
38
```
23
39
24
-
### Watch for Changes
40
+
#### Watch for Changes
41
+
Will run the report each time a definition file changes.
42
+
25
43
```bash
26
44
./cargo run watch
27
45
./cargo run watch -p /path/to/definitions
28
46
```
29
47
30
-
### Definition
48
+
#### Definition
49
+
Will search for a specific definition.
50
+
31
51
```bash
32
52
./cargo run definition -n definition_name
33
53
./cargo run definition -n definition_name -p /path/to/definitions
@@ -53,3 +73,24 @@ for (const feature in features) {
0 commit comments