properties-comparator 1.0.5 → 1.0.6

package/.github/workflows/sonarcloud.yml

@@ -0,0 +1,75 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow helps you trigger a SonarCloud analysis of your code and populates
+# GitHub Code Scanning alerts with the vulnerabilities found.
+# Free for open source project.
+
+# 1. Login to SonarCloud.io using your GitHub account
+
+# 2. Import your project on SonarCloud
+#     * Add your GitHub organization first, then add your repository as a new project.
+#     * Please note that many languages are eligible for automatic analysis,
+#       which means that the analysis will start automatically without the need to set up GitHub Actions.
+#     * This behavior can be changed in Administration > Analysis Method.
+#
+# 3. Follow the SonarCloud in-product tutorial
+#     * a. Copy/paste the Project Key and the Organization Key into the args parameter below
+#          (You'll find this information in SonarCloud. Click on "Information" at the bottom left)
+#
+#     * b. Generate a new token and add it to your Github repository's secrets using the name SONAR_TOKEN
+#          (On SonarCloud, click on your avatar on top-right > My account > Security
+#           or go directly to https://sonarcloud.io/account/security/)
+
+# Feel free to take a look at our documentation (https://docs.sonarcloud.io/getting-started/github/)
+# or reach out to our community forum if you need some help (https://community.sonarsource.com/c/help/sc/9)
+
+name: SonarCloud analysis
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  pull-requests: read # allows SonarCloud to decorate PRs with analysis results
+
+jobs:
+  Analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests with coverage
+        run: npm test -- --coverage
+
+      - name: Analyze with SonarCloud
+        uses: SonarSource/sonarcloud-github-action@4006f663ecaf1f8093e8e4abb9227f6041f52216
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args: -Dsonar.projectKey=zackria_properties-comparator
+            -Dsonar.organization=zackria
+            -Dsonar.sources=index.js,cli.js,src
+            -Dsonar.tests=test
+            -Dsonar.test.inclusions=test/**/*.test.js
+            -Dsonar.exclusions=node_modules/**,coverage/**,index.js
+            -Dsonar.cpd.exclusions=index.js
+            -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info
+          projectBaseDir: .

package/README.md

@@ -2,7 +2,7 @@
 
 A powerful utility for parsing and comparing **.properties** and **.yml/.yaml** files. This tool reads files as key-value pairs, compares values across multiple files, and generates detailed comparison reports in various formats.
 
-[![NPM Package](https://img.shields.io/npm/v/properties-comparator.svg)](https://www.npmjs.com/package/properties-comparator)
+[![NPM Package](https://img.shields.io/npm/v/properties-comparator.svg)](https://www.npmjs.com/package/properties-comparator)  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=zackria_properties-comparator&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=zackria_properties-comparator) 
 
 ## Features
 
@@ -79,8 +79,8 @@ This package is thoroughly tested with over 90% code coverage to ensure reliabil
 ## Compatibility
 
 Developed and tested with:
-- npm v11.1.0
-- Node.js v22.13.0
+- npm v11.7.0
+- Node.js v25.2.1
 
 ## Documentation
 

package/cli.js

@@ -2,8 +2,8 @@
 
 import { program } from 'commander';
 import { compareFiles } from './index.js';
-import { readFileSync } from 'fs';
-import path from 'path';
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
 
 // Get version from package.json
 let version = '1.0.0';
@@ -13,6 +13,7 @@ try {
   version = packageJson.version;
 } catch (err) {
   // Use default version if package.json can't be read
+  console.warn(`Warning: Could not read version from package.json (${err.message}). Using default 1.0.0`);
 }
 
 // Check if no arguments were provided
@@ -40,7 +41,7 @@ program
     try {
       // Resolve all file paths
       const resolvedPaths = files.map(file => path.resolve(file));
-      
+
       // Prepare options for compareFiles
       const comparisonOptions = {
         format: options.format || 'console',
@@ -50,7 +51,7 @@ program
 
       // Run the comparison
       compareFiles(resolvedPaths, comparisonOptions);
-      
+
     } catch (error) {
       console.error('Error:', error.message);
       process.exit(1);

package/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 import chalk from "chalk";
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import yaml from "js-yaml";
 
 /**
@@ -115,7 +115,7 @@ function parseFile(filePath) {
     default:
       console.error(
         `Warning: Unsupported file extension "${ext}" for file "${filePath}". ` +
-          `Only .properties, .yml, or .yaml are supported. This file will be treated as empty.`
+        `Only .properties, .yml, or .yaml are supported. This file will be treated as empty.`
       );
       return {};
   }
@@ -147,7 +147,7 @@ function compareFileData(filePaths) {
   // Compare values for each key across files
   allKeys.forEach((key) => {
     const values = parsedObjects.map(
-      (obj) => obj[key]?.replace(/\s+/g, "") || "N/A"
+      (obj) => obj[key]?.replaceAll(/\s+/g, "") || "N/A"
     );
     const matched = values.every((value) => value === values[0]);
     mismatchDetails.push({ key, values, matched });
@@ -224,10 +224,10 @@ function generateHtmlReport(filePaths, comparisonData) {
     <h2>Files Compared:</h2>
     <ol>
       ${fileNames
-        .map(
-          (name, idx) => `<li>${name} <small>(${filePaths[idx]})</small></li>`
-        )
-        .join("\n      ")}
+      .map(
+        (name, idx) => `<li>${name} <small>(${filePaths[idx]})</small></li>`
+      )
+      .join("\n      ")}
     </ol>
   </div>
 
@@ -237,8 +237,8 @@ function generateHtmlReport(filePaths, comparisonData) {
       <th>Key</th>
       <th>Matched</th>
       ${fileNames
-        .map((name, idx) => `<th>File ${idx + 1}: ${name}</th>`)
-        .join("\n      ")}
+      .map((name, idx) => `<th>File ${idx + 1}: ${name}</th>`)
+      .join("\n      ")}
     </tr>`;
 
   // Add table rows for each key
@@ -250,9 +250,8 @@ function generateHtmlReport(filePaths, comparisonData) {
     // Add values from each file
     values.forEach((value, idx) => {
       const cellClass = matched ? "" : "value-mismatch";
-      html += `\n      <td class="${cellClass}">${
-        value === "N/A" ? "<em>N/A</em>" : value
-      }</td>`;
+      html += `\n      <td class="${cellClass}">${value === "N/A" ? "<em>N/A</em>" : value
+        }</td>`;
     });
 
     html += `\n    </tr>`;
@@ -268,9 +267,9 @@ function generateHtmlReport(filePaths, comparisonData) {
   } else {
     html += `\n    <p>${mismatchCount} key(s) have mismatched values.</p>
     <p><strong>Mismatched keys:</strong> ${mismatchDetails
-      .filter((detail) => !detail.matched)
-      .map((detail) => detail.key)
-      .join(", ")}</p>`;
+        .filter((detail) => !detail.matched)
+        .map((detail) => detail.key)
+        .join(", ")}</p>`;
   }
 
   html += `\n  </div>
@@ -419,46 +418,67 @@ function compareFiles(filePaths, options = {}) {
 }
 
 /**
- * CLI entry point for comparing .properties and .yml/.yaml files.
+ * Prints the usage information for the CLI.
  */
