@signalwire/docusaurus-plugin-llms-txt/lib/discovery/route-filter.js

Generate Markdown versions of Docusaurus HTML pages and an llms.txt index file

/**
 * Route filtering and validation
 * Handles route discovery and filtering logic
 */
import { INDEX_HTML } from '../constants';
import { removeLeadingSlash, stripBaseUrl } from '../utils';
import { shouldProcessRoute } from './content-classifier';
import { isRouteExcluded } from './exclusion-matcher';
/**
 * Validate routes and return filtering summary for info logging
 * @internal
 */
export function validateAndLogRouteFiltering(routes, options, isExcluded, logger) {
    let excludedCount = 0;
    let contentTypeFiltered = 0;
    const validRoutes = routes.filter((route) => {
        if (!shouldProcessRoute(route, options)) {
            contentTypeFiltered++;
            return false;
        }
        if (isRouteExcluded(route.path, isExcluded)) {
            excludedCount++;
            logger.debug(`Skipping excluded route: ${route.path}`);
            return false;
        }
        return true;
    });
    const summary = `Route filtering: ${validRoutes.length} included, ${excludedCount} excluded, ${contentTypeFiltered} filtered by content type`;
    logger.debug(summary);
    return { validRoutes, summary };
}
/**
 * Validate that a route should be processed (combines all validation checks)
 * @internal
 */
export function validateRouteForProcessing(route, options, isExcluded, logger) {
    // Check if route should be processed based on content type
    if (!shouldProcessRoute(route, options)) {
        return false;
    }
    // Check exclusions
    if (isRouteExcluded(route.path, isExcluded)) {
        logger.debug(`Skipping excluded route: ${route.path}`);
        return false;
    }
    return true;
}
/**
 * Convert a route path to its corresponding HTML file path
 * Handles index routes and standard route-to-file mapping
 * @internal
 */
export function routePathToHtmlPath(routePath, baseUrl = '/', trailingSlash) {
    // First strip the baseUrl from the route
    const pathWithoutBase = stripBaseUrl(routePath, baseUrl);
    // Normalize path (remove leading slash for file path)
    const normalizedPath = removeLeadingSlash(pathWithoutBase);
    // Handle root path
    if (!normalizedPath || normalizedPath === '/') {
        return INDEX_HTML;
    }
    // Handle based on trailingSlash configuration
    if (trailingSlash === false) {
        // trailingSlash: false → /docs/myDoc.html
        if (normalizedPath.endsWith('/')) {
            // Special case: already has trailing slash, still use index.html
            return `${normalizedPath}${INDEX_HTML}`;
        }
        return `${normalizedPath}.html`;
    }
    // Default behavior (trailingSlash: true or undefined)
    // /docs/myDoc → /docs/myDoc/index.html
    if (normalizedPath.endsWith('/')) {
        return `${normalizedPath}${INDEX_HTML}`;
    }
    return `${normalizedPath}/${INDEX_HTML}`;
}