pomanalyzer 1.0.0

package/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "no-console": "warn",
+    "eqeqeq": ["error", "always"],
+    "curly": "error"
+  }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zack Dawood
+
+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/PUBLISH.md

@@ -0,0 +1,28 @@
+
+## Link your package locally for testing:
+
+###  Test Locally 
+`npm link`
+
+`npm unlink -g`
+
+`npm link pomanalyzer`
+
+## Now you can run the script globally using:
+
+```pomanalyzer <filePath>```
+
+
+## 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 pomanalyzer`
+
+### Check [Documentation](DOCUMENTATION.md) for more details

package/README.md

@@ -0,0 +1,152 @@
+# pomanalyzer
+
+pomanalyzer is a utility to analyze Apache Maven POM XML files offline. It extracts and formats dependency information, detects duplicate dependencies, and generates reports in various formats.
+
+[![NPM Package](https://img.shields.io/npm/v/pomanalyzer.svg)](https://www.npmjs.com/package/pomanalyzer)
+
+
+## Features
+
+- Analyze Maven POM XML files to extract dependency information.
+- Detect duplicate dependencies and summarize them.
+- Generate reports in:
+  - **HTML** format.
+  - **Markdown** format.
+- Customizable output folder for generated reports.
+
+
+## Installation using NPM 
+
+```bash
+# Install globally
+npm install -g pomanalyzer
+
+# To uninstall
+npm uninstall -g pomanalyzer
+```
+
+## Installation in local
+
+To install `pomanalyzer`, clone the repository and install the dependencies:
+
+```bash
+git clone https://github.com/zackria/pomanalyzer.git
+cd pomanalyzer
+npm install
+```
+
+## Usage
+
+Run the `pomanalyzer` CLI tool with the following commands:
+
+### Basic Analysis
+
+Analyze a POM file and display the dependencies in the console:
+
+```bash
+pomanalyzer <pom.xmlfilepath>
+```
+
+### Generate HTML Report
+
+Generate an HTML report of the dependencies:
+
+```bash
+pomanalyzer --html <pom.xmlfilepath>
+```
+
+### Generate Markdown Report
+
+Generate a Markdown report of the dependencies:
+
+```bash
+pomanalyzer --markdown <pom.xmlfilepath>
+```
+
+### Generate Both HTML and Markdown Reports
+
+Generate both HTML and Markdown reports:
+
+```bash
+pomanalyzer --markdown --html <pom.xmlfilepath>
+```
+
+### Specify Output Folder
+
+Generate reports and save them to a specific output folder:
+
+```bash
+pomanalyzer --markdown --html --output-folder output <pom.xmlfilepath>
+```
+
+## Example Output
+
+### Console Output
+
+```plaintext
+Analyzing POM file: <pom.xmlfilepath>
+Maven Dependencies:
+| Group ID       | Artifact ID    | Version  |
+|----------------|----------------|----------|
+| org.example    | example-lib    | 1.0.0    |
+| org.example    | another-lib    | 2.1.0    |
+
+Duplicate Dependencies:
+| Dependency         | Versions       |
+|--------------------|----------------|
+| org.example:lib    | 1.0.0, 1.1.0   |
+```
+
+### HTML and Markdown Reports
+
+Reports are saved in the specified output folder with filenames like:
+
+- `Maven_Dependencies_report.html`
+- `Maven_Dependencies_report.md`
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve the tool.
+
+## Support
+
+For issues or feature requests, please visit the [GitHub Issues](https://github.com/zackria/pomanalyzer/issues) page.
+
+### Example Commands
+
+```bash
+pomanalyzer ./test/Test1.xml
+pomanalyzer --html ./test/Test1.xml
+pomanalyzer --markdown ./test/Test1.xml
+pomanalyzer --markdown --html ./test/Test1.xml
+pomanalyzer --markdown --html --output-folder output ./test/Test1.xml
+```
+
+
+## Report Examples
+
+### Terminal View
+![Terminal Report](./screenshots/ConsoleOutput.png)
+
+### HTML View
+![HTML Report](./screenshots/HtmlOutput.png)
+
+### Markdown View
+![Markdown Report](./screenshots/MarkdownOutput.png)
+
+## Quality Assurance
+
+This package is thoroughly tested with over 90% code coverage to ensure reliability.
+
+![Test Coverage](./screenshots/CodeCoverage.png)
+
+## Compatibility
+
+Developed and tested with:
+- npm v11.1.0
+- Node.js v22.13.0
+

package/TEST.md

@@ -0,0 +1,43 @@
+# Automated testing with Jest 
+
+
+## Run Your Tests
+`npm init -y        # if you haven't created a package.json yet`
+`npm install --save-dev jest`
+
+`npm test`
+or
+`npx jest`
+
+
+### Check jest.config.js for testing configuration
+
+`npm test -- --coverage`
+
+
+`node src/index.js ./test/Test1.xml`
+
+`node cli.js ./test/Test1.xml`
+
+`node cli.js --html ./test/Test1.xml`
+
+`node cli.js --markdown ./test/Test1.xml`
+
+`node cli.js --markdown --html ./test/Test1.xml`
+
+`node cli.js --markdown --html --output-folder output ./test/Test1.xml`
+
+### Test with NPM Link
+
+`pomanalyzer ./test/Test1.xml`
+
+`pomanalyzer ./test/Test1.xml`
+
+`pomanalyzer --html ./test/Test1.xml`
+
+`pomanalyzer --markdown ./test/Test1.xml`
+
+`pomanalyzer --markdown --html ./test/Test1.xml`
+
+`pomanalyzer --markdown --html --output-folder output ./test/Test1.xml`
+

package/babel.config.js

@@ -0,0 +1,3 @@
+export default {
+  presets: ['@babel/preset-env'],
+};

package/cli.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+
+import { program } from 'commander';
+import { analyzePom } from './src/index.js';
+import { readFileSync } from 'fs';
+import path from 'path';
+
+// Get version from package.json
+let version = '1.0.0';
+
+try {
+  const packageJson = JSON.parse(readFileSync('./package.json', 'utf8'));
+  version = packageJson.version;
+} catch (err) {
+  // Use default version if package.json can't be read
+}
+
+// Check if no arguments were provided
+if (process.argv.length <= 2) {
+  console.log(`pomanalyzer v${version}`);
+  console.log('Usage: pomanalyzer [options] <pomFile>');
+  process.exit(0);
+}
+
+program
+  .version(version)
+  .description('Analyze Maven POM XML files')
+  .option('--html', 'Generate HTML report')
+  .option('--markdown', 'Generate Markdown report')
+  .option('--output-folder <path>', 'Output folder for results')
+  .option('-v, --verbose', 'Show verbose output')
+  .arguments('<pomFile>')
+  .usage('[options] <pomFile>')
+  .action(async (pomFile, options) => {
+    try {
+      // Resolve file path
+      const resolvedPath = path.resolve(pomFile);
+      
+      // Prepare options for analysis
+      const analysisOptions = {
+        html: options.html,
+        markdown: options.markdown,
+        outputFolder: options.outputFolder,
+        verbose: options.verbose
+      };
+
+      // Use the centralized analyzePom function
+      await analyzePom(resolvedPath, analysisOptions);
+      
+    } catch (error) {
+      console.error('Error:', error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/jest.config.js

@@ -0,0 +1,17 @@
+export default {
+  testEnvironment: "node", // Use Node.js environment
+  transform: {
+    "^.+\\.js$": "babel-jest", // Transform ES modules with Babel
+  },
+  transformIgnorePatterns: [
+    "/node_modules/(?!(chalk|ansi-styles|supports-color|strip-ansi|ansi-regex)/)", // Allow specific ES module packages to be transformed
+  ],
+  testMatch: [
+    "**/tests/**/*.test.js",
+    "**/?(*.)+(spec|test).js"
+  ],
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  verbose: true,
+};

package/output/Maven_Dependencies_report.html

@@ -0,0 +1,84 @@
+
+    <html>
+      <head>
+        <meta charset="UTF-8">
+        <title>Maven Dependencies Report</title>
+        <style>
+    body { font-family: Arial, sans-serif; margin: 20px; }
+    h2 { color: #333; }
+    table { width: 100%; border-collapse: collapse; margin-bottom: 20px; }
+    th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }
+    th { background-color: #f2f2f2; }
+    .duplicate { background-color: #ffcccc; }
+  </style>
+      </head>
+      <body>
+        
+    <h2>Maven Dependencies</h2>
+    <table>
+      <thead>
+        <tr>
+          <th>groupId</th><th>artifactId</th><th>version</th>
+        </tr>
+      </thead>
+      <tbody>
+        
+          <tr>
+            <td>org.springframework</td><td>spring-core</td><td>5.3.9</td>
+          </tr>
+        
+          <tr>
+            <td>org.springframework</td><td>spring-core</td><td>5.3.9</td>
+          </tr>
+        
+          <tr>
+            <td>org.apache.commons</td><td>commons-lang3</td><td>N/A</td>
+          </tr>
+        
+          <tr>
+            <td>org.apache.commons</td><td>commons-lang3</td><td>N/A</td>
+          </tr>
+        
+          <tr>
+            <td>junit</td><td>junit</td><td>4.13.2</td>
+          </tr>
+        
+          <tr>
+            <td>com.google.guava</td><td>guava</td><td>N/A</td>
+          </tr>
+        
+          <tr>
+            <td>com.google.guava</td><td>guava</td><td>N/A</td>
+          </tr>
+        
+      </tbody>
+    </table>
+  
+        
+      <h2>Duplicate Dependencies</h2>
+      <table>
+        <thead>
+          <tr>
+            <th>dependency</th><th>versions</th>
+          </tr>
+        </thead>
+        <tbody>
+          
+            <tr class="duplicate">
+              <td>org.springframework:spring-core</td><td>5.3.9, 5.3.9</td>
+            </tr>
+          
+            <tr class="duplicate">
+              <td>org.apache.commons:commons-lang3</td><td>N/A, N/A</td>
+            </tr>
+          
+            <tr class="duplicate">
+              <td>com.google.guava:guava</td><td>N/A, N/A</td>
+            </tr>
+          
+        </tbody>
+      </table>
+    
+      </body>
+    </html>
+  

package/output/Maven_Dependencies_report.md

@@ -0,0 +1,24 @@
+# Report
+
+
+## Maven Dependencies
+
+| groupId | artifactId | version |
+| --- | --- | --- |
+| org.springframework | spring-core | 5.3.9 |
+| org.springframework | spring-core | 5.3.9 |
+| org.apache.commons | commons-lang3 | N/A |
+| org.apache.commons | commons-lang3 | N/A |
+| junit | junit | 4.13.2 |
+| com.google.guava | guava | N/A |
+| com.google.guava | guava | N/A |
+  
+
+
+## Duplicate Dependencies
+
+| dependency | versions |
+| --- | --- |
+| org.springframework:spring-core | 5.3.9, 5.3.9 |  <!-- duplicate row -->
+| org.apache.commons:commons-lang3 | N/A, N/A |  <!-- duplicate row -->
+| com.google.guava:guava | N/A, N/A |  <!-- duplicate row -->

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "pomanalyzer",
+  "version": "1.0.0",
+  "description": "pomanalyzer is a utility to analyze Apache Maven POM XML file",
+  "keywords": [
+    "pom",
+    "xml",
+    "analyze",
+    "maven",
+    "depedencies"
+  ],
+  "homepage": "https://github.com/zackria/pomanalyzer#readme",
+  "bugs": {
+    "url": "https://github.com/zackria/pomanalyzer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zackria/pomanalyzer.git"
+  },
+  "license": "MIT",
+  "author": "Zack Dawood",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "pomanalyzer": "./cli.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "run": "node ./src/index.js"
+  },
+  "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"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "js-yaml": "^4.1.0",
+    "xml2js": "^0.6.2"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,50 @@
+import { readPomXml } from "./services/dependencyService.js";
+import { checkForDuplicates } from "./services/duplicateChecker.js";
+import { printTable } from "./utils/outputFormatter.js";
+import { printHTMLTable } from "./utils/printHTMLTable.js";
+import { printMarkdownTable } from "./utils/printMarkdownTable.js";
+import chalk from "chalk"; // added Chalk import
+
+export async function analyzePom(pomXmlPath, options = {}) {
+  try {
+    console.log(`Analyzing POM file: ${pomXmlPath}`);
+    const dependencies = await readPomXml(pomXmlPath, options);
+
+    if (dependencies && dependencies.length > 0) {
+      printTable(dependencies, "Maven Dependencies");
+
+      const duplicateDependencies = checkForDuplicates(dependencies);
+      let duplicateSummary = [];
+      if (duplicateDependencies.length > 0) {
+        duplicateSummary = duplicateDependencies.map(depList => ({
+          dependency: `${depList[0].groupId}:${depList[0].artifactId}`,
+          versions: depList.map(dep => dep.version).join(", "),
+        }));
+      }
+      
+      // Generate additional reports if flags are provided.
+      if (options.html) {
+        printHTMLTable(dependencies, duplicateSummary, "Maven Dependencies", options.outputFolder);
+      }
+      if (options.markdown) {
+        printMarkdownTable(dependencies, duplicateSummary, "Maven Dependencies", options.outputFolder);
+      }
+
+
+        if (duplicateSummary.length > 0) {
+          console.log(chalk.yellow("Duplicate dependencies found:"));
+          duplicateSummary.forEach(dup => {
+            console.log(chalk.red(`${dup.dependency} -> ${dup.versions}`));
+          });
+        } else {
+          console.log("No duplicate dependencies found.");
+        
+      }
+    } else {
+      console.log("No dependencies found in the POM file.");
+    }
+  } catch (error) {
+    console.error("Error analyzing POM file:", error);
+    throw error;
+  }
+}

package/src/services/dependencyService.js

@@ -0,0 +1,61 @@
+// src/services/dependencyService.js
+import { readFile } from '../utils/fileUtils.js';
+import { parseXml } from '../utils/xmlParser.js';
+import { resolveVersion } from '../utils/dependencyResolver.js';
+
+/**
+ * Reads and parses a Maven pom.xml file.
+ * @param {string} filePath - The path to the pom.xml file.
+ * @returns {Promise<Array>} - A promise that resolves to an array of dependencies.
+ */
+export async function readPomXml(filePath) {
+  try {
+    const xmlContent = await readFile(filePath);
+    const result = await parseXml(xmlContent); // Use await here
+    const dependencies = extractDependencies(result);
+    return dependencies;
+  } catch (error) {
+    throw new Error(`Error reading pom.xml: ${error.message}`);
+  }
+}
+
+/**
+ * Extracts dependencies from the parsed XML result.
+ * @param {Object} result - The parsed XML result.
+ * @returns {Array} - An array of dependencies.
+ */
+function extractDependencies(result) {
+  const dependencies = [];
+  
+  if (!result || !result.project) {
+    return dependencies;
+  }
+  
+  const properties = result.project.properties ? result.project.properties[0] : {};
+
+  if (result.project.dependencies && result.project.dependencies[0] && result.project.dependencies[0].dependency) {
+    dependencies.push(
+      ...result.project.dependencies[0].dependency.map((dep) => ({
+        groupId: dep.groupId ? dep.groupId[0] : 'unknown',
+        artifactId: dep.artifactId ? dep.artifactId[0] : 'unknown',
+        version: resolveVersion(dep.version && dep.version[0] ? dep.version[0] : 'N/A', properties),
+      }))
+    );
+  }
+
+  if (result.project.dependencyManagement && 
+      result.project.dependencyManagement[0] && 
+      result.project.dependencyManagement[0].dependencies && 
+      result.project.dependencyManagement[0].dependencies[0] &&
+      result.project.dependencyManagement[0].dependencies[0].dependency) {
+    dependencies.push(
+      ...result.project.dependencyManagement[0].dependencies[0].dependency.map((dep) => ({
+        groupId: dep.groupId ? dep.groupId[0] : 'unknown',
+        artifactId: dep.artifactId ? dep.artifactId[0] : 'unknown',
+        version: resolveVersion(dep.version && dep.version[0] ? dep.version[0] : 'N/A', properties),
+      }))
+    );
+  }
+
+  return dependencies;
+}

package/src/services/duplicateChecker.js

@@ -0,0 +1,17 @@
+/**
+ * Identifies duplicate dependencies based on groupId and artifactId.
+ * @param {Array} dependencies - List of dependencies from the POM file.
+ * @returns {Array} - List of duplicate dependencies grouped by groupId:artifactId.
+ */
+export function checkForDuplicates(dependencies) {
+  const duplicates = dependencies.reduce((acc, dep) => {
+    const key = `${dep.groupId}:${dep.artifactId}`;
+    if (!acc[key]) {
+      acc[key] = [];
+    }
+    acc[key].push(dep);
+    return acc;
+  }, {});
+
+  return Object.values(duplicates).filter((depList) => depList.length > 1);
+}

package/src/utils/dependencyResolver.js

@@ -0,0 +1,28 @@
+// src/utils/dependencyResolver.js
+
+/**
+ * Resolves a Maven-style property placeholder in a version string.
+ * 
+ * @param {string|null} version - The version string that may contain a property placeholder (e.g., "${project.version}")
+ * @param {Object} properties - An object containing property key-value pairs from the Maven POM file
+ * @returns {string} The resolved version string or "N/A" if the version couldn't be resolved
+ * 
+ * @example
+ * // If properties = { "project.version": ["1.0.0"] }
+ * resolveVersion("${project.version}", properties) // returns "1.0.0"
+ * 
+ * @example
+ * // If the property doesn't exist
+ * resolveVersion("${unknown.property}", properties) // returns "N/A"
+ * 
+ * @example
+ * // If version is a regular string
+ * resolveVersion("2.1.0", properties) // returns "2.1.0"
+ */
+export const resolveVersion = (version, properties) => {
+  if (version && version.startsWith('${') && version.endsWith('}')) {
+    const propertyName = version.slice(2, -1);
+    return properties[propertyName] ? properties[propertyName][0] : 'N/A';
+  }
+  return version || 'N/A';
+};