@o3r/schematics
Version:
Schematics module of the Otter framework
44 lines • 1.98 kB
TypeScript
import type { SchematicContext, Tree } from '@angular-devkit/schematics';
import type { WorkspaceProject, WorkspaceSchema } from '../interfaces/index';
/**
* Find the relative path to a configuration file at the monorepo root
* @param tree
* @param files List of files to look for, the first of the list will be used
* @param originPath Path from where to calculate the relative path
*/
export declare function findConfigFileRelativePath(tree: Tree, files: string[], originPath: string): string;
/**
* Determine if we are in an Nx Monorepo context
* @param tree
*/
export declare function isNxContext(tree: Tree): boolean;
/**
* Determine if we are in a project with multi packages
* @param tree
*/
export declare function isMultipackagesContext(tree: Tree): boolean;
/** Default name of the folder where libraries will be generated inside monorepo */
export declare const LIBRARIES_FOLDER_NAME = "libs";
/** Default name of the folder where applications will be generated inside monorepo */
export declare const APPLICATIONS_FOLDER_NAME = "apps";
/** Default directories for generated apps/libs inside a monorepo */
export declare const DEFAULT_ROOT_FOLDERS: {
readonly libsDir: "libs";
readonly appsDir: "apps";
};
/** Root folders map for apps/libs inside a monorepo */
export declare const BASE_ROOT_FOLDERS_MAP: {
readonly library: "libsDir";
readonly application: "appsDir";
};
/**
* Retrieve the project base root generation folder, based on the given projectType.
* - The default project root will be returned if there is no project root found in nx.json or angular.json (in schematics options)
* - The root path '/' will be returned if no project type given
* @param tree
* @param context
* @param config
* @param projectType
*/
export declare function getPackagesBaseRootFolder(tree: Tree, context: SchematicContext, config: WorkspaceSchema, projectType?: WorkspaceProject['projectType']): any;
//# sourceMappingURL=monorepo.d.ts.map