@nx/devkit/src/generators/project-name-and-root-utils.d.ts

The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more. Learn more about [extending Nx by

import { type ProjectType, type Tree } from 'nx/src/devkit-exports';
export type ProjectGenerationOptions = {
    directory: string;
    name?: string;
    projectType: ProjectType;
    importPath?: string;
    rootProject?: boolean;
};
export type ProjectNameAndRootOptions = {
    /**
     * Normalized full project name, including scope if name was provided with
     * scope (e.g., `@scope/name`)
     */
    projectName: string;
    /**
     * Normalized project root, including the layout directory if configured.
     */
    projectRoot: string;
    names: {
        /**
         * Normalized project name without scope. It's meant to be used when
         * generating file names that contain the project name.
         */
        projectFileName: string;
        /**
         * Normalized project name without scope or directory. It's meant to be used
         * when generating shorter file names that contain the project name.
         */
        projectSimpleName: string;
    };
    /**
     * Normalized import path for the project.
     */
    importPath: string;
};
export declare function determineProjectNameAndRootOptions(tree: Tree, options: ProjectGenerationOptions): Promise<ProjectNameAndRootOptions>;
export declare function resolveImportPath(tree: Tree, projectName: string, projectRoot: string): string;
export declare function ensureRootProjectName(options: {
    directory: string;
    name?: string;
}, projectType: 'application' | 'library'): Promise<void>;