Package Exports

projscan
projscan/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (projscan) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

projscan

Instant codebase insights — doctor, x-ray, and architecture map for any repository.

Run once, learn something immediately. Run daily, improve your codebase.

Install

npm install -g projscan

Or run directly:

npx projscan

Quick Start

Run inside any repository:

projscan

This runs the default analyze command and outputs a full project report including language breakdown, frameworks, structure, issues, and suggestions.

For a comprehensive walkthrough of every feature, use case, and output format, see the Full Guide.

Commands

`projscan analyze`

Full project analysis — language detection, framework detection, dependency audit, and issue scanning.

projscan analyze

`projscan doctor`

Health check for your project. Detects missing tooling, architecture smells, and dependency risks.

projscan doctor

Example output:

Project Health Report
──────────────────────────────────────────

  Found 3 warnings, 2 info

Issues Detected
──────────────────────────────────────────
  ⚠ No ESLint configuration
  ⚠ No Prettier configuration
  ⚠ No test framework detected
  ℹ Missing .editorconfig
  ℹ README is nearly empty

Recommendations
──────────────────────────────────────────
  1. Fix: No ESLint configuration
  2. Fix: No Prettier configuration
  3. Fix: No test framework detected
  4. Fix: Missing .editorconfig

  Run projscan fix to auto-fix 4 issues.

`projscan fix`

Automatically installs and configures missing developer tools.

projscan fix

Detects issues, proposes fixes, prompts for confirmation, then applies:

Installs ESLint with TypeScript support
Installs Prettier with sensible defaults
Installs Vitest with a sample test
Creates .editorconfig

Use -y to skip the prompt:

projscan fix -y

`projscan explain <file>`

Explains a file — its purpose, imports, exports, and potential issues.

projscan explain src/services/payment.ts

`projscan diagram`

Generates an ASCII architecture diagram showing project layers and technologies.

projscan diagram

`projscan structure`

Shows the project directory tree with file counts.

projscan structure

`projscan dependencies`

Analyzes project dependencies — counts, risks, and recommendations.

projscan dependencies

Output Formats

All commands support --format for different output targets:

projscan analyze --format json
projscan doctor --format markdown > HEALTH.md

Formats: console (default), json, markdown

Options

Flag	Description
`--format <type>`	Output format: console, json, markdown
`--verbose`	Enable debug output
`--quiet`	Suppress non-essential output
`-V, --version`	Show version
`-h, --help`	Show help

Performance

ProjScan is designed for speed:

5,000 files analyzed in under 1.5 seconds
20,000 files analyzed in under 3 seconds
Zero network requests — everything runs locally
Minimal dependencies (4 runtime packages)

What It Detects

Languages: TypeScript, JavaScript, Python, Go, Rust, Java, Ruby, C/C++, PHP, Swift, Kotlin, and 20+ more

Frameworks: React, Next.js, Vue, Nuxt, Svelte, Angular, Express, Fastify, NestJS, Vite, Tailwind CSS, Prisma, and more

Issues:

Missing ESLint configuration
Missing Prettier configuration
Missing test framework
Missing .editorconfig
Large utility directories (architecture smell)
Excessive dependencies
Deprecated packages
Wildcard version ranges
Missing lockfile

Development

git clone https://github.com/your-org/projscan.git
cd projscan
npm install
npm run build
npm link

Run tests:

npm test

License

MIT