@wonsukchoi/crondex 0.7.0 → 0.9.0

package/README.md

@@ -25,9 +25,11 @@ blocked by npm's anti-typosquat check). The command itself is still
 ```bash
 npx @wonsukchoi/crondex list                          # browse everything
 npx @wonsukchoi/crondex list --category devops        # filter by category or --tag
+npx @wonsukchoi/crondex categories                    # list categories with job counts
 npx @wonsukchoi/crondex show backup-reminder          # print one job's YAML
 npx @wonsukchoi/crondex add backup-reminder --dest ./cron/backup-reminder.yaml
 npx @wonsukchoi/crondex recommend "warn me before my SSL cert expires"
+npx @wonsukchoi/crondex init ssl-cert-expiry-check --category security
 ```
 
 `recommend` takes a free-text description of what you want and ranks the
@@ -37,6 +39,10 @@ got asked "can you set up something for X" and needs to check whether a
 ready-made job already covers it before writing one from scratch. Add
 `--limit <n>` to control how many results come back (default 5).
 
+`init` scaffolds a new job file from `templates/job.template.yaml` into your
+own project (default `./<id>.yaml`) — for writing a job that isn't in the
+catalog yet, whether or not you plan to contribute it back.
+
 Or install once and drop the scope prefix on every call:
 
 ```bash
@@ -60,142 +66,66 @@ node bin/crondex.js list
 
 ```
 crondex/
-├── bin/crondex.js         CLI: list / show / add / recommend
+├── bin/crondex.js         CLI: list / categories / show / add / recommend / init
 ├── catalog.json           generated index of every job — read this first
 ├── schema/job.schema.json spec every job file follows
-├── jobs/
-│   ├── devops/
-│   ├── productivity/
-│   ├── personal/
-│   ├── content/
-│   ├── finance/
-│   ├── security/
-│   ├── learning/
-│   ├── team/
-│   ├── home/
-│   ├── travel/
-│   └── growth/
+├── jobs/                  one YAML per job, grouped by category subdirectory
 └── scripts/
