Package org.machanism.machai.project

package org.machanism.machai.project

Facilities for discovering, describing, and processing a source-code project rooted at a filesystem directory.

This package provides the core orchestration APIs for:

• Detecting a project's on-disk convention (for example Maven, Gradle, JavaScript, or Python) and exposing it as a ProjectLayout via ProjectLayoutManager.detectProjectLayout(java.io.File).
• Scanning a project root, optionally recursing into nested modules, and delegating per-project processing logic to a ProjectProcessor implementation.

The detected ProjectLayout is used to locate conventional directories such as sources, tests, resources, and documentation roots.

Typical workflow

1. Detect a layout for a project directory using ProjectLayoutManager.detectProjectLayout(java.io.File).
2. Provide a ProjectProcessor that implements ProjectProcessor.processFolder(org.machanism.machai.project.layout.ProjectLayout).
3. Invoke ProjectProcessor.scanFolder(java.io.File) on the project root. If the layout reports modules, each module is scanned recursively; otherwise the root is processed directly.

Example

 java.io.File projectDir = new java.io.File("C:\\path\\to\\project");
 ProjectProcessor processor = ...;
 processor.scanFolder(projectDir);
 

Since:

0.0.2

Related Packages

Package	Description
org.machanism.machai.project.layout	APIs for detecting, describing, and working with a repository's on-disk project layout.

Classes

Class	Description
ProjectLayoutManager	Manages detection and instantiation of specific ProjectLayout implementations based on the structure of a given project directory.
ProjectProcessor	Abstract base class for processing project structures and modules.