run-and-notify 0.1.0

package/examples/full-raw/templates/text.hbs

@@ -0,0 +1,12 @@
+# Raw Command Result
+
+- Executed: {{datetimeFromISO8601 executedAt}}
+- Command: `{{shellCommand command}}`
+- CWD: `{{shellToken cwd}}`
+- Status: `{{status}}`
+
+## Output
+{{stdout.raw}}
+
+## Errors
+{{stderr.raw}}

package/examples/minimal/config.json

@@ -0,0 +1,20 @@
+{
+  "transports": {
+    "smtp": {
+      "enabled": true,
+      "host": "smtp.example.com",
+      "port": 587,
+      "from": "run-and-notify@example.com",
+      "to": ["ops@example.com"],
+      "auth": {
+        "user": "run-and-notify@example.com",
+        "passEnvVar": "SMTP_PASS"
+      }
+    },
+    "slack": {
+      "enabled": true,
+      "tokenEnvVar": "SLACK_BOT_TOKEN",
+      "defaultChannel": "#ops"
+    }
+  }
+}

package/examples/structured-jsonl-html/config.json

@@ -0,0 +1,46 @@
+{
+  "locale": "en-US",
+  "timeoutSeconds": 0,
+  "showStderrIfSuccess": false,
+  "templatesDir": "examples/structured-jsonl-html/templates",
+  "stdout": {
+    "format": "jsonl"
+  },
+  "stderr": {
+    "format": "jsonl"
+  },
+  "transports": {
+    "smtp": {
+      "enabled": true,
+      "host": "smtp.example.com",
+      "port": 587,
+      "from": "run-and-notify@example.com",
+      "to": ["reports@example.com"]
+    },
+    "slack": {
+      "enabled": true,
+      "tokenEnvVar": "SLACK_BOT_TOKEN",
+      "defaultChannel": "#reports"
+    }
+  },
+  "success": {
+    "email": {
+      "subject": "success.subject.hbs",
+      "html": "success.email.html.hbs",
+      "text": "success.text.hbs"
+    },
+    "slack": {
+      "blocks": "success.slack.blocks.json.hbs"
+    }
+  },
+  "error": {
+    "email": {
+      "subject": "error.subject.hbs",
+      "html": "error.email.html.hbs",
+      "text": "error.text.hbs"
+    },
+    "slack": {
+      "blocks": "error.slack.blocks.json.hbs"
+    }
+  }
+}

package/examples/structured-jsonl-html/templates/error.email.html.hbs

