occasion

This program simply shows one (or many) messages when run during a configured timeframe. Useful to have in your status bar for example.

Demonstration

Installation

Currently, you can grab the latest release. You can also run cargo install occasion or cargo binstall occasion and it will be avaliable in your PATH.

Configuration

When you run occasion for the first time, a default config file is generated for you at CONFIG_DIR/occasions.json. The value of CONFIG_DIR depends on the OS (source):

Platform	Value	Example
Linux	`$XDG_CONFIG_HOME` or `$HOME/.config`	`/home/alice/.config`
macOS	`$HOME/Library/Application Support`	`/Users/Alice/Library/Application Support`
Windows	`{FOLDERID_RoamingAppData}`	`C:\Users\Alice\AppData\Roaming`

The config file is written in JSON, a schema is in the works (see #2)

in the meantime, this is all the possible values as of 0.1:

{
    "dates": [
        {
            "message": "", // String to print if the date matches time
            "time": [
                "day_of": {
                    // either "week" or "month"
                    "week": [] // List of weekdays, e.g "Mon", "Fri" or "Monday", "Friday"
                    "month": [] // List of days in the month, e.g. 1, 3, 31
                },
                "month": [], // List of month names, e.g "April", "June"
                "year": [] // List of year numbers, in AD. e.g. 2025, 2026
            ]
        },...
    ]
}

Usage

After configuring, simply run the command. If the current day matches any of the rules you set, that message you configured in the rule will show up.

You would probably want to use this in conjuction with another tool that can show outputs of commands, Like in your PS1/Starship, or in a widget program like ewww or conky.

For example, in Starship, you can define a custom block in your ~/.config/starship.toml:

[custom.occasion]
command = "occasion"
when = true
style = "fg:blue bg:black"
format = '[ $output ]($style)'

then, add it to your format:

format = """
.. snip ..
${custom.occasion}
.. snip ..
"""

You would get something like this. starship_result

Development

A Development environment can be set up automatically with devenv.

Otherwise, Install Rust 1.86.0 from https://rustup.rs, and cargo-tarpaulin for code coverage checking.

To run tests and generate a code coverage report, run devenv test -d (omit the -d flag if you wanna rebuild the environment everytime), or without devenv, run cargo tarpaulin --color always --skip-clean (or without --skip-clean to rebuild everything everytime).