index : track

        

            
            
        
        
0# Track
1
2Gathers your `TODOS`, `NOTES` and `CONTINUE` from your project and displays them in a table.  
3If you follow a certain syntax, you can also use author names and priority:
4
5```
6// TODO(<author name>, <priority as number>): <Your comment>
7
8// TODO(Peter, 5): Foo Bar
9//                 Second line of todo
10
11# ToDo(Peter, -10): Foo Bar
12
13/* Note(Peter): Fooo
14
15        A note with
16    different
17
18                    formatting */
19
20-- TODO this todo style is still possible
21```
22
23
24![image](example.png)
25
26
27## Comment Styles
28
29Currently it supports following comment tokens:
30```
31#
32//
33///
34/* */
35--
36```
37
38## Limitations
39Since I don't wanted to create a big regex pattern, there are some caveats:  
40
41- Only Linux support. But send me a patch or more information what didn't work on Microslop Windows
42- Keywords (todo, note, continue) must be two newlines apart, otherwise they bleed into each other
43
44
45## Example
46Inside `test/example.jai` are a few examples you can view.  
47
48You can run them with:
49```
50jai build.jai - run silent :: test/example.jai
51```
52
53## Build
54```
55$ jai -version
56Version: beta 0.2.024, built on 31 December 2025.
57```
58
59Release build:
60```
61jai build.jai - release
62```
63
64You can find the binary in `bin/track`.
65
66
67## Dev
68
69### Sub Modules
70Init submodules
71```bash
72git submodule update --init --recursive
73```
74
75#### Update Submodule
76```bash
77cd third-party/<module>
78git pull origin main
79cd ../..
80git add third-party/<module>
81git commit -m "Updated <module> submodule"
82```
83
84#### Add Submodule
85```bash
86git submodule add <repository-url> third-party/<module>
87git submodule update --init --recursive
88git add third-party/<module>
89git commit -m "Added <module> submodule"
90```
91
92