index.js

#!/usr/bin/env node

import walkSync from 'walk-sync';
import chalk from 'chalk';
import yargs from 'yargs';
import { hideBin } from 'yargs/helpers';

import { fetchLinks, filterArray } from './src/utils.js';
import { checkLinks } from './src/checker.js';

const options = yargs(hideBin(process.argv))
	.options({
		dir: {
			alias: 'directory',
			description: 'directory path',
			type: 'string',
		},
		file: {
			alias: 'file',
			description: 'file path',
			type: 'string',
		},
		url: {
			alias: 'storybook-url',
			description: 'storybook live or local build url',
			type: 'string',
		},
		ignore: {
			alias: 'ignore-pattern',
			description: 'ignore pattern',
			type: 'string',
		},
		onlyFail: {
			alias: 'only-fail',
			description: 'only show failed links',
			type: 'boolean',
			default: false,
		},
	})
	.check((argv) => {
		if (!argv.dir && !argv.file) {
			throw new Error(`${chalk.red('Missing required :')} dir/file`);
		}
		return true;
	})
	.help().argv;

let dir = options.dir;
const file = options.file;
const storybookURL = options.url;
const ignorePattern = options.ignore
	? options.ignore.split(',')
	: options.ignore;
const onlyFail = options.onlyFail;

// fetch the filepaths from directory or standalone file
let filePaths = [];

if (file) {
	const fileName = file.replace(/^.*[\\\/]/, '');
	filePaths.push(fileName);
	dir = file.replace(/[^\\\/]*$/, '');
} else {
	filePaths = walkSync(dir, { directories: false });
}

const linkObject = fetchLinks(dir, filePaths);

process.exitCode = 0;

if (onlyFail) {
	console.log = function () {};
}

checkLinks(linkObject, storybookURL, ignorePattern)
	.then((errFiles) => {
		if (errFiles.length > 0) {
			const filteredFiles = filterArray(errFiles);
			console.error(
				'\n\n',
				chalk.red(
					`${filteredFiles.length} files have broken links. Please fix them before committing.`
				)
			);
			console.error(chalk.red(filteredFiles.join('\n')));
			process.exitCode = 1;
		} else {
			console.log('\n\n', chalk.green(`No broken links found.`));
		}
		process.exit();
	})
	.catch((err) => {
		console.error(err);
		process.exitCode = 1;
		process.exit();
	});