check-outdated/helper/files.js

Light-weight CLI tool to ensure that your dependencies are up to date, otherwise the process is terminated with status code 1.

/**
 * @file File- and path-handling related functionality.
 */

const fs = require('fs');
const path = require('path');

/**
 * Structure of the package.json.
 *
 * @typedef {{
 *   readonly name?: string;
 *   readonly version?: string;
 *   readonly homepage?: string;
 *   readonly repository?: string | {
 *     readonly type?: string;
 *     readonly url?: string;
 *     readonly directory?: string
 *   };
 *   readonly author?: string | {
 *     readonly name?: string;
 *     readonly email?: string;
 *     readonly url?: string
 *   };
 * }} PackageJSON
 */

/**
 * Returns the content of the package.json of a given dependency.
 *
 * @public
 * @param {string} dependencyLocation - The folder where the dependency is located.
 * @returns {PackageJSON} Either the content of the package.json or an empty object.
 */
function getDependencyPackageJSON (dependencyLocation) {
	const filePath = path.join(getRelativeDependencyPath(dependencyLocation), 'package.json');
	const fileContent = readFile(filePath);

	if (fileContent !== undefined) {
		try {
			return JSON.parse(fileContent);
		}
		catch { /* We ignore errors here */ }
	}

	return {};
}

/**
 * Returns the content of the package.json of a given dependency.
 *
 * @public
 * @param {string} dependencyLocation - The folder where the dependency is located.
 * @returns {string} Either the content of the package.json or an empty object.
 */
function getParentPackageJSONPath (dependencyLocation) {
	let filePath = path.resolve(process.cwd(), getRelativeDependencyPath(dependencyLocation));

	while (filePath !== '' && path.basename(filePath) !== 'node_modules') {
		filePath = path.dirname(filePath);
	}

	return path.join(path.dirname(filePath), 'package.json');
}

/**
 * Returns the file path to the CHANGELOG.md of a given dependency.
 *
 * @public
 * @param {string} dependencyLocation - The folder where the dependency is located.
 * @returns {string | undefined} Either the file path or undefined, if the file does not exist.
 */
function getChangelogPath (dependencyLocation) {
	const filePath = path.join(getRelativeDependencyPath(dependencyLocation), 'CHANGELOG.md');

	try {
		if (fs.existsSync(filePath)) {
			return path.relative(process.cwd(), filePath).replace(/\\/gu, '/');
		}
	}
	catch { /* We ignore errors here */ }

	return undefined;
}

/**
 * Returns the content of a file.
 *
 * @public
 * @param {string} filePath - The path/file name.
 * @returns {string | undefined} The content of the file or `undefined`, if an error occurs.
 */
function readFile (filePath) {
	try {
		return fs.readFileSync(filePath, 'utf8');
	}
	catch { /* Do nothing here, but return undefined in the next step */ }

	return undefined;
}

/**
 * Returns the relative path to dependency to the current working directory.
 *
 * @private
 * @param {string} dependencyLocation - The folder where the dependency is located.
 * @returns {string} The path to a dependency.
 */
function getRelativeDependencyPath (dependencyLocation) {
	return path.relative(process.cwd(), dependencyLocation.replace(/^node_modules[\\/]/u, path.join(process.cwd(), 'node_modules/'))).replace(/\\/gu, '/');
}

module.exports = {
	getChangelogPath,
	getDependencyPackageJSON,
	getParentPackageJSONPath,
	readFile
};