cfpathcheck/lib/utils.js

Check CFML files for correct paths in cfinclude/cfimport tags

import path from 'node:path';
import deepEqual from 'deep-equal';

/**
 * Uses deep-equal to perform non-strict object comparison.
 *
 * @param {object} targetObject - The object to search for.
 * @param {Array<object>} list - The array of objects to search.
 *
 * @returns {boolean}
 */
export const containsObject = (targetObject, list) => list.some(item => deepEqual(item, targetObject));

/**
 * @param {string} line - The file line to check for an XML file prolog.
 *
 * @returns {boolean}
 */
export const checkIsXMLFile = (line) => {
	const regexp = /<\?xml|type="text\/xml/;
	const xmlSearch = line.match(regexp);

	if (xmlSearch === null) {
		return false;
	}

	return true;
};

/**
 * @param {string} matchString - The string to match.
 * @param {RegExp} regex - The RegExp to use.
 *
 * @returns {RegExpExecArray|Array}
 */
export const matchAll = (matchString, regex) => {
	const result = [];
	let m;
	if (regex.global) {
		while ((m = regex.exec(matchString))) {
			result.push(m);
		}
	} else if ((m = regex.exec(matchString))) {
		result.push(m);
	}

	return result;
};

/**
 *
 * @param {string} filePath - The path to normalise
 * @returns {string}
 */
export const normalisePath = (filePath) => {
	// Resolve the path, if a relative path was passed in
	if (!path.isAbsolute(filePath)) {
		filePath = path.resolve(filePath);
	}

	return filePath;
};