md-links-gavp/bin/cli.js

A library that finds and validates the status of the links inside a markdown file

#!/usr/bin/env node
const chalk = require('chalk');
const figlet = require('figlet');
const { program } = require('commander');
const { mdLinks } = require('../src/index');

program.version('0.0.1');

console.log(chalk.blueBright(figlet.textSync('MD-LINKS', {
  font: 'jazmine',
  horizontalLayout: 'default',
  verticalLayout: 'default',
})));
const helpMessage = chalk.white(`
${chalk.bold('The valid format of the command is:')} 
            << ${chalk.greenBright.bold.underline('md-links + <path> + option')} >>

 Example: ${chalk.magentaBright('md-links ../CDMX011-md-links --validate')} 
  
 And these are the ${chalk.bold('posible options')} you can choose from the Library...

${chalk.cyanBright(`
+--------------------+----------------------------------------------------+
|      OPTIONS       |                      MEANING                       |
+--------------------+----------------------------------------------------+
| -val, --validate   | Validate the status of the links in Markdown files |
| -st, --stats       | Get basic statistics about the links               |
| --validate --stats |                                                    |
|         or         | Get statistics about the links and how many links  |
| --stats --validate |  are broken                                        |
+--------------------+----------------------------------------------------+
`)}
`);

program
  .name('MD-LINKS CLI');
program
  .option('-val, --validate', 'Validate the status of the links in Markdown files')
  .option('-st, --stats', 'Get basic statistics about the links');

program.parse(process.argv);
const options = program.opts();
const args = process.argv.slice(2);

if (args.length === 1) {
  mdLinks(args[0], { validate: false, stats: false })
    .then((res) => {
      console.log('\n', chalk.underline.bgCyan.bold('The links in your Markdown files are:'));
      res.map((object) => console.log('\n', chalk.magentaBright(object.file), chalk.yellow(object.href), chalk.blueBright(object.text)));
    })
    .catch((err) => console.error('\n', chalk.redBright.bold.underline(err), '\n', helpMessage));
}

if (args.length === 2) {
  if (options.validate) {
    mdLinks(args[0], { validate: true, stats: false })
      .then((res) => {
        console.log('\n', chalk.underline.bgCyan.bold('The links validated in your Markdown files are:'));
        res.map((object) => {
          let statusColor = chalk.redBright(object.status);
          if (object.status >= 200 && object.status < 400) {
            statusColor = chalk.greenBright(object.status);
          }
          return console.log('\n', chalk.magentaBright(object.file), chalk.yellow(object.href), statusColor, chalk.white(object.message), chalk.blue(object.text));
        });
      })
      .catch((err) => console.error('\n', chalk.redBright.bold.underline(err), '\n', helpMessage));
  } else if (options.stats) {
    mdLinks(args[0], { validate: false, stats: true })
      .then((res) => {
        console.log('\n', chalk.underline.bgCyan.bold('The basic statistics about the links in your Markdown files are:'));
        console.log(`\nTotal: ${chalk.magentaBright(res.Total)} \nUnique: ${chalk.cyanBright(res.Unique)}`);
      })
      .catch((err) => console.error('\n', chalk.redBright.bold.underline(err)));
  }
}

if (args.length === 3) {
  if (options.validate && options.stats) {
    mdLinks(args[0], { validate: true, stats: true })
      .then((res) => {
        console.log('\n', chalk.underline.bgCyan.bold('The statistics about the validated links are:'));
        console.log(`\nTotal: ${chalk.magentaBright(res.Total)} \nUnique: ${chalk.cyanBright(res.Unique)} \nBroken:${chalk.redBright(res.Broken)}`);
      })
      .catch((err) => console.error('\n', chalk.redBright.bold.underline(err)));
  }
}

if (args[0] === undefined) {
  console.log(helpMessage);
}