# Track

Gathers your `TODOS`, `NOTES` and `CONTINUE` from your project and displays them in a table.  
If you follow a certain syntax, you can also use author names and priority:

```
// TODO(<author name>, <priority as number>): <Your comment>

// TODO(Peter, 5): Foo Bar
//                 Second line of todo

# ToDo(Peter, -10): Foo Bar

/* Note(Peter): Fooo

        A note with
    different

                    formatting */

-- TODO this todo style is still possible
```


![image](example.png)


## Comment Styles

Currently it supports following comment tokens:
```
#
//
///
/* */
--
```

## Limitations
Since I don't wanted to create a big regex pattern, there are some caveats:  

- Only Linux support. But send me a patch or more information what didn't work on Microslop Windows
- Keywords (todo, note, continue) must be two newlines apart, otherwise they bleed into each other


## Example
Inside `test/example.jai` are a few examples you can view.  

You can run them with:
```
jai build.jai - run silent :: test/example.jai
```

## Build
```
$ jai -version
Version: beta 0.2.024, built on 31 December 2025.
```

Release build:
```
jai build.jai - release
```

You can find the binary in `bin/track`.


## Dev

### Sub Modules
Init submodules
```bash
git submodule update --init --recursive
```

#### Update Submodule
```bash
cd third-party/<module>
git pull origin main
cd ../..
git add third-party/<module>
git commit -m "Updated <module> submodule"
```

#### Add Submodule
```bash
git submodule add <repository-url> third-party/<module>
git submodule update --init --recursive
git add third-party/<module>
git commit -m "Added <module> submodule"
```