site-validator-cli/index.js

A command line tool that takes a URL or a file, then uses html-validator (a wrapper for https://validator.w3.org/nu/) to validate each page.

#!/usr/bin/env node
'use strict'

/*
Require statements
 */
const minimist = require('minimist')
const sanitize = require('sanitize-filename')
const pkg = require('./package.json')
const getHelpText = require('./lib/console-texts/get-help-text')
const getSummaryText = require('./lib/console-texts/get-summary-text')
const clearCache = require('./lib/clear-cache')
const getOption = require('./lib/get-option')
const getUrls = require('./lib/get-urls')
const validatePages = require('./lib/validate-pages')
const exportOutput = require('./lib/output/export-output')
const viewOutput = require('./lib/output/view-output')
const { cyanOnBlack } = require('./lib/clc')
const exit = require('./lib/exit')

/*
Parsing query parameters
 */
const query = process.argv[2]
const argv = minimist(process.argv.slice(2))
const outputName = `${new Date().toISOString().substring(0, 19).replace(/[:\-_]/gi, '')}`

const options = {
  cacheTime: getOption(['cache', 'cacheTime'], argv),
  clearCache: getOption(['clear-cache', 'clearCache'], argv),
  failfast: getOption(['ff'], argv),
  verbose: getOption(['verbose'], argv),
  quiet: getOption(['quiet'], argv),
  singlePage: getOption(['page'], argv),
  isLocal: getOption(['local', 'isLocal'], argv),
  output: argv.output ? argv.output === true ? outputName : sanitize(argv.output) : false,
  view: getOption(['view'], argv),
  path: argv.path || argv.url ? getOption(['path', 'url'], argv) : argv._[0]
}

// set cache time (defaults to 60 minutes if unset)
if (options.cacheTime === false) {
  options.cacheTime = 60
}

/*
Process query parameters
 */
var helpKW = ['help', '-h', '--help']
if (!query || helpKW.map(kw => { return process.argv.includes(kw) }).includes(true)) {
  exit(getHelpText())
}

var versionKW = ['version', '-v', '--version']
if (versionKW.map(kw => { return process.argv.includes(kw) }).includes(true)) {
  exit(pkg.version)
}

if (options.view !== false) {
  if (options.view !== true) {
    viewOutput(options.view)
  } else {
    viewOutput(options.path)
  }
}

if (options.path === undefined) {
  if (options.clearCache) {
    clearCache('sitemap')
  }
  exit('No path entered. \nIf path is not the 1st argument, you must prepend it with --url or --path.')
}

/*
Main Process
 */
(async () => {
  try {
    const pagesToValidate = await getUrls(options)
    console.log(`\nEvaluating a total of ${pagesToValidate.length} pages`)
    console.log('═════════════════════════════════════════════════════════════')
    if (options.verbose) { console.log('') }
    const results = await validatePages(pagesToValidate, options)
    console.log('═════════════════════════════════════════════════════════════')
    console.log(getSummaryText(options.path, results))
    if (options.output) { exportOutput(results, options) }
    exit(cyanOnBlack('Finished Checking, have an A-1 Day!'))
  } catch (error) {
    exit(error, true)
  }
})()