index.js

#!/usr/bin/env node

import chalk from 'chalk';
import path from 'path';
import { mdLinks } from './src/md-links.js';


/**
 *  Check if a file or folder path was supplied as 3rd argument in CLI.
 */
function detectFolderPath() {
    // Initialize the folderPath and options objects
    const folderPath = process.argv[2];
    const options = {};

    console.log(chalk.magentaBright.bgWhiteBright.bold('\n\n\t\t\t\t\t\t MD Links \n'));
    console.log(chalk.whiteBright.bold('\t\t\t\t\tby María-Fernanda Villalobos \n\n'));

    // Check if help option was passed as a CLI argument
    if (process.argv.includes('--help')) {
        // Print the help message and return if the `--help` flag is present
        console.log(chalk.whiteBright('Usage: md-links <path-to-file> [options]'));
        console.log(chalk.whiteBright('\nOptions:'));
        console.log(chalk.whiteBright('\t--validate  Check if the links are broken'));
        console.log(chalk.whiteBright('\t--stats     Show statistics of the links'));
        console.log(chalk.whiteBright('\t--help      Show this help message'));
        console.log('\n');
        return;
    }
    // Check if stats option was passed as a CLI argument
    if (process.argv.includes('--stats')) {
        options.stats = true;
    }

    // Check if validate option was passed as a CLI argument
    if (process.argv.includes('--validate')) {
        options.validate = true;
    }

    // Check if the folderPath is empty
    if (!folderPath) {
        console.error(chalk.whiteBright.bgRed.bold('Error: '), chalk.red('You must enter the path to the folder/file to be read. \n\tFormat: md-links <path-to-file> [options]\n\n '));
    } else {
        // Call mdLinks() function to extract and validate links
        mdLinks(path.resolve(folderPath), options)
            .then(results => {
                if (options.stats) {
                    // Print statistics if `--stats` flag is present
                    const total = results.length;
                    const unique = new Set(results.map(result => result.href)).size;
                    const totalFiles = new Set(results.map(result => result.fileName)).size;
                    console.log(chalk.bgHex('#00F5FF').bold('Total Files:    '), chalk.hex('#00F5FF')(totalFiles));
                    console.log(chalk.bgHex('#69FF63').bold('Total Links:    '), chalk.hex('#69FF63')(total));
                    console.log(chalk.bgHex('#FCE700').bold('Unique Links:   '), chalk.hex('#FCE700')(unique));
                    
                    if (options.validate) {
                        const broken = results.filter(result => result.status !== 200).length;
                        const percentageBroken = ((broken / total) * 100).toFixed(2);
                        console.log(chalk.bgHex('#FF6D28').bold('Broken Links:   '), chalk.hex('#FF6D28')(broken));
                        console.log(chalk.bgHex('#EA047E').bold('% Broken Links: '), chalk.hex('#EA047E')(percentageBroken + '%'));

                    }
                    console.log('\n\n');

                } else {
                    results.forEach(result => {
                        // Print each link with its details if `--stats` flag is not present
                        console.log(chalk.bgHex('#9B59FF').bold('Line:      '), chalk.hex('#9B59FF')(result.linkLine));
                        console.log(chalk.bgHex('#EA047E').bold('Href:      '), chalk.hex('#EA047E')(result.href));
                        console.log(chalk.bgHex('#FF6D28').bold('Text:      '), chalk.hex('#FF6D28')(result.text));
                        console.log(chalk.bgHex('#FCE700').bold('Path:      '), chalk.hex('#FCE700')(folderPath));
                        console.log(chalk.bgHex('#69FF63').bold('Extension: '), chalk.hex('#69FF63')(result.extension));
                        if (options.validate) {
                            console.log(chalk.bgHex('#00F5FF').bold('State:     '), chalk.hex('#00F5FF')(result.status), result.statusMessage ? chalk.bgGreenBright.bold.green(' OK ') : chalk.bgRedBright.bold.red(' FAIL '));
                        }
                        console.log('\n\n');
                    });
                }
            })
            .catch(err => {
                console.error(chalk.whiteBright.bgRed.bold('Error: '), chalk.red(err.message));
            });
    }
}


detectFolderPath()