scripts

scripts

The scripts module serves as the project's central automation hub, encompassing all build processes, testing, maintenance, and utility tasks. It orchestrates critical workflows, from generating comprehensive documentation and the "LLM Agents: Du Concept à la Production" book, to running a robust Real-Conditions Test Suite, and offering a library of reusable development templates. Understanding these scripts is crucial for effective development and maintaining code quality.

Key Workflows

• Documentation & Book Generation: The scripts/build-book.sh script is the primary orchestrator for compiling the project's documentation and the "LLM Agents: Du Concept à la Production" book into various formats (PDF, EPUB, HTML). This process is supported by general documentation generation scripts like scripts/run-docs-gen.ts and scripts/run-docs-v2.ts, and can leverage reusable FCS templates from scripts/templates/documentation for specific tasks.

• Testing & Quality Assurance: The scripts/run-all-tests.ts script serves as the entry point for executing the project's comprehensive test suite. It orchestrates the scripts/tests module, which houses the Real-Conditions Test Suite. This suite validates core functionality by directly importing src/ modules and making live API calls, ensuring stability under near-production conditions. Specific tests include scripts/test-gemini-agent.ts for agent logic, scripts/test-lm-studio.ts for local LLM connections, and scripts/test-real-conditions-gemini.ts for extensive Gemini API validation, utilizing helper functions like initApiGeminiExtended and initApiAdvanced from scripts/tests.

• Development Utilities & Maintenance: Beyond core build and test, the scripts module provides various utility scripts such as scripts/check-circular-deps.ts for code quality, scripts/fetch-models-snapshot.ts for data management, and scripts/nanobanana.ts for specific asset generation. The scripts/templates module further extends this by offering a library of reusable FCS templates for common development tasks like refactoring and sync, accessible via its index.fcs entry point.

How Sub-modules Interact

The scripts module acts as the central orchestrator, containing the primary executable scripts that define the project's automated workflows. These orchestrating scripts often leverage the specialized capabilities of its sub-modules:

• The top-level scripts directory houses the main execution scripts (e.g., build-book.sh, run-all-tests.ts).
• scripts/templates provides a library of reusable FCS scripts that can be invoked by the main scripts for common tasks like documentation generation, refactoring, or workspace synchronization.
• scripts/tests contains the actual test implementations and helper functions, which are executed and managed by the orchestrating test scripts within the top-level scripts directory (e.g., run-all-tests.ts).

This structure ensures a clear separation of concerns: orchestration logic resides at the top level, reusable components are centralized in templates, and specific test logic is encapsulated in tests.

graph TD
    A[scripts (Orchestration & Main Executables)] --> B[scripts/templates (Reusable FCS Templates)]
    A --> C[scripts/tests (Real-Conditions Test Suite)]

    B -- Provides reusable components for --> A
    C -- Contains test implementations executed by --> A

    subgraph Key Workflows
        A -- "Build Book (build-book.sh)" --> B
        A -- "Run All Tests (run-all-tests.ts)" --> C
        A -- "Doc Generation (run-docs-gen.ts)" --> B
    end