docvars 0.3.0 → 0.3.2

package/README.md

@@ -31,16 +31,16 @@ docvars <input> <output> [options]
 
 ### 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              |
-| `--watch`       | `false`          | Watch for file changes and rebuild automatically    |
-| `--rename-from` | -                | Variable name to rename from (use with --rename-to) |
-| `--rename-to`   | -                | Variable name to rename to (use with --rename-from) |
-| `--list-vars`   | `false`          | List all variables used in templates                |
-| `--dry-run`     | `false`          | Preview changes without writing files               |
+| Option          | Alias | Default          | Description                                         |
+| --------------- | ----- | ---------------- | --------------------------------------------------- |
+| `--vars`        | `-v`  | `variables.yaml` | Path to the variables YAML file                     |
+| `--only`        | `-o`  | `**/*`           | Glob pattern to filter files (e.g. **/*.md)         |
+| `--exclude`     | `-e`  | -                | Glob pattern to exclude specific files              |
+| `--watch`       | `-w`  | `false`          | Watch for file changes and rebuild automatically    |
+| `--rename-from` | `-r`  | -                | Variable name to rename from (use with --rename-to) |
+| `--rename-to`   | `-t`  | -                | Variable name to rename to (use with --rename-from) |
+| `--list-vars`   | `-l`  | `false`          | List all variables used in templates                |
+| `--dry-run`     | `-d`  | `false`          | Preview changes without writing files               |
 
 ## Examples
 
@@ -59,24 +59,51 @@ docvars ./templates ./output --vars production.yaml
 ### Filter files
 
 ```bash
-# Include only files matching pattern
-docvars ./templates ./output --include "api-*.md"
+# Process only markdown files
+docvars ./templates ./output --only "**/*.md"
+
+# Process multiple file types
+docvars ./templates ./output --only "**/*.{md,html,txt}"
+
+# Process only files matching pattern
+docvars ./templates ./output --only "api-*.md"
 
 # Exclude files matching pattern
 docvars ./templates ./output --exclude "draft-*.md"
 ```
 
+By default, all text files are processed (binary files like images are automatically excluded).
+
 ### Watch mode
 
 ```bash
 docvars ./templates ./output --watch
 ```
 
-This will watch for changes in:
-- Template files in the input directory
-- The variables YAML file
+Output:
+
+```
+👁 Watch mode enabled
 
-When changes are detected, templates are automatically rebuilt.
+┌───────────┬─────────────────────────┐
+│ Templates │ /path/to/templates      │
+│ Variables │ /path/to/variables.yaml │
+└───────────┴─────────────────────────┘
+
+Waiting for changes... (Ctrl+C to stop)
+
+👀 Change detected: README.md (change)
+
+✨ Build complete
+
+┌───────────┬────────┐
+│ File      │ Status │
+├───────────┼────────┤
+│ README.md │ ✓ done │
+└───────────┴────────┘
+
+Processed: 1 file(s)
+```
 
 ### Rename variables
 
@@ -90,9 +117,21 @@ docvars ./templates ./output --rename-from "name" --rename-to "title"
 docvars ./templates ./output --rename-from "database.host" --rename-to "db.host"
 ```
 
-This updates:
-- All `{{oldName}}` occurrences in template files → `{{newName}}`
-- The key in the variables YAML file
+Output:
+
+```
+✏️  Rename complete
+   database.host → db.host
+
+┌────────────────┬───────────┐
+│ File           │ Status    │
+├────────────────┼───────────┤
+│ variables.yaml │ ✓ updated │
+│ README.md      │ ✓ updated │
+└────────────────┴───────────┘
+
+Updated: 2 file(s)
+```
 
 ### List variables
 
@@ -105,17 +144,20 @@ docvars ./templates ./output --list-vars
 Output:
 
 ```
-Variables used in templates:
+📋 Variables
 
-  app.name (✓)
-    → README.md
-    → config.md
-  api.key (✗ undefined)
-    → config.md
+┌─────────────────┬─────────────┬───────────┐
+│ Variable        │ Status      │ Used in   │
+├─────────────────┼─────────────┼───────────┤
+│ app.name        │ ✓ defined   │ README.md │
+│ api.key         │ ✗ undefined │ config.md │
+└─────────────────┴─────────────┴───────────┘
 
-Unused variables (defined but not used):
+⚠ Unused variables (defined but not used):
 
   deprecated.setting
+
+Summary: 1 defined · 1 undefined · 1 unused
 ```
 
 ### Dry run
@@ -129,19 +171,18 @@ docvars ./templates ./output --dry-run
 Output:
 
 ```
-Dry run - no files written
-
-Files to create (1):
-  + config.md
-
-Files to update (2):
-  ~ README.md
-  ~ api.md
+🔍 Dry run - no files written
 
-Files unchanged (1):
-  = changelog.md
+┌──────────────┬─────────────┐
+│ File         │ Status      │
+├──────────────┼─────────────┤
+│ config.md    │ + create    │
+│ README.md    │ ~ update    │
+│ api.md       │ ~ update    │
+│ changelog.md │ = unchanged │
+└──────────────┴─────────────┘
 
-Summary: 1 create, 2 update, 1 unchanged
+Summary: 1 create · 2 update · 1 unchanged
 ```
 
 ## Template Syntax

package/dist/application/use-cases/dry-run.js

@@ -13,7 +13,7 @@ export async function dryRun(options) {
     }
     const variables = loadVariables(options.vars);
     const files = await scanTemplates(inputDir, {
-        include: options.include,
+        only: options.only,
         exclude: options.exclude,
     });
     const changes = [];

package/dist/application/use-cases/list-variables.d.ts

@@ -1,7 +1,7 @@
 export interface ListVariablesOptions {
     input: string;
     vars: string;
-    include?: string;
+    only?: string;
     exclude?: string;
 }
 export interface VariableUsage {

package/dist/application/use-cases/list-variables.js

@@ -5,7 +5,7 @@ import { loadVariables } from "../../infrastructure/repositories/variables-repos
 import { VariablesFileNotFoundError } from "../../shared/errors.js";
 const VARIABLE_PATTERN = /\{\{([\w.]+)\}\}/g;
 export async function listVariables(options) {
-    const { input, vars, include, exclude } = options;
+    const { input, vars, only, exclude } = options;
     if (!existsSync(vars)) {
         throw new VariablesFileNotFoundError(vars);
     }
@@ -13,7 +13,7 @@ export async function listVariables(options) {
     const definedVars = loadVariables(vars);
     const definedVarNames = new Set(Object.keys(definedVars));
     // Scan templates and extract variable usage
-    const templateFiles = await scanTemplates(input, { include, exclude });
+    const templateFiles = await scanTemplates(input, { only, exclude });
     const variableUsageMap = new Map();
     for (const file of templateFiles) {
         const content = readFileSync(file, "utf-8");

package/dist/application/use-cases/process-templates.js

@@ -12,7 +12,7 @@ export async function processTemplates(options) {
     }
     const variables = loadVariables(options.vars);
     const files = await scanTemplates(inputDir, {
-        include: options.include,
+        only: options.only,
         exclude: options.exclude,
     });
     const processedFiles = [];

package/dist/application/use-cases/rename-variable.d.ts

@@ -3,7 +3,7 @@ export interface RenameOptions {
     vars: string;
     from: string;
     to: string;
-    include?: string;
+    only?: string;
     exclude?: string;
 }
 export interface RenameResult {

package/dist/application/use-cases/rename-variable.js

@@ -6,7 +6,7 @@ function escapeRegex(str) {
     return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 export async function renameVariable(options) {
-    const { input, vars, from, to, include, exclude } = options;
+    const { input, vars, from, to, only, exclude } = options;
     if (!existsSync(vars)) {
         throw new VariablesFileNotFoundError(vars);
     }
@@ -15,7 +15,7 @@ export async function renameVariable(options) {
         renamedInVars: false,
     };
     // Rename in template files
-    const templateFiles = await scanTemplates(input, { include, exclude });
+    const templateFiles = await scanTemplates(input, { only, exclude });
     const pattern = new RegExp(`\\{\\{${escapeRegex(from)}(\\}\\}|\\|)`, "g");
     for (const file of templateFiles) {
         const content = readFileSync(file, "utf-8");

package/dist/infrastructure/services/file-scanner.d.ts

@@ -1,5 +1,5 @@
 export interface ScanOptions {
-    include?: string;
+    only?: string;
     exclude?: string;
 }
 export declare function scanTemplates(inputDir: string, options?: ScanOptions): Promise<string[]>;

package/dist/infrastructure/services/file-scanner.js

@@ -1,8 +1,39 @@
 import fg from "fast-glob";
+// Binary and non-text files to ignore by default
+const DEFAULT_IGNORE = [
+    "**/*.png",
+    "**/*.jpg",
+    "**/*.jpeg",
+    "**/*.gif",
+    "**/*.webp",
+    "**/*.ico",
+    "**/*.svg",
+    "**/*.pdf",
+    "**/*.zip",
+    "**/*.tar",
+    "**/*.gz",
+    "**/*.exe",
+    "**/*.dll",
+    "**/*.so",
+    "**/*.dylib",
+    "**/*.woff",
+    "**/*.woff2",
+    "**/*.ttf",
+    "**/*.eot",
+    "**/*.mp3",
+    "**/*.mp4",
+    "**/*.wav",
+    "**/*.avi",
+    "**/*.mov",
+    "**/node_modules/**",
+    "**/.git/**",
+    "**/.DS_Store",
+];
 export async function scanTemplates(inputDir, options = {}) {
-    const pattern = options.include
-        ? `${inputDir}/${options.include}`
-        : `${inputDir}/**/*.md`;
-    const ignore = options.exclude ? [`${inputDir}/${options.exclude}`] : [];
-    return fg(pattern, { ignore });
+    const pattern = options.only ? `${inputDir}/${options.only}` : `${inputDir}/**/*`;
+    const ignore = [
+        ...DEFAULT_IGNORE.map((p) => `${inputDir}/${p}`),
+        ...(options.exclude ? [`${inputDir}/${options.exclude}`] : []),
+    ];
+    return fg(pattern, { ignore, onlyFiles: true });
 }

package/dist/presentation/cli/commands/main.d.ts

@@ -11,37 +11,45 @@ export declare const mainCommand: import("citty").CommandDef<{
     };
     vars: {
         type: "string";
+        alias: string;
         description: string;
         default: string;
     };
-    include: {
+    only: {
         type: "string";
+        alias: string;
         description: string;
     };
     exclude: {
         type: "string";
+        alias: string;
         description: string;
     };
     watch: {
         type: "boolean";
+        alias: string;
         description: string;
         default: false;
     };
     "rename-from": {
         type: "string";
+        alias: string;
         description: string;
     };
     "rename-to": {
         type: "string";
+        alias: string;
         description: string;
     };
     "list-vars": {
         type: "boolean";
+        alias: string;
         description: string;
         default: false;
     };
     "dry-run": {
         type: "boolean";
+        alias: string;
         description: string;
         default: false;
     };

package/dist/presentation/cli/commands/main.js

@@ -89,37 +89,45 @@ export const mainCommand = defineCommand({
         },
         vars: {
             type: "string",
+            alias: "v",
             description: "Path to variables YAML file",
             default: "variables.yaml",
         },
-        include: {
+        only: {
             type: "string",
-            description: "Glob pattern to include files",
+            alias: "o",
+            description: "Glob pattern to filter files (e.g. **/*.md)",
         },
         exclude: {
             type: "string",
+            alias: "e",
             description: "Glob pattern to exclude files",
         },
         watch: {
             type: "boolean",
+            alias: "w",
             description: "Watch for file changes and rebuild automatically",
             default: false,
         },
         "rename-from": {
             type: "string",
+            alias: "r",
             description: "Variable name to rename from (use with --rename-to)",
         },
         "rename-to": {
             type: "string",
+            alias: "t",
             description: "Variable name to rename to (use with --rename-from)",
         },
         "list-vars": {
             type: "boolean",
+            alias: "l",
             description: "List all variables used in templates",
             default: false,
         },
         "dry-run": {
             type: "boolean",
+            alias: "d",
             description: "Preview changes without writing files",
             default: false,
         },
@@ -132,7 +140,7 @@ export const mainCommand = defineCommand({
                     input: args.input,
                     output: args.output,
                     vars: args.vars,
-                    include: args.include,
+                    only: args.only,
                     exclude: args.exclude,
                 });
                 console.log(pc.bold(pc.cyan("\n🔍 Dry run - no files written\n")));
@@ -194,7 +202,7 @@ export const mainCommand = defineCommand({
                 const result = await listVariables({
                     input: args.input,
                     vars: args.vars,
-                    include: args.include,
+                    only: args.only,
                     exclude: args.exclude,
                 });
                 console.log(pc.bold(pc.cyan("\n📋 Variables\n")));
@@ -252,7 +260,7 @@ export const mainCommand = defineCommand({
                     vars: args.vars,
                     from: args["rename-from"],
                     to: args["rename-to"],
-                    include: args.include,
+                    only: args.only,
                     exclude: args.exclude,
                 });
                 if (result.renamedInFiles.length === 0 && !result.renamedInVars) {
@@ -294,7 +302,7 @@ export const mainCommand = defineCommand({
             input: args.input,
             output: args.output,
             vars: args.vars,
-            include: args.include,
+            only: args.only,
             exclude: args.exclude,
         };
         const success = await runProcess(options);

package/dist/shared/types.d.ts

@@ -2,7 +2,7 @@ export interface CliOptions {
     input: string;
     output: string;
     vars: string;
-    include?: string;
+    only?: string;
     exclude?: string;
 }
 export interface ProcessResult {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docvars",
   "author": "Shunta Toda",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Replace {{variables}} in document templates with YAML values",
   "type": "module",
   "main": "./dist/application/use-cases/process-templates.js",