hv-audit
v1.0.9
Published
A production-ready CLI tool to audit client Web SDK integrations entirely rule-based without AI. It scans frontend web files and backend code for the HyperVerge Web SDK implementation and highlights potential integration issues based on strict guidelines.
Readme
HyperVerge Web SDK Integration Audit CLI
A production-ready CLI tool to audit client Web SDK integrations entirely rule-based without AI. It scans frontend web files and backend code for the HyperVerge Web SDK implementation and highlights potential integration issues based on strict guidelines.
Installation
You can link this package locally to use the command immediately:
npm linkUsage
Navigate to any client project directory (containing HTML, JS, or Backend files) and run the scanner:
hyperverge-audit scanThe scan is completely local, takes less than a few seconds, and provides a comprehensive score and audit report.
Publishing to NPM
To publish this tool to the NPM registry so anyone can run npx hyperverge-audit scan, follow these steps:
Login to NPM Open your terminal and authenticate:
npm loginYou'll be prompted for your username, password, and email.
Verify Package Details Ensure
package.jsoncontains the correctname(e.g.,"name": "hyperverge-audit") and a unique version (e.g.,"version": "1.0.0"). Note: The package namehyperverge-auditmust be unique on the npm registry. If it is taken, you may need to publish under a scope (e.g.,@your-username/hyperverge-audit).Publish the Package
npm publishFor a scoped public package:
npm publish --access publicRunning via NPX Once published, users can instantly run the tool without globally installing it:
npx hyperverge-audit scan
Development
- Rule Engine: Rules are strictly maintained in
rules/webRules.json. Add or modify regexes and identifiers here. - Scanners:
scanners/webScanner.jsandscanners/backendScanner.jsread the specific file extensions iteratively. - Formatter:
formatter/outputFormatter.jscontrols the beautiful terminal output.
