properties-comparator 1.0.1 → 1.0.3

package/DOCUMENTATION.md

@@ -0,0 +1,189 @@
+
+# Node.js Properties File Comparison Utility
+
+## Overview
+
+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.
+
+### Features:
+- Parse properties files into key-value objects.
+- Compare key values across multiple properties files.
+- Log detailed comparison results, including mismatches.
+
+---
+
+## Installation
+
+### Prerequisites
+- Node.js installed on your system.
+- Properties files in a valid key-value format.
+
+---
+
+## Usage
+
+### Running the Script
+Run the script using Node.js with file paths provided as command-line arguments:
+
+```bash
+node script.js <filePath1> <filePath2> [<filePath3> ...]
+```
+
+### Input Format
+The properties files should follow the format:
+```
+key1=value1
+key2=value2
+# Comments are ignored
+```
+
+---
+
+## Functions
+
+### `parsePropertiesFile(filePath)`
+
+Parses a properties file and returns an object representation of the key-value pairs.
+
+#### Parameters:
+- `filePath` (string): Path to the properties file.
+
+#### Returns:
+- (Object): An object containing key-value pairs from the properties file.
+
+#### Example:
+```javascript
+// Assuming properties file contains:
+// key1=value1
+// key2=value2
+
+const properties = parsePropertiesFile('/path/to/properties/file');
+console.log(properties);
+// Output: { key1: 'value1', key2: 'value2' }
+```
+
+#### Implementation:
+- Reads the file content using `fs.readFileSync`.
+- Splits lines by `
+` or `
+`.
+- Filters out empty lines and lines starting with `#`.
+- Processes valid lines into key-value pairs.
+
+---
+
+### `compareProperties(filePaths)`
+
+Compares properties across multiple properties files and logs the results.
+
+#### Parameters:
+- `filePaths` (string[]): Array of file paths to be compared.
+
+#### Returns:
+- None. Outputs comparison results to the console.
+
+#### Behavior:
+- Parses each properties file into an object.
+- Collects all unique keys across files.
+- Compares values for each key across all files.
+- Logs whether values match or are mismatched. For mismatches, displays values for each file.
+
+#### Example:
+```bash
+node script.js file1.properties file2.properties file3.properties
+```
+
+#### Output Example:
+```text
+Comparing properties across files:
+
+Key: key1 - Values match across all files.
+Key: key2 - Mismatched values:
+  File 1: value1
+  File 2: value2
+  File 3: value3
+```
+
+---
+
+### Runtime Input Handling
+
+The script expects file paths as command-line arguments:
+- Extracted from `process.argv`.
+- If no file paths are provided, it displays an error and exits:
+  ```
+  Please provide the paths to the properties files as command-line arguments.
+  ```
+- Verifies the existence of all specified files. If any file is missing:
+  ```
+  One or more properties files are missing. Ensure all specified properties files exist.
+  ```
+
+---
+
+## Error Handling
+
+- **No File Paths Provided**: Logs an error and exits.
+- **Missing Files**: Logs missing files and exits.
+- **Empty or Malformed Properties Files**: Skips invalid lines.
+
+---
+
+## Example Properties Files
+
+### File 1 (`file1.properties`):
+```
+key1=value1
+key2=value2
+```
+
+### File 2 (`file2.properties`):
+```
+key1=value1
+key2=value3
+```
+
+---
+
+## Sample Execution
+
+### Command:
+```bash
+node script.js file1.properties file2.properties
+```
+
+### Output:
+```text
+Comparing properties across files:
+
+Key: key1 - Values match across all files.
+Key: key2 - Mismatched values:
+  File 1: value2
+  File 2: value3
+```
+
+---
+
+## Dependencies
+
+- `fs` module (Node.js File System)
+
+---
+
+## Limitations
+
+- Assumes properties are simple key-value pairs separated by `=`.
+- Ignores keys without a corresponding value.
+- Does not support multi-line properties.
+
+---
+
+## License
+
+This script is licensed under the MIT License.
+
+---
+
+## Author
+
+[Zack Dawood](http://www.zackdawood.com)

package/PUBLISH.MD

@@ -0,0 +1,26 @@
+
+## Link your package locally for testing:
+
+###  Test Locally 
+`npm link`
+
+
+## Now you can run the script globally using:
+
+```properties-comparator <filePath1> <filePath2>```
+
+
+
+## Publish the Package
+### Login to npm (if you haven't already):
+`npm login`
+
+### Publish the package:
+`npm publish`
+
+
+###  Install the Package Globally
+Once published, you (or anyone) can install the package globally using:
+`npm install -g properties-comparator`
+
+### Check [Documentation](DOCUMENTATION.md) for more details

package/README.md

@@ -1,11 +1,11 @@
 # properties-comparator
 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.
 
+Utility is available as NPM Package [https://www.npmjs.com/package/properties-comparator](https://www.npmjs.com/package/properties-comparator)
 
-## Link your package locally for testing:
 
-###  Test Locally 
-`npm link`
+###  Install the Package
+`npm install -g properties-comparator`
 
 
 ## Now you can run the script globally using:
@@ -13,14 +13,4 @@ This utility provides functionality to parse and compare properties files in the
 ```properties-comparator <filePath1> <filePath2>```
 
 
-## Publish the Package
-### Login to npm (if you haven't already):
-`npm login`
-
-### Publish the package:
-`npm publish`
-
-
-###  Install the Package Globally
-Once published, you (or anyone) can install the package globally using:
-`npm install -g properties-comparator`
+### Check [Documentation](DOCUMENTATION.md) for more details

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "properties-comparator",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "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.",
   "main": "index.js",
   "bin": {