-function run() {
-  const args = process.argv.slice(2);
+function printUsage() {
+  console.error("Please provide file paths as command-line arguments.");
+  console.error(
+    "Usage: properties-comparator [options] file1 file2 [file3...]"
+  );
+  console.error("Options:");
+  console.error(
+    "  --format, -f <format>   Output format: console, html, or markdown"
+  );
+  console.error(
+    "  --output, -o <file>     Output file for html or markdown reports"
+  );
+}
+
+/**
+ * Parses command-line arguments.
+ * @param {string[]} args - Array of command-line arguments.
+ * @returns {{ filePaths: string[], options: Object }} - Parsed paths and options.
+ */
+function parseArgs(args) {
   const options = {
     format: "console",
     outputFile: null,
   };
-
-  // Parse arguments for format and output file
   const filePaths = [];
-  for (let i = 0; i < args.length; i++) {
+
+  let i = 0;
+  while (i < args.length) {
     if (args[i] === "--format" || args[i] === "-f") {
       if (i + 1 < args.length) {
         options.format = args[i + 1].toLowerCase();
-        i++; // Skip the next argument as it's the format value
+        i += 2;
+      } else {
+        i++;
       }
     } else if (args[i] === "--output" || args[i] === "-o") {
       if (i + 1 < args.length) {
         options.outputFile = args[i + 1];
-        i++; // Skip the next argument as it's the output file path
+        i += 2;
+      } else {
+        i++;
       }
     } else {
-      // Not an option, treat as file path
       filePaths.push(path.resolve(args[i]));
+      i++;
     }
   }
 
+  return { filePaths, options };
+}
+
+/**
+ * CLI entry point for comparing .properties and .yml/.yaml files.
+ */
+function run() {
+  const { filePaths, options } = parseArgs(process.argv.slice(2));
+
   if (filePaths.length === 0) {
-    console.error("Please provide file paths as command-line arguments.");
-    console.error(
-      "Usage: properties-comparator [options] file1 file2 [file3...]"
-    );
-    console.error("Options:");
-    console.error(
-      "  --format, -f <format>   Output format: console, html, or markdown"
-    );
-    console.error(
-      "  --output, -o <file>     Output file for html or markdown reports"
-    );
+    printUsage();
     process.exit(1);
   } else if (filePaths.length === 1) {
     console.error("Please provide at least two file paths for comparison.");
@@ -481,27 +501,27 @@ function run() {
  * @param {Object} options - Comparison options
  * @returns {Object} Comparison results in a structured format
  */
-async function compareProperties(file1, file2, options = {}) {
+function compareProperties(file1, file2, options = {}) {
   const filePaths = [file1, file2];
   const comparisonData = compareFileData(filePaths);
-  
+
   // Process the output based on options
   if (options.output) {
     if (options.json) {
       fs.writeFileSync(options.output, JSON.stringify(comparisonData, null, 2));
     } else {
       const format = path.extname(options.output).toLowerCase() === '.md' ? 'markdown' : 'html';
-      const report = format === 'markdown' 
-        ? generateMarkdownReport(filePaths, comparisonData) 
+      const report = format === 'markdown'
+        ? generateMarkdownReport(filePaths, comparisonData)
         : generateHtmlReport(filePaths, comparisonData);
       fs.writeFileSync(options.output, report);
     }
-    
+
     if (options.verbose) {
       console.log(`Comparison report saved to ${options.output}`);
     }
   }
-  
+
   return comparisonData;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "properties-comparator",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "This utility provides functionality to parse and compare properties files in the format of key-value pairs. It reads properties files, compares the values for each key across multiple files, and logs the results.",
   "type": "module",
   "main": "index.js",
@@ -9,7 +9,8 @@
   },
   "scripts": {
     "test": "jest",
-    "run": "node index.js"
+    "run": "node index.js",
+    "clean": "rm -rf node_modules coverage"
   },
   "repository": {
     "type": "git",
@@ -28,15 +29,18 @@
   },
   "homepage": "https://github.com/zackria/properties-comparator#readme",
   "dependencies": {
-    "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "js-yaml": "^4.1.0"
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "js-yaml": "^4.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
-    "babel-jest": "^29.7.0",
-    "jest": "^29.7.0",
-    "jest-environment-node": "^29.7.0"
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "babel-jest": "^30.2.0",
+    "jest": "^30.2.0",
+    "jest-environment-node": "^30.2.0"
+  },
+  "overrides": {
+    "test-exclude": "^7.0.1"
   }
-}
+}

package/sonar-project.properties

@@ -0,0 +1,19 @@
+sonar.projectKey=zackria_properties-comparator
+sonar.organization=zackria
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=properties-comparator
+#sonar.projectVersion=1.0.6
+
+# Path is relative to the sonarproject.properties file. Replace "\" by "/" on Windows.
+sonar.sources=index.js,cli.js,src
+sonar.tests=test
+sonar.test.inclusions=test/**/*.test.js
+
+# Encoding of the source code. Default is default system encoding
+sonar.sourceEncoding=UTF-8
+
+# JavaScript-specific configurations
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.exclusions=node_modules/**, coverage/**, index.js
+sonar.cpd.exclusions=index.js

package/src/compareUtility.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 import chalk from "chalk";
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import yaml from "js-yaml";
 
 /**
@@ -115,7 +115,7 @@ function parseFile(filePath) {
     default:
       console.error(
         `Warning: Unsupported file extension "${ext}" for file "${filePath}". ` +
-          `Only .properties, .yml, or .yaml are supported. This file will be treated as empty.`
+        `Only .properties, .yml, or .yaml are supported. This file will be treated as empty.`
       );
       return {};
   }
@@ -147,7 +147,7 @@ function compareFileData(filePaths) {
   // Compare values for each key across files
   allKeys.forEach((key) => {
     const values = parsedObjects.map(
-      (obj) => obj[key]?.replace(/\s+/g, "") || "N/A"
+      (obj) => obj[key]?.replaceAll(/\s+/g, "") || "N/A"
     );
     const matched = values.every((value) => value === values[0]);
     mismatchDetails.push({ key, values, matched });
@@ -224,10 +224,10 @@ function generateHtmlReport(filePaths, comparisonData) {
     <h2>Files Compared:</h2>
     <ol>
       ${fileNames
-        .map(
-          (name, idx) => `<li>${name} <small>(${filePaths[idx]})</small></li>`
-        )
-        .join("\n      ")}
+      .map(
+        (name, idx) => `<li>${name} <small>(${filePaths[idx]})</small></li>`
+      )
+      .join("\n      ")}
     </ol>
   </div>
 
@@ -237,8 +237,8 @@ function generateHtmlReport(filePaths, comparisonData) {
       <th>Key</th>
       <th>Matched</th>
       ${fileNames
-        .map((name, idx) => `<th>File ${idx + 1}: ${name}</th>`)
-        .join("\n      ")}
+      .map((name, idx) => `<th>File ${idx + 1}: ${name}</th>`)
+      .join("\n      ")}
     </tr>`;
 
   // Add table rows for each key
@@ -250,9 +250,8 @@ function generateHtmlReport(filePaths, comparisonData) {
     // Add values from each file
     values.forEach((value, idx) => {
       const cellClass = matched ? "" : "value-mismatch";
-      html += `\n      <td class="${cellClass}">${
-        value === "N/A" ? "<em>N/A</em>" : value
-      }</td>`;
+      html += `\n      <td class="${cellClass}">${value === "N/A" ? "<em>N/A</em>" : value
+        }</td>`;
     });
 
     html += `\n    </tr>`;
@@ -268,9 +267,9 @@ function generateHtmlReport(filePaths, comparisonData) {
   } else {
     html += `\n    <p>${mismatchCount} key(s) have mismatched values.</p>
     <p><strong>Mismatched keys:</strong> ${mismatchDetails
-      .filter((detail) => !detail.matched)
-      .map((detail) => detail.key)
-      .join(", ")}</p>`;
+        .filter((detail) => !detail.matched)
+        .map((detail) => detail.key)
+        .join(", ")}</p>`;
   }
 
   html += `\n  </div>
@@ -419,46 +418,67 @@ function compareFiles(filePaths, options = {}) {
 }
 
 /**
- * CLI entry point for comparing .properties and .yml/.yaml files.
+ * Prints the usage information for the CLI.
  */
-function run() {
-  const args = process.argv.slice(2);
+function printUsage() {
+  console.error("Please provide file paths as command-line arguments.");
+  console.error(
+    "Usage: properties-comparator [options] file1 file2 [file3...]"
+  );
+  console.error("Options:");
+  console.error(
+    "  --format, -f <format>   Output format: console, html, or markdown"
+  );
+  console.error(
+    "  --output, -o <file>     Output file for html or markdown reports"
+  );
+}
+
+/**
+ * Parses command-line arguments.
+ * @param {string[]} args - Array of command-line arguments.
+ * @returns {{ filePaths: string[], options: Object }} - Parsed paths and options.
+ */
+function parseArgs(args) {
   const options = {
     format: "console",
     outputFile: null,
   };
-
-  // Parse arguments for format and output file
   const filePaths = [];
-  for (let i = 0; i < args.length; i++) {
+
+  let i = 0;
+  while (i < args.length) {
     if (args[i] === "--format" || args[i] === "-f") {
       if (i + 1 < args.length) {
         options.format = args[i + 1].toLowerCase();
-        i++; // Skip the next argument as it's the format value
+        i += 2;
+      } else {
+        i++;
       }
     } else if (args[i] === "--output" || args[i] === "-o") {
       if (i + 1 < args.length) {
         options.outputFile = args[i + 1];
-        i++; // Skip the next argument as it's the output file path
+        i += 2;
+      } else {
+        i++;
       }
     } else {
-      // Not an option, treat as file path
       filePaths.push(path.resolve(args[i]));
+      i++;
     }
   }
 
+  return { filePaths, options };
+}
+
+/**
+ * CLI entry point for comparing .properties and .yml/.yaml files.
+ */
+function run() {
+  const { filePaths, options } = parseArgs(process.argv.slice(2));
+
   if (filePaths.length === 0) {
-    console.error("Please provide file paths as command-line arguments.");
-    console.error(
-      "Usage: properties-comparator [options] file1 file2 [file3...]"
-    );
-    console.error("Options:");
-    console.error(
-      "  --format, -f <format>   Output format: console, html, or markdown"
-    );
-    console.error(
-      "  --output, -o <file>     Output file for html or markdown reports"
-    );
+    printUsage();
     process.exit(1);
   } else if (filePaths.length === 1) {
     console.error("Please provide at least two file paths for comparison.");
@@ -481,27 +501,27 @@ function run() {
  * @param {Object} options - Comparison options
  * @returns {Object} Comparison results in a structured format
  */
-async function compareProperties(file1, file2, options = {}) {
+function compareProperties(file1, file2, options = {}) {
   const filePaths = [file1, file2];
   const comparisonData = compareFileData(filePaths);
-  
+
   // Process the output based on options
   if (options.output) {
     if (options.json) {
       fs.writeFileSync(options.output, JSON.stringify(comparisonData, null, 2));
     } else {
       const format = path.extname(options.output).toLowerCase() === '.md' ? 'markdown' : 'html';
-      const report = format === 'markdown' 
-        ? generateMarkdownReport(filePaths, comparisonData) 
+      const report = format === 'markdown'
+        ? generateMarkdownReport(filePaths, comparisonData)
         : generateHtmlReport(filePaths, comparisonData);
       fs.writeFileSync(options.output, report);
     }
-    
+
     if (options.verbose) {
       console.log(`Comparison report saved to ${options.output}`);
     }
   }
-  
+
   return comparisonData;
 }