alfresco-ng2-components/tools/doc/tools/fileChecker.js

'use strict';
/*!
 * @license
 * Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var path = require('path');
var fs = require('fs');
var unist_util_select_1 = require('unist-util-select');
var lev = require('fast-levenshtein');
var ngHelpers = require('../ngHelpers');
var imageFolderPath = path.resolve('docs', 'docassets', 'images');
// Using this value for the edit distance between Markdown image URLs
// and filenames is enough to trap errors like missing out the 'images'
// folder in the path. Keeping it low avoids crazy suggestions.
var maxImagePathLevDistance = 7;
function processDocs(mdCache, aggData) {
    var pathnames = Object.keys(mdCache);
    var classlessDocs = [];
    var linkRefs = {};
    var imageRefs = {};
    var brokenImageRefs = {};
    var filters = makeFilepathFilters(aggData.config['fileCheckerFilter']);
    pathnames.forEach(function (pathname) {
        var fileBaseName = path.basename(pathname, '.md');
        var tree = mdCache[pathname].mdOutTree;
        var className = ngHelpers.ngNameToClassName(fileBaseName, aggData.config.typeNameExceptions);
        var classInfo = aggData.classInfo[className];
        if (!classInfo) {
            if (!filterFilepath(filters, pathname)) {
                classlessDocs.push(pathname);
            }
        } else {
            var linkElems = (0, unist_util_select_1.selectAll)('link', tree);
            linkElems.forEach(function (linkElem) {
                var normUrl = normaliseLinkPath(pathname, linkElem.url);
                multiSetAdd(linkRefs, normUrl, pathname);
            });
        }
        var imageElems = (0, unist_util_select_1.selectAll)('image', tree);
        imageElems.forEach(function (imageElem) {
            var normUrl = normaliseLinkPath(pathname, imageElem.url);
            multiSetAdd(imageRefs, normUrl, pathname);
            if (!fs.existsSync(normUrl)) {
                brokenImageRefs[normUrl] = pathname;
            }
        });
    });
    classlessDocs.forEach(function (docPath) {
        var relDocPath = docPath.substring(docPath.indexOf('docs'));
        console.group('Warning: no source class found for "'.concat(relDocPath, '"'));
        if (linkRefs[docPath]) {
            linkRefs[docPath].forEach(function (linkRef) {
                var relLinkPath = linkRef.substring(linkRef.indexOf('docs'));
                console.log('Linked from: "'.concat(relLinkPath, '"'));
            });
        }
        console.groupEnd();
    });
    console.log();
    var imagePaths = getImagePaths(imageFolderPath);
    imagePaths.forEach(function (imagePath) {
        if (!imageRefs[imagePath]) {
            var relImagePath = imagePath.substring(imagePath.indexOf('docs'));
            console.log('Warning: no links to image file "'.concat(relImagePath, '"'));
        }
    });
    console.log();
    var brokenImUrls = Object.keys(brokenImageRefs);
    brokenImUrls.forEach(function (url) {
        var relUrl = url.substring(url.indexOf('docs'));
        var relDocPath = brokenImageRefs[url].substring(brokenImageRefs[url].indexOf('docs'));
        console.group('Broken image link "'.concat(relUrl, '" found in "').concat(relDocPath));
        imagePaths.forEach(function (imPath) {
            if (lev.get(imPath, url) <= maxImagePathLevDistance) {
                var relImPath = imPath.substring(imPath.indexOf('docs'));
                console.log('Should it be "'.concat(relImPath, '"?'));
            }
        });
        console.groupEnd();
    });
}
function normaliseLinkPath(homeFilePath, linkUrl) {
    var homeFolder = path.dirname(homeFilePath);
    return path.resolve(homeFolder, linkUrl);
}
function getImagePaths(imageFolder) {
    var files = fs.readdirSync(imageFolder);
    return files.map(function (f) {
        return path.resolve(imageFolder, f);
    });
}
function makeFilepathFilters(patterns) {
    return patterns.map(function (r) {
        return new RegExp(r);
    });
}
function filterFilepath(filters, filepath) {
    for (var i = 0; i < filters.length; i++) {
        if (filters[i].test(filepath)) {
            return true;
        }
    }
    return false;
}
function multiSetAdd(container, key, value) {
    if (container[key]) {
        container[key].push(value);
    } else {
        container[key] = [value];
    }
}