@milcondev/codepulse
v0.1.1
Published
A comprehensive project health scanner for Node.js, JavaScript, and TypeScript applications.
Maintainers
Readme
CodePulse
Developed by Milcon Development
CodePulse is a modern CLI and TypeScript API for scanning Node.js, JavaScript, and TypeScript projects. It detects project structure, dependencies, security risks, environment variables, imports, routes, performance smells, documentation quality, CI/CD configuration, Docker setup, TypeScript settings, Git state, and npm publishing readiness.
Installation
For the codepulse command to work directly in PowerShell, CMD, Terminal, or CI, install it globally:
npm install -g @milcondev/codepulseThen run:
codepulse reportYou can also run it without a global install:
npx @milcondev/codepulse reportUsage
codepulse
codepulse scan
codepulse report
codepulse doctor
codepulse score
codepulse routes
codepulse deps
codepulse security
codepulse performance
codepulse docs
codepulse doctor --fix
codepulse scan --json
codepulse scan --html
codepulse scan --markdown
codepulse scan --output report.htmlHTML Reports
The easiest way to create an HTML report is:
codepulse reportThis creates:
codepulse-report.htmlOpen it on Windows:
Start-Process .\codepulse-report.htmlYou can choose your own file name:
codepulse scan --output report.htmlBecause the output file ends with .html, CodePulse generates an HTML report automatically.
Open it:
Start-Process .\report.htmlFor npx:
npx @milcondev/codepulse report
npx @milcondev/codepulse scan --output report.htmlOther Reports
CodePulse can render:
- Terminal output with colors and severity summaries
- Interactive HTML reports with search, dark/light mode, collapsible findings, progress bars, and downloadable data
- JSON for automation
- Markdown for pull requests and documentation
Examples:
codepulse scan --output report.json
codepulse scan --output report.md
codepulse scan --json
codepulse scan --markdownAPI
import { scanProject } from "@milcondev/codepulse";
const report = await scanProject({
root: process.cwd(),
format: "json"
});
console.log(report.score.overall);Configuration
Create codepulse.config.ts:
export default {
ignore: ["dist", "coverage", "node_modules"],
output: "html",
security: true,
performance: true,
plugins: []
};Legacy node-health.config.* files are still detected for smooth migration.
Plugins
import { definePlugin } from "@milcondev/codepulse/plugins";
export default definePlugin({
name: "react-plugin",
setup(api) {
api.addMetric("reactPluginLoaded", true);
}
});Plugins can register scanners, reporters, health metrics, and future CLI commands.
Examples
See examples for a config file and a custom plugin.
Contributing
Run the local checks before submitting changes:
npm run typecheck
npm test
npm run buildLicense
MIT (c) Milcon Development
