md-template-vars 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,124 @@
+# md-template-vars
+
+A CLI tool to replace `{{variables}}` in Markdown templates with values from a YAML file.
+
+## Installation
+
+```bash
+npm install -g md-template-vars
+```
+
+Or use with npx:
+
+```bash
+npx md-template-vars ./templates ./output
+```
+
+## Usage
+
+```bash
+md-template-vars <input> <output> [options]
+```
+
+### Arguments
+
+| Argument | Description                               |
+| -------- | ----------------------------------------- |
+| `input`  | Input directory containing template files |
+| `output` | Output directory for processed files      |
+
+### Options
+
+| Option      | Default          | Description                            |
+| ----------- | ---------------- | -------------------------------------- |
+| `--vars`    | `variables.yaml` | Path to the variables YAML file        |
+| `--include` | -                | Glob pattern to include specific files |
+| `--exclude` | -                | Glob pattern to exclude specific files |
+
+## Examples
+
+### Basic usage
+
+```bash
+md-template-vars ./templates ./output
+```
+
+### Custom variables file
+
+```bash
+md-template-vars ./templates ./output --vars production.yaml
+```
+
+### Filter files
+
+```bash
+# Include only files matching pattern
+md-template-vars ./templates ./output --include "api-*.md"
+
+# Exclude files matching pattern
+md-template-vars ./templates ./output --exclude "draft-*.md"
+```
+
+## Template Syntax
+
+Use `{{variableName}}` syntax in your Markdown files:
+
+**Template (templates/hello.md):**
+```markdown
+# Hello {{name}}
+
+Welcome to {{project}}!
+```
+
+**Variables (variables.yaml):**
+```yaml
+name: World
+project: My Project
+```
+
+**Output (output/hello.md):**
+```markdown
+# Hello World
+
+Welcome to My Project!
+```
+
+### Nested Variables
+
+You can use nested objects in your variables file and access them with dot notation:
+
+**Template:**
+```markdown
+# {{app.name}}
+
+Database: {{database.host}}:{{database.port}}
+```
+
+**Variables (variables.yaml):**
+```yaml
+app:
+  name: My App
+
+database:
+  host: localhost
+  port: 5432
+```
+
+**Output:**
+```markdown
+# My App
+
+Database: localhost:5432
+```
+
+## Error Handling
+
+| Case                        | Behavior                                            |
+| --------------------------- | --------------------------------------------------- |
+| Undefined variable          | Warning is displayed, variable syntax is kept as-is |
+| Same input/output directory | Error and exit                                      |
+| Variables file not found    | Error and exit                                      |
+
+## License
+
+MIT

package/dist/domain/services/template-renderer.js

@@ -1,4 +1,4 @@
-const VARIABLE_PATTERN = /\{\{(\w+)\}\}/g;
+const VARIABLE_PATTERN = /\{\{([\w.]+)\}\}/g;
 export function renderTemplate(content, variables) {
     const undefinedVariables = [];
     const renderedContent = content.replace(VARIABLE_PATTERN, (match, varName) => {

package/dist/domain/value-objects/variables.d.ts

@@ -1,3 +1,9 @@
 import { z } from "zod";
-export declare const VariablesSchema: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, string, string | number | boolean>>;
+declare const PrimitiveValueSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+type NestedValue = z.infer<typeof PrimitiveValueSchema> | {
+    [key: string]: NestedValue;
+};
+export declare const VariablesSchema: z.ZodRecord<z.ZodString, z.ZodType<NestedValue, z.ZodTypeDef, NestedValue>>;
 export type Variables = Record<string, string>;
+export declare function flattenVariables(obj: Record<string, NestedValue>, prefix?: string): Variables;
+export {};

package/dist/domain/value-objects/variables.js

@@ -1,3 +1,17 @@
 import { z } from "zod";
-const VariableValueSchema = z.union([z.string(), z.number(), z.boolean()]).transform(String);
-export const VariablesSchema = z.record(z.string(), VariableValueSchema);
+const PrimitiveValueSchema = z.union([z.string(), z.number(), z.boolean()]);
+const NestedValueSchema = z.lazy(() => z.union([PrimitiveValueSchema, z.record(z.string(), NestedValueSchema)]));
+export const VariablesSchema = z.record(z.string(), NestedValueSchema);
+export function flattenVariables(obj, prefix = "") {
+    const result = {};
+    for (const [key, value] of Object.entries(obj)) {
+        const fullKey = prefix ? `${prefix}.${key}` : key;
+        if (typeof value === "object" && value !== null) {
+            Object.assign(result, flattenVariables(value, fullKey));
+        }
+        else {
+            result[fullKey] = String(value);
+        }
+    }
+    return result;
+}

package/dist/infrastructure/repositories/variables-repository.js

@@ -1,6 +1,6 @@
 import { readFileSync, existsSync } from "node:fs";
 import { parse } from "yaml";
-import { VariablesSchema } from "../../domain/value-objects/variables.js";
+import { VariablesSchema, flattenVariables } from "../../domain/value-objects/variables.js";
 import { VariablesFileNotFoundError, InvalidVariablesError } from "../../shared/errors.js";
 export function loadVariables(filePath) {
     if (!existsSync(filePath)) {
@@ -12,5 +12,5 @@ export function loadVariables(filePath) {
     if (!result.success) {
         throw new InvalidVariablesError(result.error.message);
     }
-    return result.data;
+    return flattenVariables(result.data);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "md-template-vars",
   "author": "Shunta Toda",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Replace {{variables}} in markdown templates with YAML values",
   "type": "module",
   "main": "./dist/application/use-cases/process-templates.js",