@nx/angular/src/utils/nx-devkit/route-utils.js

The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: - Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, Playwright and Cypre

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.addRoute = addRoute;
exports.addProviderToRoute = addProviderToRoute;
const js_1 = require("@nx/js");
const ast_utils_1 = require("./ast-utils");
const ensure_typescript_1 = require("@nx/js/src/utils/typescript/ensure-typescript");
let tsModule;
/**
 * Add a new route to a routes definition
 * @param tree Virtual Tree
 * @param routesFile File containing the routes definition
 * @param route Route to add
 * @param lazy If Route should be lazy-loaded
 * @param routesConst Used when eager-loading a route: Class name of the Component
 * @param importPath Used when eager-loading a route: The import path to the Component
 */
function addRoute(tree, routesFile, route, lazy = true, routesConst, importPath) {
    if (!tree.exists(routesFile)) {
        throw new Error(`Path to parent routing declaration (${routesFile}) does not exist. Please ensure path is correct.`);
    }
    if (!tsModule) {
        tsModule = (0, ensure_typescript_1.ensureTypescript)();
    }
    const { tsquery } = require('@phenomnomnominal/tsquery');
    let routesFileContents = tree.read(routesFile, 'utf-8');
    if (!lazy) {
        let parentSourceFile = tsModule.createSourceFile(routesFile, routesFileContents, tsModule.ScriptTarget.Latest, true);
        parentSourceFile = (0, js_1.insertImport)(tree, parentSourceFile, routesFile, routesConst, importPath);
        routesFileContents = tree.read(routesFile, 'utf-8');
    }
    const ast = tsquery.ast(routesFileContents);
    const ROUTES_ARRAY_SELECTOR = 'VariableDeclaration:has(ArrayType > TypeReference > Identifier[name=Route], Identifier[name=Routes]) > ArrayLiteralExpression';
    const routesArrayNodes = tsquery(ast, ROUTES_ARRAY_SELECTOR, {
        visitAllChildren: true,
    });
    const isRoutesArray = routesArrayNodes.length > 0;
    if (!isRoutesArray) {
        if (routesFileContents.includes('@NgModule')) {
            const sourceFile = tsModule.createSourceFile(routesFile, routesFileContents, tsModule.ScriptTarget.Latest, true);
            (0, ast_utils_1.addRouteToNgModule)(tree, routesFile, sourceFile, route);
            return;
        }
        else {
            throw new Error(`Routing file (${routesFile}) does not a routing configuration. Please ensure the parent contains a routing configuration.`);
        }
    }
    const newRoutesFileContents = `${routesFileContents.slice(0, routesArrayNodes[0].getStart() + 1)}
    ${route},${routesFileContents.slice(routesArrayNodes[0].getStart() + 1)}`;
    tree.write(routesFile, newRoutesFileContents);
}
/**
 * Add a provider to a standalone routes definition
 * @param tree Virtual Tree
 * @param routesFile The file containing the routes definition
 * @param routeToAddProviderTo The route to add the provider to
 * @param providerToAdd The provider to add to the route
 */
function addProviderToRoute(tree, routesFile, routeToAddProviderTo, providerToAdd) {
    if (!tree.exists(routesFile)) {
        throw new Error(`Path to parent routing declaration (${routesFile}) does not exist. Please ensure path is correct.`);
    }
    (0, ensure_typescript_1.ensureTypescript)();
    const { tsquery } = require('@phenomnomnominal/tsquery');
    let routesFileContents = tree.read(routesFile, 'utf-8');
    const ast = tsquery.ast(routesFileContents);
    const ROUTES_ARRAY_SELECTOR = 'VariableDeclaration:has(ArrayType > TypeReference > Identifier[name=Route], Identifier[name=Routes]) > ArrayLiteralExpression';
    const routesArrayNodes = tsquery(ast, ROUTES_ARRAY_SELECTOR, {
        visitAllChildren: true,
    });
    const isRoutesArray = routesArrayNodes.length > 0;
    if (!isRoutesArray) {
        throw new Error(`Routing file (${routesFile}) does not a routing configuration. Please ensure the parent contains a routing configuration.`);
    }
    const ROUTE_SELECTOR = `ObjectLiteralExpression:has(PropertyAssignment:has(Identifier[name=path]) > StringLiteral[value=${routeToAddProviderTo}]):last-child`;
    const ROUTE_PATH_PROVIDERS_SELECTOR = 'ObjectLiteralExpression > PropertyAssignment:has(Identifier[name=providers])';
    const selectedRouteNodes = tsquery(routesArrayNodes[0], ROUTE_SELECTOR, {
        visitAllChildren: true,
    });
    if (selectedRouteNodes.length === 0) {
        throw new Error(`Could not find '${routeToAddProviderTo}' in routes definition.`);
    }
    for (const selectedRouteNode of selectedRouteNodes) {
        const routeProivdersNodes = tsquery(selectedRouteNode, ROUTE_PATH_PROVIDERS_SELECTOR, {
            visitAllChildren: true,
        });
        if (routeProivdersNodes.length === 0) {
            const newFileContents = `${routesFileContents.slice(0, selectedRouteNode.getEnd() - 1)}${routesFileContents
                .slice(0, selectedRouteNode.getEnd() - 1)
                .trim()
                .endsWith(',')
                ? ''
                : ', '}providers: [${providerToAdd}]${routesFileContents.slice(selectedRouteNode.getEnd() - 1, routesFileContents.length)}`;
            tree.write(routesFile, newFileContents);
        }
        else {
            const newFileContents = `${routesFileContents.slice(0, routeProivdersNodes[0].getEnd() - 1)}, ${providerToAdd}${routesFileContents.slice(routeProivdersNodes[0].getEnd() - 1, routesFileContents.length)}`;
            tree.write(routesFile, newFileContents);
        }
    }
}