detect-dot-only-hook.js

/*---------------------------------------------------------------------------------------------
 *  Copyright (C) 2024 Posit Software, PBC. All rights reserved.
 *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
 *--------------------------------------------------------------------------------------------*/

const es = require('event-stream');
const child_process = require('child_process');

const detectDotOnlyHook = (reporter) => {
	// If SKIP_DOT_ONLY_CHECK is set, skip the check
	if (process.env.SKIP_DOT_ONLY_CHECK) {
		reporter('Skipping .only check for staged test files because SKIP_DOT_ONLY_CHECK is set\n', false);
		return es.through(function () {
			/* noop, important for the stream to end */
		});
	}

	try {
		const result = child_process.execSync('node build/detect-dot-only.js', { encoding: 'utf8' });
	} catch (error) {
		let message = '';
		// See ExitCodes in build/detect-dot-only.js
		switch (error.status) {
			case 1:
				message = 'If you want to skip the .only check, set SKIP_DOT_ONLY_CHECK in your environment.\n\te.g., `SKIP_DOT_ONLY_CHECK=1 git commit`';
				break;
			case 2:
				message = 'detect-dot-only.js encountered an error...';
				break;
			default:
				message = 'Encountered an error while running the hook to detect .only in staged test files.';
				break;
		}
		reporter(message + '\n', true);
	}
	return es.through(function () {
		/* noop, important for the stream to end */
	});
};

module.exports = detectDotOnlyHook;