@@ -0,0 +1,6 @@
+<h1>Structured report failed</h1>
+<ul>
+{{#each stderr.lines}}
+  <li>{{#if timestamp}}{{datetimeFromISO8601 timestamp}} {{{escapeHtml msg}}}{{else}}{{{escapeHtml raw}}}{{/if}}</li>
+{{/each}}
+</ul>

package/examples/structured-jsonl-html/templates/error.slack.blocks.json.hbs

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": {{{jsonString (concat "*Structured report failed*" (nl) "*Status:* " status)}}}
+    }
+  }
+]

package/examples/structured-jsonl-html/templates/error.subject.hbs

@@ -0,0 +1 @@
+Structured report failed with status {{status}}

package/examples/structured-jsonl-html/templates/error.text.hbs

@@ -0,0 +1,4 @@
+Structured report failed
+{{#each stderr.lines}}
+{{#if timestamp}}{{datetimeFromISO8601 timestamp}} {{msg}}{{else}}{{raw}}{{/if}}
+{{/each}}

package/examples/structured-jsonl-html/templates/success.email.html.hbs

@@ -0,0 +1,16 @@
+<h1>{{stdout.lines.[0].title}}</h1>
+<ul>
+{{#each stdout.lines.[0].items}}
+  <li>{{this}}</li>
+{{/each}}
+</ul>
+<table>
+{{#each stdout.lines.[0].table}}
+  <tr><td>{{this.[0]}}</td><td>{{this.[1]}}</td></tr>
+{{/each}}
+</table>
+<p>Date: {{dateFromISO8601 stdout.lines.[0].date}}</p>
+<p>Time: {{timeFromISO8601 stdout.lines.[0].time}}</p>
+<p>Date/time: {{datetimeFromISO8601 stdout.lines.[0].datetime}}</p>
+{{{markdownToHtml stdout.lines.[0].childMarkdown}}}
+<pre>{{{rawToHtml stdout.lines.[0].childRaw}}}</pre>

package/examples/structured-jsonl-html/templates/success.slack.blocks.json.hbs

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": {{{jsonString (slackCodeBlock (concat stdout.lines.[0].title (nl) stdout.lines.[0].childMarkdown (nl) (datetimeFromISO8601 stdout.lines.[0].datetime)))}}}
+    }
+  }
+]

package/examples/structured-jsonl-html/templates/success.subject.hbs

@@ -0,0 +1 @@
+{{stdout.lines.[0].title}}

package/examples/structured-jsonl-html/templates/success.text.hbs

@@ -0,0 +1,6 @@
+{{stdout.lines.[0].title}}
+{{#each stdout.lines.[0].items}}
+- {{this}}
+{{/each}}
+{{stdout.lines.[0].childMarkdown}}
+{{stdout.lines.[0].childRaw}}

package/examples/structured-jsonl-markdown/config.json

@@ -0,0 +1,46 @@
+{
+  "locale": "en-US",
+  "timeoutSeconds": 0,
+  "showStderrIfSuccess": false,
+  "templatesDir": "examples/structured-jsonl-markdown/templates",
+  "stdout": {
+    "format": "jsonl"
+  },
+  "stderr": {
+    "format": "jsonl"
+  },
+  "transports": {
+    "smtp": {
+      "enabled": true,
+      "host": "smtp.example.com",
+      "port": 587,
+      "from": "run-and-notify@example.com",
+      "to": ["reports@example.com"]
+    },
+    "slack": {
+      "enabled": true,
+      "tokenEnvVar": "SLACK_BOT_TOKEN",
+      "defaultChannel": "#reports"
+    }
+  },
+  "success": {
+    "email": {
+      "subject": "success.subject.hbs",
+      "html": "success.email.html.hbs",
+      "text": "success.text.hbs"
+    },
+    "slack": {
+      "blocks": "success.slack.blocks.json.hbs"
+    }
+  },
+  "error": {
+    "email": {
+      "subject": "error.subject.hbs",
+      "html": "error.email.html.hbs",
+      "text": "error.text.hbs"
+    },
+    "slack": {
+      "blocks": "error.slack.blocks.json.hbs"
+    }
+  }
+}

package/examples/structured-jsonl-markdown/templates/error.email.html.hbs

@@ -0,0 +1,9 @@
+<h1>Structured report failed</h1>
+<p><strong>CWD:</strong> {{shellToken cwd}}</p>
+<p><strong>Command:</strong> {{shellCommand command}}</p>
+<p><strong>Status:</strong> {{status}}</p>
+<ul>
+{{#each stderr.lines}}
+  <li>{{#if timestamp}}{{datetimeFromISO8601 timestamp}} {{{escapeHtml msg}}}{{else}}{{{escapeHtml raw}}}{{/if}}</li>
+{{/each}}
+</ul>

package/examples/structured-jsonl-markdown/templates/error.slack.blocks.json.hbs

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": {{{jsonString (concat "*Structured report failed*" (nl) "*Status:* " status)}}}
+    }
+  }
+]

package/examples/structured-jsonl-markdown/templates/error.subject.hbs

@@ -0,0 +1 @@
+Structured report failed with status {{status}}

package/examples/structured-jsonl-markdown/templates/error.text.hbs

@@ -0,0 +1,9 @@
+Structured report failed
+
+- CWD: `{{shellToken cwd}}`
+- Command: `{{shellCommand command}}`
+- Status: `{{status}}`
+
+{{#each stderr.lines}}
+- {{#if timestamp}}{{datetimeFromISO8601 timestamp}} {{{escapeMarkdown msg}}}{{else}}{{{escapeMarkdown raw}}}{{/if}}
+{{/each}}

package/examples/structured-jsonl-markdown/templates/success.email.html.hbs

@@ -0,0 +1 @@
+{{{markdownToHtml (concat "# " stdout.lines.[0].title (nl) (nl) "- " stdout.lines.[0].items.[0] (nl) "- " stdout.lines.[0].items.[1] (nl) (nl) (htmlToMarkdown stdout.lines.[0].childHtml) (nl) (nl) (escapeMarkdown stdout.lines.[0].childRaw))}}}

package/examples/structured-jsonl-markdown/templates/success.slack.blocks.json.hbs

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": {{{jsonString (slackCodeBlock (concat stdout.lines.[0].title (nl) "- " stdout.lines.[0].items.[0] (nl) "- " stdout.lines.[0].items.[1] (nl) (datetimeFromISO8601 stdout.lines.[0].datetime)))}}}
+    }
+  }
+]

package/examples/structured-jsonl-markdown/templates/success.subject.hbs

@@ -0,0 +1 @@
+{{stdout.lines.[0].title}}

package/examples/structured-jsonl-markdown/templates/success.text.hbs

@@ -0,0 +1,19 @@
+# {{stdout.lines.[0].title}}
+
+{{#each stdout.lines.[0].items}}
+- {{this}}
+{{/each}}
+
+| Col 1 | Col 2 |
+| --- | --- |
+{{#each stdout.lines.[0].table}}
+| {{this.[0]}} | {{this.[1]}} |
+{{/each}}
+
+- Date: {{dateFromISO8601 stdout.lines.[0].date}}
+- Time: {{timeFromISO8601 stdout.lines.[0].time}}
+- Date/time: {{datetimeFromISO8601 stdout.lines.[0].datetime}}
+
+{{htmlToMarkdown stdout.lines.[0].childHtml}}
+
+{{escapeMarkdown stdout.lines.[0].childRaw}}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "run-and-notify",
+  "version": "0.1.0",
+  "description": "Execute a command and send the notification results via better-notify",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/barbieri/run-and-notify.git"
+  },
+  "type": "module",
+  "private": false,
+  "license": "GPL-3.0-or-later",
+  "keywords": [
+    "cli",
+    "notifications",
+    "slack",
+    "email",
+    "automation",
+    "monitoring",
+    "run-and-notify"
+  ],
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "files": [
+    "dist/bundle",
+    "schemas",
+    "examples",
+    "config.example.json",
+    ".env.example",
+    "LICENSE",
+    "README.md"
+  ],
+  "bin": {
+    "run-and-notify": "dist/bundle/run-and-notify.mjs"
+  },
+  "devDependencies": {
+    "@betternotify/core": "1.0.0-beta.8",
+    "@betternotify/email": "1.0.0-beta.4",
+    "@betternotify/slack": "1.0.0-beta.4",
+    "@betternotify/smtp": "1.0.0-beta.3",
+    "@biomejs/biome": "^2.4.15",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/lodash": "^4.17.24",
+    "@types/node": "^25.9.1",
+    "@types/turndown": "^5.0.5",
+    "@types/yargs": "^17.0.35",
+    "@vitest/coverage-v8": "3.2.4",
+    "ajv": "8.20.0",
+    "dotenv": "^17.4.2",
+    "esbuild": "^0.28.0",
+    "handlebars": "^4.7.8",
+    "husky": "^9.1.7",
+    "lodash": "^4.18.1",
+    "markdown-to-slack-blocks": "^1.5.0",
+    "marked": "^17.0.1",
+    "npm-run-all": "^4.1.5",
+    "pino": "^10.3.1",
+    "pino-pretty": "^13.1.3",
+    "tsx": "^4.20.6",
+    "turndown": "^7.2.2",
+    "typescript": "6.0.3",
+    "vitest": "3.2.4",
+    "yargs": "^18.0.0"
+  },
+  "scripts": {
+    "build": "tsc && node scripts/build-cli.mjs",
+    "build:cli": "node scripts/build-cli.mjs",
+    "check": "biome check --error-on-warnings .",
+    "check:fix": "biome check --write --error-on-warnings .",
+    "format": "biome format --write .",
+    "lint": "biome lint --error-on-warnings .",
+    "qa": "run-p check build test typecheck",
+    "run-and-notify": "node --import tsx src/run-and-notify.ts",
+    "run-and-notify:bundle": "node dist/bundle/run-and-notify.mjs",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json"
+  }
+}

package/schemas/config.schema.json

@@ -0,0 +1,259 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://github.com/barbieri/run-and-notify/schemas/config.schema.json",
+  "title": "run-and-notify configuration",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Human-readable name of the automation used in default notification titles and subjects. Defaults to the command with arguments",
+      "minLength": 1
+    },
+    "locale": {
+      "type": "string",
+      "description": "BCP 47 locale used by date and time template helpers.",
+      "default": "en-US",
+      "minLength": 1
+    },
+    "cwd": {
+      "type": "string",
+      "description": "Working directory used to execute the command. CLI override: --cwd=/path."
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Render and log notifications without sending through configured transports. It DOES EXECUTE the target command, just does not send the notifications!",
+      "default": false
+    },
+    "propagateExitCode": {
+      "type": "boolean",
+      "description": "When true, the run-and-notify process exits with the target command status after notifications are delivered.",
+      "default": true
+    },
+    "timeoutSeconds": {
+      "type": "integer",
+      "description": "Command timeout in seconds. A value of 0 disables the timeout.",
+      "default": 0,
+      "minimum": 0
+    },
+    "showStderrIfSuccess": {
+      "type": "boolean",
+      "description": "When false, success templates should not render stderr.",
+      "default": false
+    },
+    "hideCommandIfSuccess": {
+      "type": "boolean",
+      "description": "When true, success templates should render only command output content and omit command metadata, visible separators, and output headings.",
+      "default": false
+    },
+    "templatesDir": {
+      "type": "string",
+      "description": "Directory containing Handlebars templates and partials. When omitted, built-in templates are used.",
+      "minLength": 1
+    },
+    "stdout": {
+      "type": "object",
+      "description": "Parsing configuration for command stdout.",
+      "additionalProperties": false,
+      "properties": {
+        "format": {
+          "type": "string",
+          "description": "How stdout is exposed to templates.",
+          "default": "raw",
+          "enum": ["raw", "jsonl", "markdown", "html"]
+        }
+      },
+      "required": ["format"]
+    },
+    "stderr": {
+      "type": "object",
+      "description": "Parsing configuration for command stderr.",
+      "additionalProperties": false,
+      "properties": {
+        "format": {
+          "type": "string",
+          "description": "How stderr is exposed to templates.",
+          "default": "raw",
+          "enum": ["raw", "jsonl", "markdown", "html"]
+        }
+      },
+      "required": ["format"]
+    },
+    "transports": {
+      "type": "object",
+      "description": "Better-Notify transport configuration.",
+      "default": {},
+      "additionalProperties": false,
+      "properties": {
+        "smtp": {
+          "type": "object",
+          "description": "SMTP email transport configuration.",
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable SMTP email notifications.",
+              "default": true
+            },
+            "host": {
+              "type": "string",
+              "description": "SMTP server host.",
+              "minLength": 1
+            },
+            "port": {
+              "type": "integer",
+              "description": "SMTP server port.",
+              "minimum": 1,
+              "maximum": 65535
+            },
+            "secure": {
+              "type": "boolean",
+              "description": "Use TLS from connection start instead of STARTTLS.",
+              "default": false
+            },
+            "from": {
+              "type": "string",
+              "description": "Email sender address.",
+              "minLength": 1
+            },
+            "to": {
+              "type": "array",
+              "description": "Email recipient addresses.",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "minItems": 1
+            },
+            "auth": {
+              "type": "object",
+              "description": "SMTP authentication configuration.",
+              "additionalProperties": false,
+              "properties": {
+                "user": {
+                  "type": "string",
+                  "description": "SMTP username."
+                },
+                "passEnvVar": {
+                  "type": "string",
+                  "description": "Environment variable containing the SMTP password.",
+                  "minLength": 1
+                }
+              }
+            }
+          },
+          "required": ["enabled", "host", "port", "from", "to"]
+        },
+        "slack": {
+          "type": "object",
+          "description": "Better-Notify Slack transport configuration.",
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable Slack notifications.",
+              "default": true
+            },
+            "tokenEnvVar": {
+              "type": "string",
+              "description": "Environment variable containing the Slack bot token used by @betternotify/slack slackTransport().",
+              "minLength": 1
+            },
+            "defaultChannel": {
+              "type": "string",
+              "description": "Default Slack channel ID or name used when Slack templates do not set a destination."
+            }
+          },
+          "required": ["enabled", "tokenEnvVar"]
+        }
+      }
+    },
+    "success": {
+      "$ref": "#/definitions/notification",
+      "description": "Templates used when the command exits with status 0.",
+      "default": {
+        "email": {
+          "subject": "success.subject.hbs",
+          "html": "default.email.html.hbs",
+          "text": "default.text.hbs"
+        },
+        "slack": {
+          "blocks": "default.slack.blocks.json.hbs"
+        }
+      }
+    },
+    "error": {
+      "$ref": "#/definitions/notification",
+      "description": "Templates used when the command exits with a non-zero status.",
+      "default": {
+        "email": {
+          "subject": "error.subject.hbs",
+          "html": "default.email.html.hbs",
+          "text": "default.text.hbs"
+        },
+        "slack": {
+          "blocks": "default.slack.blocks.json.hbs"
+        }
+      }
+    }
+  },
+  "required": [
+    "locale",
+    "dryRun",
+    "propagateExitCode",
+    "timeoutSeconds",
+    "showStderrIfSuccess",
+    "hideCommandIfSuccess",
+    "stdout",
+    "stderr",
+    "transports",
+    "success",
+    "error"
+  ],
+  "definitions": {
+    "emailTemplates": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "subject": {
+          "type": "string",
+          "description": "Handlebars template filename used for email subject."
+        },
+        "html": {
+          "type": "string",
+          "description": "Handlebars template filename used for email HTML."
+        },
+        "text": {
+          "type": "string",
+          "description": "Handlebars template filename used for plain text email."
+        }
+      }
+    },
+    "slackTemplates": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "text": {
+          "type": "string",
+          "description": "Optional Handlebars template filename used for Slack fallback text. When omitted, fallback text is generated from command and status."
+        },
+        "blocks": {
+          "type": "string",
+          "description": "Handlebars template filename that renders a JSON array of Slack blocks."
+        }
+      }
+    },
+    "notification": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "email": {
+          "$ref": "#/definitions/emailTemplates"
+        },
+        "slack": {
+          "$ref": "#/definitions/slackTemplates"
+        }
+      }
+    }
+  }
+}