pre-commit-hook.mjs

/**
 * External dependencies
 */
import { execSync, spawnSync } from 'child_process';
import { existsSync } from 'fs';
import chalk from 'chalk';
import path from 'path';
import _ from 'lodash';
import { fileURLToPath } from 'url';
import { dirname } from 'path';

const __filename = fileURLToPath( import.meta.url );
const __dirname = dirname( __filename );

/*
 * A lot of this code has been liberally borrowed from the wp-calypso pre-commit script
 * https://github.com/Automattic/wp-calypso/blob/master/bin/pre-commit-hook.js
 */

const phpcsChangedPath = getPathForCommand( 'phpcs-changed' );
const phpcsPath = getPathForCommand( 'phpcs' );
const phpcbfPath = getPathForCommand( 'phpcbf' );

function quotedPath( pathToQuote ) {
	if ( pathToQuote.includes( ' ' ) ) {
		return `"${ pathToQuote }"`;
	}
	return pathToQuote;
}

/**
 * Parses the output of a git diff command into file paths.
 *
 * @param   {string} command Command to run. Expects output like `git diff --name-only […]`
 * @returns {Array}          Paths output from git command
 */
function parseGitDiffToPathArray( command ) {
	return execSync( command, { encoding: 'utf8' } )
		.split( '\n' )
		.map( ( name ) => name.trim() )
		.filter( ( name ) =>
			/(?:\.json|\.[jt]sx?|\.scss|\.php)$/.test( name )
		);
}

function getPathForCommand( command ) {
	const composerBinDir = path.join( __dirname, 'vendor', 'bin' );
	let path_to_command;
	try {
		path_to_command = execSync( 'command -v ' + command, {
			encoding: 'utf8',
		} );
	} catch ( e ) {
		path_to_command = path.join( composerBinDir, command );
	}
	if ( typeof path_to_command === 'undefined' || ! path_to_command ) {
		return false;
	}
	return _.trim( path_to_command );
}

function printPhpcsDocs() {
	console.log(
		chalk.red( 'COMMIT ABORTED:' ),
		'Working with PHP files in this repository requires the PHP Code Sniffer and its dependencies to be installed. Make sure you have composer installed on your machine and from the root of this repository, run `composer install`.'
	);
	process.exit( 1 );
}

function phpcsInstalled() {
	if ( existsSync( phpcsPath ) && existsSync( phpcsChangedPath ) ) {
		return true;
	}
	return false;
}

function phpcbfInstalled() {
	if ( existsSync( phpcbfPath ) ) {
		return true;
	}
	return false;
}

function linterFailure() {
	console.log(
		chalk.red( 'COMMIT ABORTED:' ),
		'The linter reported some problems. ' +
			'If you are aware of them and it is OK, ' +
			'repeat the commit command with --no-verify to avoid this check.'
	);
	process.exit( 1 );
}

// determine if PHPCS is available
const phpcs = phpcsInstalled();

// determine if PHPCBF is available
const phpcbf = phpcbfInstalled();

// grab a list of all the php files staged to commit
const phpFiles = parseGitDiffToPathArray(
	'git diff --cached --name-only --diff-filter=ACM'
).filter( ( file ) => file.endsWith( '.php' ) );

if ( phpFiles.length ) {
	const phpcbfResult = spawnSync( phpcbfPath, [ ...phpFiles ], {
		shell: true,
		stdio: 'inherit',
	} );

	if ( phpcbfResult && phpcbfResult.status ) {
		execSync( `git add ${ phpFiles.join( ' ' ) }` );
		console.log(
			chalk.yellow(
				'PHPCS issues detected and automatically fixed via PHPCBF.'
			)
		);
	}

	if ( phpcs ) {
		const lintResult = spawnSync(
			`PHPCS=${ quotedPath( phpcsPath ) } ${ quotedPath(
				phpcsChangedPath
			) }`,
			[ '--git', ...phpFiles ],
			{
				shell: true,
				stdio: 'inherit',
			}
		);

		if ( lintResult.status ) {
			linterFailure();
		}
	}
}

// grab a list of all the js files staged to commit
const jsFiles = parseGitDiffToPathArray(
	'git diff --cached --name-only --diff-filter=ACM'
).filter( ( file ) => file.endsWith( '.js' ) );

if ( jsFiles.length ) {
	jsFiles.forEach( ( file ) =>
		console.log( `Prettier formatting staged file: ${ file }` )
	);
	execSync(
		`./node_modules/.bin/prettier --ignore-path .eslintignore --write ${ jsFiles.join(
			' '
		) }`
	);
	execSync( `git add ${ jsFiles.join( ' ' ) }` );
}