@katmer/core 0.0.3 → 0.0.4-alpha.0

package/lib/modules/archive.module.ts

@@ -18,7 +18,7 @@ declare module "../interfaces/task.interface" {
  * - Works on SSHProvider and LocalProvider.
  * - Matches flags available in bsdtar(1) with sensible defaults.
  *
- * @example Create a gzip archive:
+ * @examples
  * ```yaml
  * - name: Create a gzip archive
  *   archive:
@@ -28,20 +28,14 @@ declare module "../interfaces/task.interface" {
  *     dest: /tmp/system.tar.gz
  *     gzip: true
  *     verbose: true
- * ```
  *
- * @example Extract with strip components:
- * ```yaml
- * - name: Extract release
+ * - name: Extract with strip components
  *   archive:
  *     src: /tmp/release.tar.gz
  *     dest: /opt/app
  *     strip_components: 1
- * ```
  *
- * @example List archive contents:
- * ```yaml
- * - name: List archive
+ * - name: List archive contents
  *   archive:
  *     src: /tmp/archive.tar.xz
  *     list: true

package/lib/modules/copy.module.ts

@@ -35,7 +35,7 @@ declare module "../interfaces/task.interface" {
  * Copies **content** or a **file** to a destination path.
  *
  * - If {@link CopyModuleOptions.content | `content`} is set, it is rendered **locally** using Twig
- *   against `ctx.variables` and written to {@link CopyModuleOptions.dest | `dest`}.
+ *   against context and written to {@link CopyModuleOptions.dest | `dest`}.
  * - If {@link CopyModuleOptions.src | `src`} is set:
  *   - With **SSH** provider, it is treated as a **controller (local)** path and uploaded to the remote host,
  *     unless {@link CopyModuleOptions.remote_src | `remote_src`} is `true`.
@@ -240,7 +240,7 @@ export class CopyModule extends KatmerModule<
 
   /**
    * Execute the copy:
-   * - Renders string fields (including `content`) against `ctx.variables`.
+   * - Renders string fields (including `content`) against context.
    * - Branches to SSH or Local implementation.
    * - Returns {@link CopyModuleResult} with `changed`, `checksum`, optional `backup_file`, etc.
    */
@@ -541,7 +541,7 @@ export class CopyModule extends KatmerModule<
   // ────────────────────────────────────────────────────────────────────────────────
 
   /**
-   * Render only the string-like fields against `ctx.variables`.
+   * Render only the string-like fields against context.
    * - `content` is rendered only if it is a `string`; `Uint8Array` is passed through untouched.
    *
    * @internal

package/lib/modules/debug.module.ts

@@ -21,8 +21,8 @@ declare module "../interfaces/task.interface" {
  *
  * @remarks
  * - Accepts either a **string shorthand** (printed as a message) or a **full options object**.
- * - `msg` entries support template expressions rendered against `ctx.variables` (via `evalExpr`).
- * - When `var` is provided, values are looked up from `ctx.variables` using dot-paths (e.g. `"app.version"`).
+ * - `msg` entries support template expressions rendered against context.
+ * - When `var` is provided, values are looked up from the context using dot-paths (e.g. `"app.version"`).
  * - If nothing is provided, prints a default `"ok"` line.
  *
  * @examples

package/lib/modules/script.module.ts

@@ -13,7 +13,7 @@ import { KatmerModule } from "../module"
  * @remarks
  * - Accepts either a **string** (backwards compatible) or an **object** with a `content` string
  *   and a `render` flag to enable/disable template rendering.
- * - When `render` is `true` (default), the script string is rendered with Twig against `ctx.variables`
+ * - When `render` is `true` (default), the script string is rendered with Twig against context
  *   before execution. When `false`, the string is executed **as-is**.
  * - Uses the provider's shell via {@link Katmer.TaskContext.exec | `ctx.exec`}.
  * - Return semantics are simple: `changed` is always `false`; `failed` is set when the exit code is non-zero.
@@ -91,7 +91,7 @@ export type ScriptModuleOptions =
       /** Inline script content to execute. */
       content: string
       /**
-       * Whether to render the script with Twig against `ctx.variables` before execution.
+       * Whether to render the script with Twig against context before execution.
        * @defaultValue true
        */
       render?: boolean

package/lib/modules/set_fact.module.ts

@@ -35,7 +35,7 @@ declare module "../interfaces/task.interface" {
  * - `{ vars, render, deep }` for more control
  *
  * When `render` is true, string values that contain templates like `{{ ... }}` are
- * evaluated using the current `ctx.variables` scope. When `deep` is true, objects
+ * evaluated using the current context scope. When `deep` is true, objects
  * and arrays are traversed and any string leaves are evaluated similarly.
  *
  * @public
@@ -43,7 +43,7 @@ declare module "../interfaces/task.interface" {
 export type SetFactModuleOptions =
   | Record<string, unknown>
   | {
-      /** Key/value pairs to set on `ctx.variables`. */
+      /** Key/value pairs to set on the current context. */
       vars: Record<string, unknown>
       /**
        * Evaluate string templates with `evalExpr`.
@@ -72,10 +72,10 @@ export interface SetFactModuleResult extends ModuleCommonReturn {
  * Compute and set variables (facts) on the task context.
  *
  * @remarks
- * - Values are merged into `ctx.variables`.
+ * - Values are merged into current context.
  * - `changed` is true when a value is added or changed.
- * - When `render=true`, string values that contain `{{ ... }}` are evaluated via `evalExpr`
- *   with `ctx.variables` as scope. Set `deep=true` to render nested strings as well.
+ * - When `render=true`, string values that contain `{{ ... }}` are evaluated
+ *   with current context as scope. Set `deep=true` to render nested strings as well.
  *
  * @examples
  * ```yaml

package/lib/modules/template.module.ts

@@ -68,7 +68,7 @@ export interface TemplateModuleOptions {
   dest: string
 
   /**
-   * Extra variables merged **on top of** `ctx.variables` for this render only.
+   * Extra variables merged **on top of** the current context for this render only.
    * Task/target variables remain intact; these act as per-render overrides.
    */
   variables?: Record<string, any>
@@ -123,7 +123,7 @@ export interface TemplateModuleResult extends ModuleCommonReturn {
  * Render a Twig template locally and deploy the result to a file (remote for SSH, local for Local).
  *
  * @remarks
- * - Renders with the merged context of `ctx.variables` + per-call `variables`.
+ * - Renders with the current context + per-call `variables`.
  * - If {@link TemplateModuleOptions.diff_check | diff_check} is `true` (default), content is compared to avoid needless writes.
  * - On **SSH**:
  *   - Ensures parent directory via shell (`mkdir -p`).

package/package.json

@@ -2,7 +2,7 @@
   "name": "@katmer/core",
   "module": "index.ts",
   "description": "Manage your infrastructure with ease.",
-  "version": "0.0.3",
+  "version": "0.0.4-alpha.0",
   "main": "index.ts",
   "type": "module",
   "types": "index.ts",