obs-scheduler 0.0.2 → 0.1.1

package/README.md

@@ -1,5 +1,8 @@
 # obs-scheduler
 
+![NPM Version](https://img.shields.io/npm/v/obs-scheduler?color=%23302E31)
+![Static Badge](https://img.shields.io/badge/OBS-302E31?logo=obsstudio)
+
 A CLI for scheduling actions in OBS.
 
 ## Install
@@ -37,7 +40,8 @@ Options:
     {
       "name": "Example Event 2",
       "schedule_type": "recurring",
-      "schedule": "* * * * * *",
+      // At 14:15 (2:15pm) on each first day of the month.
+      "schedule": "15 14 1 * *",
       "action": "start_recording"
     }
   ]

package/cli.js

@@ -17,7 +17,7 @@ program
         undefined,
     )
     .option('-c, --config <file-path>', 'config file path')
-    .version('0.0.2')
+    .version('0.1.1')
     .action(run);
 
 await program.parseAsync(process.argv);

package/config-schema.json

@@ -53,9 +53,11 @@
           },
           "schedule": {
             "title": "Schedule",
-            "description": "[WIP] A schedule for a recurring event.",
+            "description": "A schedule for a recurring event in crontab format.",
             "propertyOrder": 4,
             "type": "string",
+            "format": "crontab",
+            "pattern": "^((((\\d+,)+\\d+|(\\d+(\\/|-|#)\\d+)|\\d+L?|\\*(\\/\\d+)?|L(-\\d+)?|\\?|[A-Z]{3}(-[A-Z]{3})?) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\\d+(ns|us|µs|ms|s|m|h))+)$",
             "options": {
               "dependencies": {
                 "schedule_type": "recurring"

package/dist/config.js

@@ -1,3 +1,4 @@
+import CronExpressionParser from "cron-parser";
 import { DateTime } from "luxon";
 
 /** @typedef {'date'|'recurring'} ConfigEventType */
@@ -36,17 +37,27 @@ import { DateTime } from "luxon";
  * @returns {boolean}
  */
 export function checkEventSchedule(date, event) {
+    // Ignore a disabled event
     if (event.enabled == false) {
         return false;
     }
 
-    if (event.date) {
+    if (event.date) { // If event has the `date` field
+        // Parse event's date string to `DateTime`
         const eventDate = DateTime.fromISO(event.date);
         // console.log(eventDate.getTime(), date.getTime())
+        // Compare parsed date (rounded to the previous second) to the current `date`
         return eventDate.startOf('second').toMillis() == date.toMillis();
-    } else if (event.schedule) {
-        // TODO: match `schedule` field
-        return false;
+    } else if (event.schedule) { // If event has the `schedule` field
+        try {
+            // Parse crontab string
+            const schedule = CronExpressionParser.parse(event.schedule);
+            // Return if the parsed schedule includes the current `date`
+            return schedule.includesDate(date.toJSDate());
+        } catch (error) {
+            // If parse fails, return `false`
+            return false;
+        }
     } else {
         return false;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obs-scheduler",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "A CLI tool for scheduling OBS functionality.",
   "author": "edonv",
   "type": "module",
@@ -19,6 +19,7 @@
   "homepage": "https://github.com/edonv/obs-scheduler#readme",
   "dependencies": {
     "commander": "^14.0.2",
+    "cron-parser": "^5.4.0",
     "luxon": "^3.7.2",
     "obs-websocket-js": "^5.0.7"
   },