@shapecode/analyzer

Static code analysis for JavaScript, TypeScript, React, Angular, NestJS, and NextJS projects.

No Java required - analysis runs on the ShapeCode cloud using binary event streams (3x smaller uploads than JSON).

Installation

# Use directly with npx (no install required)
npx @shapecode/analyzer analyze

# Or install globally
npm install -g @shapecode/analyzer

Requirements

• Node.js 16+
• ShapeCode API key (get one at https://shapecode.ai/admin)

Usage

Analyze a project

# Analyze current directory
npx @shapecode/analyzer analyze --api-key YOUR_API_KEY

# Analyze specific directory
npx @shapecode/analyzer analyze --path ./my-react-app --api-key YOUR_API_KEY

# Specify project name
npx @shapecode/analyzer analyze -n my-awesome-app --api-key YOUR_API_KEY

# Include source code in upload (optional, for debugging)
npx @shapecode/analyzer analyze --include-source --api-key YOUR_API_KEY

# Verbose output
npx @shapecode/analyzer analyze -v --api-key YOUR_API_KEY

Environment Variables

Set your API key as an environment variable to avoid passing it every time:

export JCA_CLOUD_API_KEY=your-api-key

# Then just run:
npx @shapecode/analyzer analyze

Options

| Option | Description | |--------|-------------| | -p, --path <path> | Project path (default: current directory) | | -n, --project-name <name> | Project name for cloud storage | | --cloud-url <url> | Cloud API URL (default: https://api.shapecode.ai) | | --api-key <key> | Cloud API key | | --include-source | Include source code in upload (default: false, binary stream only) | | -v, --verbose | Verbose output |

What Gets Uploaded

The CLI generates and uploads a binary event stream of your codebase's AST (Abstract Syntax Tree):

• TypeScript/JavaScript files are parsed and converted to binary events
• Binary streams are 3x smaller than JSON snapshots
• Snapshots are calculated server-side by replaying the binary stream
• Optional: Include source code with --include-source flag

Analyzed files:

• TypeScript (.ts, .tsx)
• JavaScript (.js, .jsx, .mjs, .cjs)

Automatically excluded:

• node_modules/
• dist/, build/
• .git/
• .next/, .angular/
• .cache/, .idea/, .vscode/

Supported Frameworks

• React - Components, hooks, JSX analysis
• Angular - Components, services, modules, @Input/@Output
• NestJS - Modules, controllers, providers, decorators
• NextJS - Pages, API routes, app router
• TypeScript - Classes, interfaces, types

View Results

After analysis:

1. Go to https://shapecode.ai/admin
2. Navigate to Cloud Browser
3. Find your project
4. Click to view reports

License

MIT