@hesed/recipe 0.1.0

package/dist/recipe/types.d.ts

@@ -0,0 +1,48 @@
+export type Context = Record<string, unknown>;
+export interface LogStep {
+    if?: string;
+    log: string;
+}
+export interface SetStep {
+    if?: string;
+    set: string;
+    value: unknown;
+}
+export interface RunStep {
+    args?: string[];
+    capture?: string;
+    if?: string;
+    run: string;
+}
+export interface ExecStep {
+    capture?: string;
+    exec: string;
+    if?: string;
+    json?: boolean;
+    silent?: boolean;
+}
+export interface RepeatStep {
+    as?: string;
+    if?: string;
+    repeat: number | string;
+    steps: Step[];
+}
+export interface ForEachStep {
+    as: string;
+    forEach: string;
+    if?: string;
+    steps: Step[];
+}
+export interface IfStep {
+    else?: Step[];
+    if: string;
+    then?: Step[];
+}
+export type Step = ExecStep | ForEachStep | IfStep | LogStep | RepeatStep | RunStep | SetStep;
+export interface Recipe {
+    description?: string;
+    name: string;
+    steps: Step[];
+    vars?: Context;
+    version?: string;
+}

package/dist/recipe/types.js

@@ -0,0 +1 @@
+export {};

package/oclif.manifest.json

@@ -0,0 +1,382 @@
+{
+  "commands": {
+    "recipe:create": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "Name for the new recipe.",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "Creates a starter recipe in the recipe store that you can edit and run.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> close-user-tickets",
+        "<%= config.bin %> <%= command.id %> close-user-tickets --description \"Close all tickets for a user\""
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "description": {
+          "char": "d",
+          "description": "Description for the recipe.",
+          "name": "description",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite an existing recipe with the same name.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:create",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Scaffold a new recipe.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "create.js"
+      ]
+    },
+    "recipe:export": {
+      "aliases": [],
+      "args": {
+        "recipe": {
+          "description": "Name of the saved recipe to export.",
+          "name": "recipe",
+          "required": true
+        }
+      },
+      "description": "Write a saved recipe to a JSON file so it can be shared or version-controlled.\n\nWith --stdout the recipe is printed instead of written to a file.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> close-user-tickets",
+        "<%= config.bin %> <%= command.id %> close-user-tickets --output ./shared/close-user-tickets.json",
+        "<%= config.bin %> <%= command.id %> close-user-tickets --stdout"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite the output file if it already exists.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "output": {
+          "char": "o",
+          "description": "Output file path. Defaults to ./<name>.json.",
+          "name": "output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stdout": {
+          "description": "Print the recipe to stdout instead of writing a file.",
+          "name": "stdout",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:export",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Export a recipe to a file.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "export.js"
+      ]
+    },
+    "recipe:import": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "Path to a recipe JSON file to import.",
+          "name": "path",
+          "required": true
+        }
+      },
+      "description": "Import a recipe from a JSON file into the recipe store so it can be run by name.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> ./close-user-tickets.json",
+        "<%= config.bin %> <%= command.id %> ./shared-recipe.json --name my-copy"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite an existing recipe with the same name.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "description": "Save the imported recipe under a different name.",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:import",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Import a recipe from a file.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "import.js"
+      ]
+    },
+    "recipe": {
+      "aliases": [],
+      "args": {},
+      "description": "List saved recipes.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "List saved recipes.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "index.js"
+      ]
+    },
+    "recipe:remove": {
+      "aliases": [
+        "recipe:delete"
+      ],
+      "args": {
+        "recipe": {
+          "description": "Name of the saved recipe to remove.",
+          "name": "recipe",
+          "required": true
+        }
+      },
+      "description": "Delete a recipe from the recipe store.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> close-user-tickets"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:remove",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Remove a saved recipe.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "remove.js"
+      ]
+    },
+    "recipe:run": {
+      "aliases": [],
+      "args": {
+        "recipe": {
+          "description": "Name of a saved recipe, or a path to a recipe file.",
+          "name": "recipe",
+          "required": true
+        }
+      },
+      "description": "Each step runs a command, with optional conditions, loops and JSON operations between them.\n\nUse --var to override the recipe's default variables, and --dry-run to preview the commands without running them.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> close-user-tickets",
+        "<%= config.bin %> <%= command.id %> close-user-tickets --var assignee=jdoe",
+        "<%= config.bin %> <%= command.id %> ./my-recipe.json --dry-run"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "dry-run": {
+          "description": "Print the commands that would run without executing them.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "var": {
+          "description": "Override a recipe variable (key=value). Repeatable. Values are parsed as JSON when possible.",
+          "name": "var",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:run",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Run a recipe: a sequence of commands chained with conditions, loops and JSON operations.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "run.js"
+      ]
+    },
+    "recipe:show": {
+      "aliases": [],
+      "args": {
+        "recipe": {
+          "description": "Name of a saved recipe, or a path to a recipe file.",
+          "name": "recipe",
+          "required": true
+        }
+      },
+      "description": "Print the full definition of a recipe.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> close-user-tickets"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:show",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Print a recipe definition.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "show.js"
+      ]
+    },
+    "recipe:validate": {
+      "aliases": [],
+      "args": {
+        "recipe": {
+          "description": "Name of a saved recipe, or a path to a recipe file.",
+          "name": "recipe",
+          "required": true
+        }
+      },
+      "description": "Check that a recipe is well-formed without running it.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> ./my-recipe.json"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "recipe:validate",
+      "pluginAlias": "@hesed/recipe",
+      "pluginName": "@hesed/recipe",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Validate a recipe.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "recipe",
+        "validate.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@hesed/recipe",
+  "description": "Chains multiple CLI commands together to accomplish a task",
+  "version": "0.1.0",
+  "author": "Hesed",
+  "bin": {
+    "ai": "./bin/run.js"
+  },
+  "bugs": "https://github.com/hesedcasa/recipe/issues",
+  "dependencies": {
+    "@hesed/plugin-lib": "^0.10.0",
+    "@oclif/core": "^4",
+    "ansis": "^3"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^26",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^11",
+    "oclif": "^4",
+    "prettier": "^3.8.1",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "ts-prune": "^0.10.3",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/hesedcasa/recipe",
+  "keywords": [
+    "recipe",
+    "oclif"
+  ],
+  "license": "Apache 2.0",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "recipe",
+    "dirname": "recipe",
+    "commands": "./dist/commands",
+    "topicSeparator": " "
+  },
+  "repository": "hesedcasa/recipe",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md",
+    "find-deadcode": "ts-prune --ignore '(run|default)'",
+    "format": "eslint --cache --fix --quiet . && prettier --write --cache .",
+    "pre-commit": "npm run format && npm run find-deadcode"
+  },
+  "types": "dist/index.d.ts"
+}