Skip to content

docs: update comparison.md with DependencyCheck and dep-scan analysis… - #720

Merged
sonukapoor merged 7 commits into
OWASP:mainfrom
MRX-72:docs/issue-295-tool-comparison
Jun 23, 2026
Merged

sonukapoor merged 7 commits into
OWASP:mainfrom
MRX-72:docs/issue-295-tool-comparison

Conversation

@MRX-72

@MRX-72 MRX-72 commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator

Closes #295

Summary

This PR expands the tool comparison documentation (website/docs/comparison.md) to include comprehensive, research-backed sections for OWASP DependencyCheck and OWASP dep-scan.

Why this change

As noted in #295, both DependencyCheck and dep-scan are OWASP projects sitting in roughly the same niche as CVE Lite CLI. It is important to clearly document the architectural and philosophical differences—specifically highlighting CVE Lite's lockfile-native parsing vs. CPE analysis, and its developer-focused terminal output vs. ASPM/SBOM generation—so developers can choose the right tool for their specific workflow.

What changed

  • Updated the Practical comparison matrix table to include capability columns for both tools.
  • Updated the Offline support matrix table to accurately reflect the offline capabilities/limitations of both tools.
  • Added a dedicated ## CVE Lite CLI vs OWASP DependencyCheck section.
  • Added a dedicated ## CVE Lite CLI vs OWASP dep-scan section.

Validation

  • Verified the Markdown formatting renders correctly.
  • Ran npm test successfully.
  • Ran npm run build to ensure the documentation site compiles without errors or broken links.

User-facing impact

Does this change:

  • affect scanning behavior
  • affect output formatting
  • affect JSON output
  • affect docs only

Notes

Expanding this comparison page helps lay the groundwork for the eventual structural split proposed in #362.

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The complementary-tools framing in the closing sections is the right call for peer OWASP projects - that tone works well. One factual correction needed in the DependencyCheck mechanism before I can approve.

Comment thread website/docs/comparison.md
Comment thread website/docs/comparison.md Outdated
MRX-72 and others added 2 commits June 21, 2026 23:06
Clarify that the npm analyzer uses the REST API directly, while pnpm and Yarn require their respective CLIs. Ensure internet access requirements are explicitly stated for all three.
@MRX-72

MRX-72 commented Jun 21, 2026

Copy link
Copy Markdown
Collaborator Author

Heyy! @sonukapoor The documentation has been updated to clarify the npm REST API mechanism and accurately scope the CLI/internet requirements for pnpm and Yarn. Let me know if it's good to go!

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work on the mechanism fix - the NodeAuditAnalyzer explanation (REST API for npm, CLI required for pnpm/Yarn) is accurate and well-written. Two more items to address before this can merge.

Comment thread website/docs/comparison.md Outdated
Comment thread website/docs/comparison.md
@MRX-72

MRX-72 commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator Author

Heyy! @sonukapoor The SARIF status for DependencyCheck has been updated to ✅, and the hygiene auditing row is restored with the correct values. Let me know if anything else is needed!

@sonukapoor
sonukapoor merged commit 3f47f47 into OWASP:main Jun 23, 2026
9 checks passed
@sonukapoor

Copy link
Copy Markdown
Collaborator

Merged — thank you @MRX-72!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Add comparison with OWASP DependencyCheck and OWASP dep-scan

2 participants