Skip to main content

Core Overview

The core package provides shared functionality used by all other PROJAX packages. It includes database management, test detection, port scanning, and settings management.

Package Naming

In this documentation, you may see references to @projax/core. This is the conceptual package name. In the actual codebase, this package is named projax-core and uses pnpm workspace protocol (workspace:*) for local resolution. The core functionality is bundled into the main projax CLI package when published to npm - it is not available as a separate npm package.

Purpose​

The core package serves as the foundation for all PROJAX functionality:

  • Shared database operations
  • Test framework detection
  • Port extraction from config files
  • Settings management
  • Common utilities

Installation​

The core package is included when you install projax. For development:

cd packages/core
npm install
npm run build

Architecture​

The core package provides:

  • Database Manager: JSON-based storage using lowdb
  • Test Detector: Framework detection and file scanning
  • Port Scanner: Extraction from configuration files
  • Settings Manager: User preferences storage

Usage​

All other packages import from @projax/core:

import {
  getDatabaseManager,
  getAllProjects,
  addProject,
  scanProject,
} from '@projax/core';

Database​

The core package manages a shared JSON database at:

  • macOS/Linux: ~/.projax/data.json
  • Windows: %USERPROFILE%\.projax\data.json

Next Steps​