@wonsukchoi/crondex 0.8.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,7 +66,7 @@ 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/                  one YAML per job, grouped by category subdirectory
@@ -78,35 +84,43 @@ counts below are regenerated by `npm run build-catalog`, so they never drift
 from what's actually in `jobs/`.
 
 <!-- BEGIN JOB SUMMARY -->
-150 jobs across 29 categories:
+182 jobs across 37 categories:
 
 | category | jobs |
 |---|---|
+| `agriculture` | 3 |
 | `construction` | 3 |
 | `content` | 12 |
 | `creator` | 3 |
-| `devops` | 25 |
+| `crypto` | 3 |
+| `devops` | 26 |
+| `ecommerce` | 3 |
 | `education` | 3 |
 | `events` | 3 |
-| `finance` | 9 |
+| `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` | 3 |
+| `marketing` | 4 |
 | `nonprofit` | 3 |
-| `personal` | 6 |
+| `personal` | 8 |
 | `podcast` | 3 |
-| `productivity` | 7 |
+| `productivity` | 9 |
 | `realestate` | 3 |
-| `sales` | 3 |
+| `restaurant` | 3 |
+| `sales` | 4 |
 | `security` | 14 |
 | `support` | 3 |
 | `team` | 4 |

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>");