# jamiemason/syncpack architecture

> Architecture diagram of the GitHub repository jamiemason/syncpack, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jamiemason/syncpack
- Repository: https://github.com/jamiemason/syncpack

## Overview

##### Main Components

a) Core Engine Components:
- Configuration Manager (src/config/)
- Package Scanner (src/get-package-json-files/)
- Version Manager
- Version Groups (src/version-group/)
- Semver Groups (src/semver-group/)
- Specifier Handler (src/specifier/)
- I/O Operations (src/io/)

b) Command Modules:
- Fix Mismatches
- Format
- Lint
- List
- Update
- Prompt

**┌─────────────────────────────────────────────────────────────────┐**
- Command Interface                         │
- ┬─────────────┬────────────────┬───────────────────┤
- Fix Mismatches│   Format   │      Lint      │      Update       │
- ┴─────────────┴────────────────┴───────────────────┘
- ▲

**┌─────────────────────────┴─────────────────────────────────────┐**
- Core Engine                              │
- ┬────────────────┬───────────────┬────────────┤
- Config Manager│ Package Scanner│Version Manager │    I/O     │
- ┴────────────────┴───────────────┴────────────┘
- ▲

**┌─────────────────────────┴─────────────────────────────────────┐**
- File System Interface                       │
- ┬────────────────┬───────────────┬────────────┤
- package.json  │    lerna.json  │  pnpm-lock.yaml│  Others   │
- ┴────────────────┴───────────────┴────────────┘

##### Important Relationships

- Bidirectional flow between Command Interface and Core Engine
- Core Engine's interaction with File System
- Version Manager's relationship with both Package Scanner and Config Manager
- I/O Operations' connection to File System Interface

##### Additional Elements

- Component types (Command, Core, File System)
- Version handling strategies (standard, pinned, banned, etc.)
- Supported package manager integrations (npm, yarn, pnpm)

##### Implementation Details

- The modular architecture (separate bin directories for each command)
- The strategy pattern used for version management
- The plugin-like system for different package managers
- Configuration flexibility through .syncpackrc.js

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef command fill:#2196F3,stroke:#1565C0,color:white
    classDef core fill:#4CAF50,stroke:#2E7D32,color:white
    classDef file fill:#9E9E9E,stroke:#616161,color:white
    classDef fs fill:#795548,stroke:#4E342E,color:white
    classDef manager fill:#FF9800,stroke:#EF6C00,color:white

    %% Command Interface Layer
    subgraph Commands
        Fix["Fix Mismatches"]:::command
        Format["Format"]:::command
        Lint["Lint"]:::command
        List["List"]:::command
        Update["Update"]:::command
        Prompt["Prompt"]:::command
    end

    %% Core Engine Layer
    subgraph CoreEngine
        Config["Configuration Manager"]:::core
        Scanner["Package Scanner"]:::core
        VersionMgr["Version Manager"]:::core
        IO["I/O Operations"]:::core
        ErrorHandler["Error Handler"]:::core
        Context["Context Manager"]:::core
    end

    %% Version Management Layer
    subgraph VersionManagement
        VersionGroups["Version Groups"]:::manager
        SemverGroups["Semver Groups"]:::manager
        Specifier["Specifier Handler"]:::manager
    end

    %% Package Manager Integration Layer
    subgraph PackageManagers
        Lerna["Lerna Integration"]:::manager
        PNPM["PNPM Integration"]:::manager
        Yarn["Yarn Integration"]:::manager
    end

    %% File System Layer
    subgraph FileSystem
        PackageJSON["package.json"]:::fs
        LernaJSON["lerna.json"]:::fs
        PnpmLock["pnpm-lock.yaml"]:::fs
        YarnLock["yarn.lock"]:::fs
    end

    %% Relationships
    Commands --> CoreEngine
    CoreEngine --> VersionManagement
    Scanner --> PackageManagers
    PackageManagers --> FileSystem
    VersionMgr --> VersionGroups
    VersionMgr --> SemverGroups
    VersionMgr --> Specifier
    IO --> FileSystem

    %% Click Events
    click Config "https://github.com/JamieMason/syncpack/tree/main/src/config/"
    click Scanner "https://github.com/JamieMason/syncpack/tree/main/src/get-package-json-files/"
    click VersionGroups "https://github.com/JamieMason/syncpack/tree/main/src/version-group/"
    click SemverGroups "https://github.com/JamieMason/syncpack/tree/main/src/semver-group/"
    click Specifier "https://github.com/JamieMason/syncpack/tree/main/src/specifier/"
    click IO "https://github.com/JamieMason/syncpack/tree/main/src/io/"
    click Fix "https://github.com/JamieMason/syncpack/tree/main/src/bin-fix-mismatches/"
    click Format "https://github.com/JamieMason/syncpack/tree/main/src/bin-format/"
    click Lint "https://github.com/JamieMason/syncpack/tree/main/src/bin-lint/"
    click List "https://github.com/JamieMason/syncpack/tree/main/src/bin-list/"
    click Update "https://github.com/JamieMason/syncpack/tree/main/src/bin-update/"
    click Prompt "https://github.com/JamieMason/syncpack/tree/main/src/bin-prompt/"
    click ErrorHandler "https://github.com/JamieMason/syncpack/tree/main/src/error-handlers/"
    click Context "https://github.com/JamieMason/syncpack/tree/main/src/get-context/"
    click Lerna "https://github.com/JamieMason/syncpack/blob/main/src/get-package-json-files/get-patterns/get-lerna-patterns.ts"
    click PNPM "https://github.com/JamieMason/syncpack/blob/main/src/get-package-json-files/get-patterns/get-pnpm-patterns.ts"
    click Yarn "https://github.com/JamieMason/syncpack/blob/main/src/get-package-json-files/get-patterns/get-yarn-patterns.ts"
```
