Prettier and formatting

Author: mikejolley

.prettierrc

@@ -0,0 +1,3 @@
+// Import the default config file and expose it in the project root.
+// Useful for editor integrations.
+module.exports = require( '@wordpress/prettier-config' );

.prettierrc.js

@@ -6,7 +6,7 @@
  * @type {AutomationTask[]}
  */
 module.exports = [
-	require('./automations/todos'),
-	require('./automations/release'),
-	require('./automations/assign-milestone'),
+	require( './automations/todos' ),
+	require( './automations/release' ),
+	require( './automations/assign-milestone' ),
 ];

lib/automations.js

@@ -1,8 +1,8 @@
-const runner = require('./runner');
+const runner = require( './runner' );
 
 module.exports = {
 	name: 'assign-milestone',
-	events: ['pull_request_review'],
-	actions: ['submitted', 'edited'],
+	events: [ 'pull_request_review' ],
+	actions: [ 'submitted', 'edited' ],
 	runner,
 };

lib/automations/assign-milestone/index.js

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-const debug = require('../../debug');
+const debug = require( '../../debug' );
 
 /**
  * @typedef {import('../../typedefs').GitHubContext} GitHubContext
@@ -12,56 +12,57 @@ const debug = require('../../debug');
  * @param {GitHubContext} context
  * @param {GitHub} octokit
  */
