doxdox-core/dist/utils.js

Core package for doxdox.

import fs from 'node:fs/promises';
import { resolve, dirname } from 'node:path';
import { fileURLToPath } from 'node:url';
import normalizeData from 'normalize-package-data';
/**
 * Finds file in path.
 *
 *     console.log(await findFileInPath('./', 'package.json'));
 *     console.log(await findFileInPath('../', 'package.json'));
 *     console.log(await findFileInPath('~/git/github/doxdox/', '.package.json'));
 *
 * @param {string} [input] Directory to check for file.
 * @param {string?} [fileName = 'package.json'] File name to check for.
 * @return {Promise<string | null>} Path to package.json file.
 * @public
 */
export const findFileInPath = async (input, fileName = 'package.json') => {
    try {
        const inputDirectory = (await fs.stat(input)).isFile()
            ? dirname(input)
            : input;
        const filePath = resolve(inputDirectory, fileName);
        const fileStat = await fs.stat(filePath);
        if (fileStat.isFile()) {
            return filePath;
        }
    }
    catch (err) {
        if (process.env.DEBUG) {
            console.error(err);
        }
    }
    return null;
};
/**
 * Finds the closest node_module folder in the parent directories.
 *
 * @param {string} [currentDirectory] Current directory.
 * @param {number} [maxDepth] Optional max depth.
 * @return {Promise<string | null>} Path to node_modules directory.
 * @public
 */
export const findParentNodeModules = async (currentDirectory, 
// eslint-disable-next-line no-magic-numbers
maxDepth = 5) => {
    if (maxDepth > 0) {
        try {
            const nodeModulesPath = resolve(currentDirectory, 'node_modules');
            if (await fs.stat(nodeModulesPath)) {
                return nodeModulesPath;
            }
        }
        catch {
            const parentDirectory = resolve(currentDirectory, '..');
            return await findParentNodeModules(parentDirectory, --maxDepth);
        }
    }
    return null;
};
/**
 * Returns basic information from a projects package file.
 *
 * @return {Promise<Package>} Basic information from a package file.
 * @public
 */
export const getProjectPackage = async (cwd) => {
    const projectPackagePath = await findFileInPath(cwd);
    if (projectPackagePath) {
        const packageContents = await fs.readFile(projectPackagePath, 'utf8');
        const { doxdoxConfig, ...packageData } = JSON.parse(packageContents);
        normalizeData(packageData);
        const { name, description, version, exports, homepage } = packageData;
        return {
            name,
            description,
            version,
            exports,
            homepage,
            doxdoxConfig
        };
    }
    return {};
};
/**
 * Get the root directory of the package, supplied path or URL.
 *
 * @param {string?} [url] Optional path or URL.
 * @return {string} Directory path.
 * @public
 */
export const getRootDirPath = (url) => dirname(fileURLToPath(url || import.meta.url));
/**
 * Checks to see if path is a directory.
 *
 * @param {string} [path] Path to check.
 * @return {Promise<boolean>}
 * @public
 */
export const isDirectory = async (path) => {
    try {
        return (await fs.stat(path)).isDirectory();
    }
    catch {
        return false;
    }
};
/**
 * Checks to see if path is a file.
 *
 * @param {string} [path] Path to check.
 * @return {Promise<boolean>}
 * @public
 */
export const isFile = async (path) => {
    try {
        return (await fs.stat(path)).isFile();
    }
    catch {
        return false;
    }
};
/**
 * Return information about pattern if found within contents.
 *
 * @param {string} [content] Full contents to search for pattern in.
 * @param {string} [pattern] Pattern to look for in contents.
 * @return {{ start?: number; end?: number; matched: boolean }}
 * @public
 */
export const multiLinePatternMatch = (content, pattern, offset = 0) => {
    const matched = content.includes(pattern);
    if (!matched) {
        return { matched };
    }
    const contentLines = content.split(/\r?\n/);
    const patternLines = pattern.split(/\r?\n/);
    for (let i = offset; i < contentLines.length; i += 1) {
        if (contentLines[i] === patternLines[0]) {
            const contentGroup = contentLines
                .slice(i, i + patternLines.length)
                .join('\n');
            const patternGroup = patternLines.join('\n');
            if (contentGroup === patternGroup) {
                return {
                    start: i,
                    end: i + patternLines.length,
                    matched
                };
            }
        }
    }
    return { matched: false };
};
/**
 * Parse config key/value pairs from raw CLI flags.
 *
 *     console.log(await parseConfigFromCLI([['-c', 'key=value']]));
 *
 * @param {[string, string | boolean][]} rawFlags Raw flags from the CLI.
 * @return {{ [key in string]: string | boolean }} Configs key/value pairs.
 * @public
 */
export const parseConfigFromCLI = (rawFlags) => rawFlags
    .filter(([flag]) => ['-c', '--config'].includes(flag))
    .reduce((all, [, config]) => {
    const [key, value] = String(config).split('=');
    if (['true', 'false'].includes(value)) {
        return { ...all, [key]: value === 'true' ? true : false };
    }
    else {
        return { ...all, [key]: value };
    }
}, {});
/**
 * Parse contents of ignore file.
 *
 *     console.log(await parseIgnoreConfig('node_modules/'));
 *
 * @param {string} [contents] Contents of ignore file.
 * @return {string[]} List of ignored paths and files.
 * @public
 */
export const parseIgnoreConfig = (contents) => contents
    .trim()
    .split(/\r?\n/)
    .filter(line => line.trim())
    .map(line => `!${line.trim().replace(/^!/, '')}`);
/**
 * Slugify a value for use as an anchor.
 *
 * @return {string} Contents to slugify.
 * @public
 */
export const slugify = (contents) => contents
    .toLowerCase()
    .replace(/[^a-z]+/g, '-')
    .replace(/^-|-$/, '');