config-js-parser 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Krishnamurthy G B
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# config-parser
+config-parser parses config to json and json to config text
+
+```
+
+const {
+    convertConfigToJson,
+    convertJsonToConfig
+} = require("config-js-parser")
+
+// --- Execution Example ---
+
+const sourceConfig = 'App.config';
+const outputJson = 'settings.json';
+const reconstructedConfig = 'App.updated.config';
+
+// Example usage:
+async function runConversion() {
+    // 1. Convert Config -> JSON
+    await convertConfigToJson(sourceConfig, outputJson);
+    
+    // 2. Convert JSON -> Config
+    await convertJsonToConfig(outputJson, reconstructedConfig);
+}
+
+runConversion();
+
+```

package/demos/demos.config.json.js

@@ -0,0 +1,20 @@
+const {
+    convertConfigToJson,
+    convertJsonToConfig
+} = require("../index")
+// --- Execution Example ---
+
+const sourceConfig = 'App.config';
+const outputJson = 'settings.json';
+const reconstructedConfig = 'App.updated.config';
+
+// Example usage:
+async function runConversion() {
+    // 1. Convert Config -> JSON
+    await convertConfigToJson(sourceConfig, outputJson);
+    
+    // 2. Convert JSON -> Config
+    await convertJsonToConfig(outputJson, reconstructedConfig);
+}
+
+runConversion();

package/index.js

@@ -0,0 +1,52 @@
+const fs = require('fs');
+const xml2js = require('xml2js');
+
+/**
+ * Converts a .config (XML) file to a JSON file.
+ * @param {string} configFilePath - Path to the source .config file.
+ * @param {string} jsonDestinationPath - Path where the JSON should be saved.
+ */
+async function convertConfigToJson(configFilePath, jsonDestinationPath) {
+    try {
+        // Read the .config file (XML format)
+        const configFileContent = fs.readFileSync(configFilePath, 'utf-8');
+        
+        // explicitArray: false prevents single elements from being wrapped in arrays
+        const parser = new xml2js.Parser({ explicitArray: false });
+
+        const result = await parser.parseStringPromise(configFileContent);
+        const jsonContent = JSON.stringify(result, null, 4);
+
+        fs.writeFileSync(jsonDestinationPath, jsonContent, 'utf-8');
+        console.log(`Successfully converted ${configFilePath} to ${jsonDestinationPath}`);
+    } catch (error) {
+        console.error('Error converting Config to JSON:', error);
+    }
+}
+
+/**
+ * Converts a JSON file back to a .config (XML) file.
+ * @param {string} jsonFilePath - Path to the source JSON file.
+ * @param {string} configDestinationPath - Path where the .config should be saved.
+ */
+async function convertJsonToConfig(jsonFilePath, configDestinationPath) {
+    try {
+        // Read the JSON file
+        const jsonFileContent = fs.readFileSync(jsonFilePath, 'utf-8');
+        const jsonObject = JSON.parse(jsonFileContent);
+
+        // Build XML string from the JSON object
+        const builder = new xml2js.Builder();
+        const xmlContent = builder.buildObject(jsonObject);
+
+        fs.writeFileSync(configDestinationPath, xmlContent, 'utf-8');
+        console.log(`Successfully converted ${jsonFilePath} to ${configDestinationPath}`);
+    } catch (error) {
+        console.error('Error converting JSON to Config:', error);
+    }
+}
+
+module.exports = {
+    convertConfigToJson,
+    convertJsonToConfig
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "config-js-parser",
+  "version": "1.0.0",
+  "description": "config-parser parses config to json and json to config text",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha --reporter spec --recursive --timeout 60000"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ganeshkbhat/config-js-parser.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/ganeshkbhat/config-js-parser/issues"
+  },
+  "homepage": "https://github.com/ganeshkbhat/config-js-parser#readme",
+  "devDependencies": {
+    "chai": "^6.2.2",
+    "mocha": "^11.7.5"
+  },
+  "dependencies": {
+    "xml2js": "^0.6.2"
+  }
+}

package/test/test.config.json.js

@@ -0,0 +1,79 @@
+const fs = require('fs');
+const path = require('path');
+const { expect } = require('chai');
+
+// Assuming the conversion functions are exported from 'converter.js'
+const { convertConfigToJson, convertJsonToConfig } = require('../index');
+
+describe('Config and JSON Converter Tests', () => {
+    const testConfigPath = path.join(__dirname, 'test.config');
+    const testJsonPath = path.join(__dirname, 'test.json');
+    const finalConfigPath = path.join(__dirname, 'final.config');
+
+    const sampleXml = 
+`<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<configuration>
+  <appSettings>
+    <add key="Environment" value="Production"/>
+  </appSettings>
+</configuration>`;
+
+    // Cleanup files before and after tests
+    const cleanup = () => {
+        [testConfigPath, testJsonPath, finalConfigPath].forEach(file => {
+            if (fs.existsSync(file)) fs.unlinkSync(file);
+        });
+    };
+
+    before(() => {
+        cleanup();
+        // Create initial config file for testing
+        fs.writeFileSync(testConfigPath, sampleXml, 'utf-8');
+    });
+
+    after(() => {
+        cleanup();
+    });
+
+    describe('convertConfigToJson()', () => {
+        it('should create a JSON file and contain the correct values', async () => {
+            await convertConfigToJson(testConfigPath, testJsonPath);
+
+            // Check if file exists
+            expect(fs.existsSync(testJsonPath)).to.be.true;
+
+            // Verify content
+            const jsonContent = JSON.parse(fs.readFileSync(testJsonPath, 'utf-8'));
+            expect(jsonContent).to.have.property('configuration');
+            expect(jsonContent.configuration.appSettings.add.$.key).to.equal('Environment');
+            expect(jsonContent.configuration.appSettings.add.$.value).to.equal('Production');
+        });
+    });
+
+    describe('convertJsonToConfig()', () => {
+        it('should convert JSON back to a valid .config XML file', async () => {
+            await convertJsonToConfig(testJsonPath, finalConfigPath);
+
+            // Check if file exists
+            expect(fs.existsSync(finalConfigPath)).to.be.true;
+
+            // Verify content contains XML tags
+            const configContent = fs.readFileSync(finalConfigPath, 'utf-8');
+            expect(configContent).to.contain('<configuration>');
+            expect(configContent).to.contain('key="Environment"');
+            expect(configContent).to.contain('value="Production"');
+        });
+    });
+
+    describe('Error Handling', () => {
+        it('should log an error if the source file does not exist', async () => {
+            // We expect this not to throw a hard crash because of the try-catch in the source code
+            // but we can verify it doesn't create an output file
+            const nonExistentPath = 'ghost.config';
+            const outputPath = 'ghost.json';
+            
+            await convertConfigToJson(nonExistentPath, outputPath);
+            expect(fs.existsSync(outputPath)).to.be.false;
+        });
+    });
+});