-    ├── build-catalog.js   regenerates catalog.json from jobs/**/*.yaml
+    ├── build-catalog.js   regenerates catalog.json + the summary below from jobs/**/*.yaml
     └── validate-jobs.js   validates every job against the schema
 ```
 
 ## Available jobs
 
-56 jobs across 11 categories. Full details (description, tags, variables)
-live in `catalog.json` and each job's YAML file — run `crondex list` or
-browse `jobs/<category>/` for the plain-language rundown of each.
-
-**devops**
-
-| id | schedule | modes |
-|---|---|---|
-| `dependency-audit` | `0 8 * * 1` | script + agent-prompt |
-| `log-cleanup` | `30 3 * * *` | script |
-| `repo-health-check` | `0 9 * * 1-5` | script + agent-prompt |
-| `backup-reminder` | `0 9 * * *` | script |
-| `ssl-cert-expiry-check` | `0 6 * * *` | script |
-| `uptime-ping-check` | `*/15 * * * *` | script |
-| `cost-alert` | `0 7 * * *` | script + agent-prompt |
-| `disk-space-check` | `0 */6 * * *` | script |
-| `docker-image-prune` | `0 4 * * *` | script |
-| `env-drift-check` | `0 8 * * *` | script |
-| `stale-dependency-pr-nudge` | `0 9 * * 1-5` | script |
-| `db-backup-verify` | `0 5 * * *` | script |
-| `license-compliance-check` | `0 8 * * 1` | script |
-| `orphaned-branch-cleanup` | `0 9 * * 1` | script |
-| `dns-record-check` | `0 */6 * * *` | script |
-| `queue-depth-check` | `*/10 * * * *` | script |
-| `api-rate-limit-check` | `*/15 * * * *` | script |
-
-**productivity**
-
-| id | schedule | modes |
-|---|---|---|
-| `daily-standup-summary` | `0 8 * * 1-5` | script + agent-prompt |
-| `inbox-triage` | `0 7,13 * * 1-5` | agent-prompt only |
-| `weekly-report` | `0 16 * * 5` | script + agent-prompt |
-| `focus-block-reminder` | `0 9,14 * * 1-5` | script |
-
-**personal**
-
-| id | schedule | modes |
-|---|---|---|
-| `bill-due-reminder` | `0 9 * * *` | script |
-| `habit-checkin` | `0 20 * * *` | script |
-| `meal-plan-reminder` | `0 9 * * 0` | script + agent-prompt |
-| `water-intake-reminder` | `0 9,12,15,18 * * *` | script |
-| `screen-time-check` | `0 20 * * *` | agent-prompt only |
-
-**content**
-
-| id | schedule | modes |
-|---|---|---|
-| `changelog-digest` | `0 10 * * 5` | script + agent-prompt |
-| `broken-link-check` | `0 7 * * 1` | script |
-| `social-mentions-watch` | `0 9 * * *` | agent-prompt only |
-| `seo-meta-check` | `0 7 * * 1` | script |
-| `rss-feed-validate` | `0 8 * * *` | script |
-| `robots-txt-check` | `0 8 * * *` | script |
-
-**finance**
-
-| id | schedule | modes |
-|---|---|---|
-| `subscription-audit` | `0 9 1 * *` | script |
-| `net-worth-snapshot` | `0 9 1 * *` | script |
-| `saas-seat-audit` | `0 9 1 * *` | script |
-| `invoice-overdue-check` | `0 9 * * *` | script |
-| `tax-deadline-reminder` | `0 9 * * *` | script |
-
-**security**
-
-| id | schedule | modes |
-|---|---|---|
-| `secrets-scan` | `0 3 * * *` | script |
-| `open-port-check` | `0 */4 * * *` | script |
-| `failed-login-watch` | `*/15 * * * *` | script |
-| `sudo-usage-audit` | `0 * * * *` | script |
-| `firewall-rule-diff` | `0 6 * * *` | script |
-| `certificate-transparency-watch` | `0 */12 * * *` | script |
-
-**learning**
-
-| id | schedule | modes |
-|---|---|---|
-| `daily-flashcard-review` | `0 8 * * *` | script |
-| `reading-list-nudge` | `0 9 * * 6` | script |
-| `course-progress-checkin` | `0 9 * * 1` | script |
-
-**team**
-
-| id | schedule | modes |
-|---|---|---|
-| `1on1-prep-reminder` | `0 9 * * 3` | script |
-| `pto-balance-check` | `0 9 1 * *` | script |
-
-**home**
-
-| id | schedule | modes |
-|---|---|---|
-| `hvac-filter-reminder` | `0 9 1 * *` | script |
-| `smoke-detector-battery-check` | `0 9 1 * *` | script |
-| `plant-watering-reminder` | `0 9 * * *` | script |
-
-**travel**
-
-| id | schedule | modes |
-|---|---|---|
-| `passport-expiry-check` | `0 9 1 * *` | script |
-| `visa-expiry-check` | `0 9 1 * *` | script |
-| `flight-checkin-reminder` | `0 * * * *` | script |
-
-**growth**
-
-| id | schedule | modes |
-|---|---|---|
-| `review-request-nudge` | `0 9 * * *` | script |
-| `cart-abandonment-followup` | `0 10 * * *` | script + agent-prompt |
+Full details (description, tags, variables) live in `catalog.json` and each
+job's YAML file — run `crondex list`, `crondex recommend "<what you want>"`,
+or browse `jobs/<category>/` for the plain-language rundown of each. The
+counts below are regenerated by `npm run build-catalog`, so they never drift
+from what's actually in `jobs/`.
+
+<!-- BEGIN JOB SUMMARY -->
+182 jobs across 37 categories:
+
+| category | jobs |
+|---|---|
+| `agriculture` | 3 |
+| `construction` | 3 |
+| `content` | 12 |
+| `creator` | 3 |
+| `crypto` | 3 |
+| `devops` | 26 |
+| `ecommerce` | 3 |
+| `education` | 3 |
+| `events` | 3 |
+| `finance` | 10 |
+| `fleet` | 3 |
+| `gaming` | 3 |
+| `growth` | 4 |
+| `healthcare` | 3 |
+| `hiring` | 3 |
+| `home` | 5 |
+| `hospitality` | 3 |
+| `hr` | 3 |
+| `insurance` | 3 |
+| `inventory` | 3 |
+| `investing` | 3 |
+| `learning` | 5 |
+| `legal` | 3 |
+| `logistics` | 3 |
+| `manufacturing` | 3 |
+| `marketing` | 4 |
+| `nonprofit` | 3 |
+| `personal` | 8 |
+| `podcast` | 3 |
+| `productivity` | 9 |
+| `realestate` | 3 |
+| `restaurant` | 3 |
+| `sales` | 4 |
+| `security` | 14 |
+| `support` | 3 |
+| `team` | 4 |
+| `travel` | 5 |
+<!-- END JOB SUMMARY -->
 
 ## How a job works
 

package/bin/crondex.js

@@ -28,15 +28,19 @@ function printHelp() {
 
 Usage:
   crondex list [--category <name>] [--tag <name>]
+  crondex categories
   crondex show <id>
   crondex add <id> [--dest <path>]
   crondex recommend "<what you want done>" [--limit <n>]
+  crondex init <id> [--category <name>] [--dest <path>]
 
 Examples:
   crondex list --category devops
+  crondex categories
   crondex show dependency-audit
   crondex add backup-reminder --dest ./cron/backup-reminder.yaml
   crondex recommend "warn me before my SSL cert expires"
+  crondex init ssl-cert-expiry-check --category security
 `);
 }
 