-module.exports = async (context, octokit) => {
+module.exports = async ( context, octokit ) => {
 	const pullNumber = context.payload.pull_request.number;
 	const reviewState = context.payload.review.state;
 
-	debug(`pullRequestReviewHandler: Pull Request number is [${pullNumber}].`);
-	debug(`pullRequestReviewHandler: Review state is [${reviewState}].`);
+	debug(
+		`pullRequestReviewHandler: Pull Request number is [${ pullNumber }].`
+	);
+	debug( `pullRequestReviewHandler: Review state is [${ reviewState }].` );
 
 	// Check state
-	if (reviewState !== 'approved') {
+	if ( reviewState !== 'approved' ) {
 		debug(
 			`pullRequestReviewHandler: Review state is not approved--bailing.`
 		);
 		return;
 	}
 
 	// Check current milestone
-	if (context.payload.pull_request.milestone !== null) {
+	if ( context.payload.pull_request.milestone !== null ) {
 		debug(
 			`pullRequestReviewHandler: Pull request already has a milestone--bailing.`
 		);
 		return;
 	}
 
 	// Get next milestone
-	const milestones = await octokit.issues.listMilestones({
+	const milestones = await octokit.issues.listMilestones( {
 		...context.repo,
 		sort: 'due_on',
 		direction: 'asc',
-	});
+	} );
 
-	if (!milestones.data || !milestones.data[0]) {
+	if ( ! milestones.data || ! milestones.data[ 0 ] ) {
 		debug(
 			`pullRequestReviewHandler: There are no milestones available to assign to this PR.`
 		);
 		return;
 	}
 
-	const milestoneNumber = milestones.data[0].number;
+	const milestoneNumber = milestones.data[ 0 ].number;
 
 	// Assign milestone
-	const milestoneAssigned = await octokit.issues.update({
+	const milestoneAssigned = await octokit.issues.update( {
 		...context.repo,
 		issue_number: pullNumber,
 		milestone: milestoneNumber,
-	});
+	} );
 
-	if (!milestoneAssigned) {
+	if ( ! milestoneAssigned ) {
 		debug(
-			`pullRequestReviewHandler: Could not assign milestone [${milestoneNumber}] to pull request [${pullNumber}].`
+			`pullRequestReviewHandler: Could not assign milestone [${ milestoneNumber }] to pull request [${ pullNumber }].`
 		);
-		return;
 	}
 };

lib/automations/assign-milestone/pull-request-review-handler.js

@@ -1,13 +1,13 @@
 /**
  * External dependencies
  */
-const debug = require('../../debug');
-const { setFailed } = require('@actions/core');
+const debug = require( '../../debug' );
+const { setFailed } = require( '@actions/core' );
 
 /**
  * Internal dependencies
  */
-const pullRequestReviewHandler = require('./pull-request-review-handler');
+const pullRequestReviewHandler = require( './pull-request-review-handler' );
 
 /**
  * @typedef {import('@actions/github').GitHub} GitHub
@@ -30,13 +30,13 @@ const runnerMatrix = {
  *
  * @return {AutomationTaskRunner} A runner function.
  */
-const getRunnerTask = (eventName, action) => {
-	if (!runnerMatrix[eventName]) {
+const getRunnerTask = ( eventName, action ) => {
+	if ( ! runnerMatrix[ eventName ] ) {
 		return;
 	}
 	return action === undefined
-		? runnerMatrix[eventName]
-		: runnerMatrix[eventName][action];
+		? runnerMatrix[ eventName ]
+		: runnerMatrix[ eventName ][ action ];
 };
 
 /**
@@ -47,14 +47,14 @@ const getRunnerTask = (eventName, action) => {
  *
  * @return {AutomationTaskRunner} task runner.
  */
-const runner = async (context, octokit) => {
-	const task = getRunnerTask(context.eventName, context.payload.action);
-	if (typeof task === 'function') {
-		debug(`assignMilestoneRunner: Executing the ${task.name} task.`);
-		await task(context, octokit);
+const runner = async ( context, octokit ) => {
+	const task = getRunnerTask( context.eventName, context.payload.action );
+	if ( typeof task === 'function' ) {
+		debug( `assignMilestoneRunner: Executing the ${ task.name } task.` );
+		await task( context, octokit );
 	} else {
 		setFailed(
-			`assignMilestoneRunner: There is no configured task for the event = '${context.eventName}' and the payload action = '${context.payload.action}'`
+			`assignMilestoneRunner: There is no configured task for the event = '${ context.eventName }' and the payload action = '${ context.payload.action }'`
 		);
 	}
 };

lib/automations/assign-milestone/runner.js

@@ -1,32 +1,32 @@
-const { gimmeOctokit, gimmeContext, gimmeApp } = require('@testHelpers');
+const { gimmeOctokit, gimmeContext, gimmeApp } = require( '@testHelpers' );
 
-describe('pull-request-review-handler assigns milestones to pull requests', () => {
+describe( 'pull-request-review-handler assigns milestones to pull requests', () => {
 	let octokit, context, app;
-	beforeEach(() => {
+	beforeEach( () => {
 		octokit = gimmeOctokit();
-		context = gimmeContext('pull_request_review', 'submitted');
-		app = gimmeApp('assign-milestone');
-	});
-	it('does nothing if the pull request is not approved', async () => {
+		context = gimmeContext( 'pull_request_review', 'submitted' );
+		app = gimmeApp( 'assign-milestone' );
+	} );
+	it( 'does nothing if the pull request is not approved', async () => {
 		context.payload = {
 			...context.payload,
 			review: { state: 'comment' },
 		};
-		await app(context, octokit);
-		expect(octokit.issues.update).not.toHaveBeenCalled();
-	});
-	it('does nothing if the pull request has a milestone', async () => {
+		await app( context, octokit );
+		expect( octokit.issues.update ).not.toHaveBeenCalled();
+	} );
+	it( 'does nothing if the pull request has a milestone', async () => {
 		context.payload = {
 			...context.payload,
 			pull_request: { milestone: { number: 1 } },
 		};
-		await app(context, octokit);
-		expect(octokit.issues.update).not.toHaveBeenCalled();
-	});
-	it('assigns a milestone to an approved pull request', async () => {
-		await app(context, octokit);
-		expect(octokit.issues.listMilestones).toHaveBeenCalled();
-		expect(octokit.issues.update).toHaveBeenCalled();
-		expect(octokit.issues.update.mock.calls[0]).toMatchSnapshot();
-	});
-});
+		await app( context, octokit );
+		expect( octokit.issues.update ).not.toHaveBeenCalled();
+	} );
+	it( 'assigns a milestone to an approved pull request', async () => {
+		await app( context, octokit );
+		expect( octokit.issues.listMilestones ).toHaveBeenCalled();
+		expect( octokit.issues.update ).toHaveBeenCalled();
+		expect( octokit.issues.update.mock.calls[ 0 ] ).toMatchSnapshot();
+	} );
+} );