jsonata-w 1.0.0 → 1.0.2

package/README.md

@@ -40,11 +40,14 @@ jsonata-w transform <file>
 The JSONata file MUST start with a configuration comment block:
 
 ```javascript
-/* @config {
-  "input": "./path/to/input.json",
-  "output": "./path/to/output.json",
-  "schema": "./optional/schema.json"
-} */
+/**
+ * @config {
+ *   "input": "./path/to/input.json",
+ *   "output": "./path/to/output.json",
+ *   "schema": "./optional/schema.json",
+ *   "examples": "./path/to/example.json"
+ * }
+ */
 
 (
   /* Your JSONata expression here */
@@ -55,6 +58,7 @@ The JSONata file MUST start with a configuration comment block:
 - `input`: Path to the source JSON file (relative to the .jsonata file).
 - `output`: Path where the transformed JSON will be saved (relative to the .jsonata file).
 - `schema`: (Optional) Path to a JSON schema for validation.
+- `examples`: (Optional) Path to a JSON/YAML file containing the expected output subset for validation.
 
 #### Features
 - **Embedded Config**: No need for CLI arguments for input/output.

package/dist/cli.js

@@ -104,7 +104,8 @@ function pickSubset(data, template) {
 })
     .command('transform <file>', 'Transform JSON using a single JSONata file with embedded @config', (yargs) => {
     return yargs
-        .positional('file', { describe: 'JSONata file with embedded @config', type: 'string', demandOption: true });
+        .positional('file', { describe: 'JSONata file with embedded @config', type: 'string', demandOption: true })
+        .option('dry-run', { type: 'boolean', default: false, describe: 'Execute and validate without writing output to disk' });
 }, async (argv) => {
     try {
         const filePath = path_1.default.resolve(argv.file);
@@ -117,12 +118,14 @@ function pickSubset(data, template) {
         const resolvePath = (p) => path_1.default.resolve(fileDir, p);
         const inputPath = resolvePath(config.input);
         const outputPath = resolvePath(config.output);
-        console.log(`Loading input from ${inputPath}...`);
+        if (!argv['dry-run'])
+            console.log(`Loading input from ${inputPath}...`);
         const json = loader.load(inputPath);
-        console.log(`Executing transformation...`);
-        // Use evaluate since we already have the content
+        if (!argv['dry-run'])
+            console.log(`Executing transformation...`);
         const result = await transformer.evaluate(json, fileContent);
-        console.log(`Unflattening result...`);
+        if (!argv['dry-run'])
+            console.log(`Unflattening result...`);
         const finalResult = unflatten(result);
         if (config.schema) {
             const schemaPath = resolvePath(config.schema);
@@ -179,11 +182,40 @@ function pickSubset(data, template) {
                 console.log('✅ Example validation passed.');
             }
         }
-        const dir = path_1.default.dirname(outputPath);
-        if (!fs_1.default.existsSync(dir))
-            fs_1.default.mkdirSync(dir, { recursive: true });
-        fs_1.default.writeFileSync(outputPath, JSON.stringify(finalResult, null, 2));
-        console.log(`Transformed ${config.input} -> ${config.output}`);
+        // Determine output format based on file extension
+        const ext = path_1.default.extname(outputPath).toLowerCase();
+        let outputContent;
+        if (ext === '.yaml' || ext === '.yml') {
+            outputContent = js_yaml_1.default.dump(finalResult, { indent: 2, lineWidth: -1 });
+        }
+        else if (ext === '.json') {
+            outputContent = JSON.stringify(finalResult, null, 2);
+        }
+        else {
+            // For other extensions (e.g., .css, .txt, .js), output as string
+            if (typeof finalResult === 'string') {
+                outputContent = finalResult;
+            }
+            else if (Array.isArray(finalResult) && finalResult.every(item => typeof item === 'string')) {
+                outputContent = finalResult.join('');
+            }
+            else if (typeof finalResult === 'number' || typeof finalResult === 'boolean') {
+                outputContent = String(finalResult);
+            }
+            else {
+                outputContent = JSON.stringify(finalResult, null, 2);
+            }
+        }
+        if (argv['dry-run']) {
+            process.stdout.write(outputContent);
+        }
+        else {
+            const dir = path_1.default.dirname(outputPath);
+            if (!fs_1.default.existsSync(dir))
+                fs_1.default.mkdirSync(dir, { recursive: true });
+            fs_1.default.writeFileSync(outputPath, outputContent);
+            console.log(`Transformed ${config.input} -> ${config.output}`);
+        }
     }
     catch (e) {
         console.error(e.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonata-w",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Tool to assist AI in transforming JSON files",
   "main": "dist/index.js",
   "bin": {
@@ -20,6 +20,21 @@
   },
   "author": "",
   "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pen-drop/jsonata-w.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pen-drop/jsonata-w/issues"
+  },
+  "homepage": "https://github.com/pen-drop/jsonata-w#readme",
+  "keywords": [
+    "jsonata",
+    "json",
+    "yaml",
+    "transform",
+    "cli"
+  ],
   "dependencies": {
     "@types/jsonpath": "^0.2.4",
     "ajv": "^8.17.1",
@@ -44,4 +59,4 @@
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.51.0"
   }
-}
+}