@@ -147,6 +151,36 @@ function show(id) {
   console.log(readFileSync(join(ROOT, findJob(id).path), "utf8"));
 }
 
+function categories() {
+  const counts = {};
+  for (const j of CATALOG.jobs) counts[j.category] = (counts[j.category] ?? 0) + 1;
+  console.log(catalogInfoLine());
+  console.log();
+  for (const [cat, n] of Object.entries(counts).sort(([a], [b]) => a.localeCompare(b))) {
+    console.log(`${cat}  (${n})`);
+  }
+}
+
+const ID_RE = /^[a-z0-9]+(-[a-z0-9]+)*$/;
+
+function init(id) {
+  if (!ID_RE.test(id)) {
+    console.error(`"${id}" isn't a valid job id — use lowercase letters, digits, and hyphens (e.g. ssl-cert-expiry-check).`);
+    process.exit(1);
+  }
+  const category = flag("category") ?? "productivity";
+  const dest = flag("dest") ?? `./${id}.yaml`;
+  if (existsSync(dest)) {
+    console.error(`${dest} already exists — refusing to overwrite. Pass --dest to choose another path.`);
+    process.exit(1);
+  }
+  const template = readFileSync(join(ROOT, "templates/job.template.yaml"), "utf8")
+    .replace("id: your-job-id", `id: ${id}`)
+    .replace("category: devops", `category: ${category}`);
+  writeFileSync(dest, template);
+  console.log(`wrote ${dest} — fill in the fields, then \`npm run validate\` (see CONTRIBUTING.md to submit it upstream).`);
+}
+
 function add(id) {
   const meta = findJob(id);
   const dest = flag("dest") ?? `./${id}.yaml`;
@@ -162,6 +196,16 @@ switch (cmd) {
   case "list":
     list();
     break;
+  case "categories":
+    categories();
+    break;
+  case "init":
+    if (!args[0]) {
+      console.error("usage: crondex init <id> [--category <name>] [--dest <path>]");
+      process.exit(1);
+    }
+    init(args[0]);
+    break;
   case "show":
     if (!args[0]) {
       console.error("usage: crondex show <id>");