{ "$schema": "https://raw.githubusercontent.com/machanism-org/bindex-core/refs/heads/main/src/main/resources/schema/bindex-schema-v2.json", "id": "org.machanism.machai:project-layout:1.4.3", "name": "org.machanism.machai:project-layout", "version": "1.4.3", "location": { "repositoryType": "Maven", "repositoryUrl": "https://central.sonatype.com/artifact/org.machanism.machai/project-layout", "coordinates": { "group": "org.machanism.machai", "artifactId": "project-layout", "version": "1.4.3", "extension": "jar" } }, "description": "Project Layout is a Java utility library that detects and models conventional project directory structures so build tools, repository scanners, generators, validators, documentation tools, and indexing applications can share consistent project-layout information instead of hard-coding directory rules. Its ProjectLayoutManager identifies project types in a deterministic order and returns a configured layout for Maven, Gradle, JavaScript or TypeScript, Python, MS Access exports, or a generic filesystem fallback. Layout APIs expose project roots, source, test and documentation paths, project metadata, module discovery where supported, relative-path helpers, exclusions, and filesystem traversal. Maven layouts use POM metadata and include source, test, and resource locations; Gradle layouts support conventional roots and child-project discovery with the Gradle Tooling API; JavaScript layouts recognize array-form package.json workspaces; Python layouts recognize named public pyproject.toml projects; MS Access layouts recognize msaccess-vcs-addin exports. Consumers can use the common API in Maven plugins and standalone Java tooling to analyze heterogeneous repositories and multi-module projects. The library targets Java 8 bytecode and is published as org.machanism.machai:project-layout:1.4.3 under Apache License 2.0.", "authors": [ { "name": "Viktor Tovstyi", "email": "viktor.tovstyi@gmail.com", "website": "https://machanism.org" }, { "name": "Machanism.org", "website": "https://machai.machanism.org/" } ], "license": "Apache License, Version 2.0", "classification": { "type": "Java library", "domains": [ "Build tooling", "Project structure discovery", "Repository analysis", "Filesystem traversal", "Developer tools", "Code generation", "Documentation tooling", "Static analysis and validation" ], "languages": [ { "name": "Java", "version": "8" } ], "layers": [ "Utils", "Infrastructure" ], "usageContext": [ "Maven plugins", "Gradle-aware tooling", "Standalone Java applications", "Repository scanners", "Multi-module project traversal", "Build and CI automation", "Cross-ecosystem source indexing" ], "targetEnvironment": [ "Java" ], "integrations": [] }, "constructors": [ { "package": "org.machanism.machai.project", "signature": "private ProjectLayoutManager()", "description": "Private constructor for this non-instantiable utility class. Use its static detection method to obtain a configured project layout.", "examples": [] } ], "features": [ { "name": "detectProjectLayout", "package": "org.machanism.machai.project", "signature": "public static org.machanism.machai.project.layout.ProjectLayout detectProjectLayout(java.io.File projectDir) throws java.io.FileNotFoundException", "description": "Detects the project layout in the supplied directory in a fixed order, choosing Maven, Gradle, JavaScript or TypeScript, Python, or the default filesystem layout when no supported descriptor matches. The result is configured with the supplied project directory. Throws java.io.FileNotFoundException when the directory does not exist and java.lang.NullPointerException when the argument is null.", "examples": [ { "snippet": "java.io.File root = new java.io.File(\"path/to/repository\");\norg.machanism.machai.project.layout.ProjectLayout layout = org.machanism.machai.project.ProjectLayoutManager.detectProjectLayout(root);\nfor (java.lang.String source : layout.getSources()) {\n java.io.File sourceDirectory = new java.io.File(layout.getProjectDir(), source);\n System.out.println(sourceDirectory.getPath());\n}", "description": "Detect a repository layout and resolve source paths relative to its project root. Catch java.io.FileNotFoundException in application code when the input directory might not exist; the returned layout also exposes test, documentation, and supported module information." } ] } ], "customizations": [], "studs": [], "examples": [ { "title": "Install and use the library from a Maven application", "steps": [ "Add org.machanism.machai:project-layout:1.4.3 as a dependency in the consuming Maven project's pom.xml.", "In Java code, call org.machanism.machai.project.ProjectLayoutManager.detectProjectLayout(java.io.File) with the repository directory to inspect.", "Resolve each returned source, test, or documentation path against layout.getProjectDir() and process it with the consumer's scanner, generator, or validation logic.", "Run the consuming application's normal Maven lifecycle, for example mvn verify. Project Layout is a library, not a Maven plugin, and provides no Maven goal of its own." ], "dependency": "org.machanism.machaiproject-layout1.4.3", "configuration": "No library-specific configuration file or environment variable is required. Pass the target project directory as a java.io.File; Gradle module discovery additionally requires a usable Gradle build and any necessary Gradle distribution or repository access.", "snippet": "java.io.File repository = new java.io.File(args[0]);\norg.machanism.machai.project.layout.ProjectLayout layout = org.machanism.machai.project.ProjectLayoutManager.detectProjectLayout(repository);\nfor (java.lang.String path : layout.getSources()) {\n System.out.println(new java.io.File(layout.getProjectDir(), path).getAbsolutePath());\n}", "description": "Practical integration scenario for a repository-indexing or analysis application. Add the dependency, supply a repository directory through the application's existing command-line argument, detect the correct project layout, and feed resolved source roots into downstream processing." }, { "title": "Traverse a heterogeneous repository", "steps": [ "Add the library to the Java tool that performs repository processing.", "Pass the root directory to ProjectLayoutManager.detectProjectLayout.", "Use the selected layout's module and path APIs, or pass it to an org.machanism.machai.project.ProjectProcessor implementation for supported recursive traversal.", "Implement processFolder(ProjectLayout) to handle leaf projects and their roots." ], "snippet": "java.io.File repositoryRoot = new java.io.File(\"workspace\");\norg.machanism.machai.project.layout.ProjectLayout layout = org.machanism.machai.project.ProjectLayoutManager.detectProjectLayout(repositoryRoot);\norg.machanism.machai.project.ProjectProcessor processor = new org.machanism.machai.project.ProjectProcessor() {\n @Override\n public void processFolder(org.machanism.machai.project.layout.ProjectLayout project) {\n System.out.println(project.getProjectDir());\n }\n};\nprocessor.scanFolder(repositoryRoot);", "description": "Use a ProjectProcessor implementation to visit projects under a repository tree and process detected leaf layouts. Module-discovery capabilities vary by ecosystem: Maven parent projects, Gradle multi-project builds, and JavaScript workspaces can expose modules, while other layouts may have none." } ], "dependencies": [ "org.slf4j:slf4j-api:2.0.17", "org.slf4j:slf4j-simple:2.0.17", "commons-io:commons-io:2.11.0", "org.tomlj:tomlj:2.1.1", "com.fasterxml.jackson.core:jackson-databind:2.18.2", "com.fasterxml.jackson.core:jackson-annotations:2.22", "org.apache.commons:commons-lang3:3.20.0", "org.gradle:gradle-tooling-api:7.3-20210825160000+0000", "org.apache.maven:maven-model:3.8.1", "org.apache.maven:maven-model-builder:3.8.1" ] }