@aspruyt/json-config-sync 3.8.0 → 3.10.0

package/README.md

@@ -5,7 +5,7 @@
 [![npm downloads](https://img.shields.io/npm/dw/@aspruyt/json-config-sync.svg)](https://www.npmjs.com/package/@aspruyt/json-config-sync)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
-A CLI tool that syncs JSON, YAML, or text configuration files across multiple GitHub and Azure DevOps repositories by creating pull requests. Output format is automatically detected from the target filename extension (`.json` → JSON, `.yaml`/`.yml` → YAML, other → text).
+A CLI tool that syncs JSON, JSON5, YAML, or text configuration files across multiple GitHub and Azure DevOps repositories by creating pull requests. Output format is automatically detected from the target filename extension (`.json` → JSON, `.json5` → JSON5, `.yaml`/`.yml` → YAML, other → text).
 
 ## Table of Contents
 
@@ -536,7 +536,7 @@ repos:
 - **String content** (`content: |-`) - Direct text output with environment variable interpolation. Merging always replaces the base.
 - **Lines array** (`content: ['line1', 'line2']`) - Each line joined with newlines. Supports merge strategies (`append`, `prepend`, `replace`).
 
-**Validation:** JSON/YAML file extensions (`.json`, `.yaml`, `.yml`) require object content. Other extensions require string or string[] content.
+**Validation:** JSON/JSON5/YAML file extensions (`.json`, `.json5`, `.yaml`, `.yml`) require object content. Other extensions require string or string[] content.
 
 ### Executable Files
 
@@ -630,7 +630,7 @@ repos:
 
 - File references start with `@` followed by a relative path
 - Paths are resolved relative to the config file's directory
-- JSON/YAML files are parsed as objects, other files as strings
+- JSON/JSON5/YAML files are parsed as objects, other files as strings
 - Metadata fields (`header`, `schemaUrl`, `createOnly`, `mergeStrategy`) remain in the config
 - Per-repo overlays still work - they merge onto the resolved file content
 
@@ -728,7 +728,7 @@ flowchart TB
 
     subgraph Processing["For Each Repository"]
         CLONE[Clone Repo] --> BRANCH[Create/Checkout Branch<br/>--branch or chore/sync-config]
-        BRANCH --> WRITE[Write All Config Files<br/>JSON or YAML]
+        BRANCH --> WRITE[Write All Config Files<br/>JSON, JSON5, or YAML]
         WRITE --> CHECK{Changes?}
         CHECK -->|No| SKIP[Skip - No Changes]
         CHECK -->|Yes| COMMIT[Commit Changes]
@@ -758,7 +758,7 @@ For each repository in the config, the tool:
 4. Cleans the temporary workspace
 5. Clones the repository
 6. Creates/checks out branch (custom `--branch` or default `chore/sync-config`)
-7. Writes all config files (JSON or YAML based on filename extension)
+7. Writes all config files (JSON, JSON5, or YAML based on filename extension)
 8. Checks for changes (skips if no changes)
 9. Commits and pushes changes
 10. Creates a pull request

package/dist/config-formatter.d.ts

@@ -1,4 +1,4 @@
-export type OutputFormat = "json" | "yaml";
+export type OutputFormat = "json" | "json5" | "yaml";
 /**
  * Options for content conversion.
  */

package/dist/config-formatter.js

@@ -7,6 +7,9 @@ export function detectOutputFormat(fileName) {
     if (ext === "yaml" || ext === "yml") {
         return "yaml";
     }
+    if (ext === "json5") {
+        return "json5";
+    }
     return "json";
 }
 /**
@@ -87,6 +90,11 @@ export function convertContentToString(content, fileName, options) {
         }
         return stringify(doc, { indent: 2 });
     }
+    if (format === "json5") {
+        // JSON5 format - output standard JSON (which is valid JSON5)
+        // Using JSON.stringify for standard JSON output that's compatible everywhere
+        return JSON.stringify(content, null, 2) + "\n";
+    }
     // JSON format - comments not supported, ignore header/schemaUrl
     return JSON.stringify(content, null, 2) + "\n";
 }

package/dist/config-validator.js

@@ -19,7 +19,7 @@ function isObjectContent(content) {
  */
 function isStructuredFileExtension(fileName) {
     const ext = fileName.toLowerCase().split(".").pop();
-    return ext === "json" || ext === "yaml" || ext === "yml";
+    return ext === "json" || ext === "json5" || ext === "yaml" || ext === "yml";
 }
 /**
  * Validates raw config structure before normalization.

package/dist/file-reference-resolver.js

@@ -1,5 +1,6 @@
 import { readFileSync } from "node:fs";
 import { resolve, isAbsolute, normalize, extname } from "node:path";
+import JSON5 from "json5";
 import { parse as parseYaml } from "yaml";
 /**
  * Check if a value is a file reference (string starting with @)
@@ -52,6 +53,15 @@ export function resolveFileReference(reference, configDir) {
             throw new Error(`Invalid JSON in "${reference}": ${msg}`);
         }
     }
+    if (ext === ".json5") {
+        try {
+            return JSON5.parse(content);
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            throw new Error(`Invalid JSON5 in "${reference}": ${msg}`);
+        }
+    }
     if (ext === ".yaml" || ext === ".yml") {
         try {
             return parseYaml(content);

package/dist/index.js

@@ -26,14 +26,14 @@ program
     .option("-w, --work-dir <path>", "Temporary directory for cloning", "./tmp")
     .option("-r, --retries <number>", "Number of retries for network operations (0 to disable)", (v) => parseInt(v, 10), 3)
     .option("-b, --branch <name>", "Override the branch name (default: chore/sync-{filename} or chore/sync-config)")
-    .option("-m, --merge <mode>", "PR merge mode: manual (default), auto (merge when checks pass), force (bypass requirements)", (value) => {
+    .option("-m, --merge <mode>", "PR merge mode: manual, auto (default, merge when checks pass), force (bypass requirements)", (value) => {
     const valid = ["manual", "auto", "force"];
     if (!valid.includes(value)) {
         throw new Error(`Invalid merge mode: ${value}. Valid: ${valid.join(", ")}`);
     }
     return value;
 })
-    .option("--merge-strategy <strategy>", "Merge strategy: merge (default), squash, rebase", (value) => {
+    .option("--merge-strategy <strategy>", "Merge strategy: merge, squash (default), rebase", (value) => {
     const valid = ["merge", "squash", "rebase"];
     if (!valid.includes(value)) {
         throw new Error(`Invalid merge strategy: ${value}. Valid: ${valid.join(", ")}`);

package/dist/repository-processor.js

@@ -143,14 +143,14 @@ export class RepositoryProcessor {
                 retries,
             });
             // Step 10: Handle merge options if configured
-            const mergeMode = repoConfig.prOptions?.merge ?? "manual";
+            const mergeMode = repoConfig.prOptions?.merge ?? "auto";
             let mergeResult;
             if (prResult.success && prResult.url && mergeMode !== "manual") {
                 this.log.info(`Handling merge (mode: ${mergeMode})...`);
                 const mergeConfig = {
                     mode: mergeMode,
-                    strategy: repoConfig.prOptions?.mergeStrategy,
-                    deleteBranch: repoConfig.prOptions?.deleteBranch,
+                    strategy: repoConfig.prOptions?.mergeStrategy ?? "squash",
+                    deleteBranch: repoConfig.prOptions?.deleteBranch ?? true,
                     bypassReason: repoConfig.prOptions?.bypassReason,
                 };
                 const result = await mergePR({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/json-config-sync",
-  "version": "3.8.0",
+  "version": "3.10.0",
   "description": "CLI tool to sync JSON or YAML configuration files across multiple GitHub and Azure DevOps repositories",
   "type": "module",
   "main": "dist/index.js",
@@ -46,6 +46,7 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^14.0.2",
+    "json5": "^2.2.3",
     "p-retry": "^7.1.1",
     "yaml": "^2.4.5"
   },