occasion 0.2.0

Shows one (or many) messages when run during a configured timeframe. Useful to have in your status bar for example.
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
113
114
115
116
117
118
119
120
121
122

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/itscrystalline/occasion/refs/heads/main/occasions.schema.json",
  "title": "The occasion configuration file.",
  "type": "object",
  "required": [
    "dates"
  ],
  "properties": {
    "dates": {
      "description": "A pair of a date pattern to match, and a message to show once the current date at runtime matches the date pattern.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "description": "The message to show when the configured date pattern matches.",
            "type": "string"
          },
          "time": {
            "description": "The date pattern to match.",
            "type": "object",
            "properties": {
              "day_of": {
                "description": "The day to match. Can be *either* a day of the week *or* a day of the month. Leaving this empty means it will match for every day.",
                "properties": {
                  "week": {
                    "description": "The day of the week this pattern will match. Accepts either the full day name, like 'Tuesday', or a shortened form, like 'Tue'. Case-insensitive.",
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "uniqueItems": true
                  },
                  "month": {
                    "description": "The day of the month this pattern will match. Accepts a number from 1-31.",
                    "type": "array",
                    "items": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 31
                    },
                    "uniqueItems": true
                  }
                },
                "oneOf": [
                  {
                    "required": [
                      "week"
                    ],
                    "not": {
                      "required": [
                        "month"
                      ]
                    }
                  },
                  {
                    "required": [
                      "month"
                    ],
                    "not": {
                      "required": [
                        "week"
                      ]
                    }
                  }
                ]
              },
              "month": {
                "description": "The month to match. Accepts the full month name, like 'April', or a shortened name, like 'Apr'. Case-insensitive.",
                "type": "array",
                "items": {
                  "type": "string",
                  "uniqueItems": true
                }
              },
              "year": {
                "description": "The year (in your system's default locale's year format, usually AD) to match. Accepts a positive number.",
                "type": "array",
                "items": {
                  "type": "number",
                  "minimum": 0
                }
              }
            }
          }
        }
      }
    },
    "multiple_behavior": {
      "description": "This option describes what `occasion` should do when multiple configured dates match. Possible options are:\n  - `first`, which shows only the first (highest) configured message\n  - `last`, which shows only the last (lowest) configured message\n  - `random`, which shows a random message\n - `all`, which is an object with a key `seperator` which configures the seperator between the messages.",
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "first",
            "last",
            "random"
          ]
        },
        {
          "type": "object",
          "properties": {
            "all": {
              "type": "object",
              "properties": {
                "seperator": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "required": [
            "all"
          ],
          "additionalProperties": false
        }
      ]
    }
  }
}