Framework: add codemod to clean up duplicate state/utils imports

bin/codemods/combine-state-utils-imports

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+/*
+	This codemod combines state/utils imports
+
+	How to use:
+	./bin/codemods/combine-state-utils-imports path-to-transform/
+*/
+
+/**
+ * External dependencies
+ */
+const path = require( 'path' );
+const child_process = require( 'child_process' );
+
+/**
+ * Internal dependencies
+ */
+const config = require( './config' );
+const helpers = require( './helpers' );
+
+const args = process.argv.slice( 2 );
+if ( args.length === 0 ) {
+	process.stdout.write( 'No files to transform\n' );
+	process.exit( 0 );
+}
+
+const binArgs = [
+	// jscodeshift options
+	'--transform=bin/codemods/src/combine-state-utils-imports.js',
+	...config.jscodeshiftArgs,
+
+	// Transform target
+	args[ 0 ],
+];
+const binPath = path.join( '.', 'node_modules', '.bin', 'jscodeshift' );
+const jscodeshift = child_process.spawn( binPath, binArgs );
+helpers.bindEvents( jscodeshift );

bin/codemods/src/combine-state-utils-imports.js

@@ -0,0 +1,78 @@
+/*
+ This codemod updates
+
+ import { createReducer } from 'state/utils';
+ import { combineReducersWithPersistence as bar, baz } from 'state/utils'
+
+ to
+
+ import { baz, combineReducersWithPersistence as bar, createReducer } from 'state/utils';
+ */
+
+module.exports = function ( file, api ) {
+	// alias the jscodeshift API
+	const j = api.jscodeshift;
+	// parse JS code into an AST
+	const root = j( file.source );
+
+	const stateUtilsImports = root.find( j.ImportDeclaration, {
+		source: {
+			type: 'Literal',
+			value: 'state/utils',
+		},
+	} );
+
+	if ( stateUtilsImports.length < 2 ) {
+		return;
+	}
+
+	//grab each identifier
+	const importNames = [];
+	stateUtilsImports.find( j.ImportSpecifier ).forEach( item => {
+		importNames.push( {
+			local: item.value.local.name,
+			imported: item.value.imported.name
+		} );
+	} );
+
+	//sort by imported name
+	importNames.sort(( a, b ) => {
+		if( a.imported < b.imported ) {
+			return -1;
+		}
+		if( a.imported > b.imported ) {
+			return 1;
+		}
+		return 0;
+	} );
+
+	//Save Comment if possible
+	const comments = stateUtilsImports.at( 0 ).get().node.comments;
+
+	const addImport = ( importNames ) => {
+		const names = importNames.map( name => {
+			if ( name.local === name.imported ) {
+				return j.importSpecifier( j.identifier( name.local ) );
+			}
+			if ( name.local !== name.imported ) {
+				return j.importSpecifier( j.identifier( name.imported ), j.identifier( name.local ) );
+			}
+		} );
+		const combinedImport = j.importDeclaration(
+			names,
+			j.literal( 'state/utils' )
+		);
+		combinedImport.comments = comments;
+		return combinedImport;
+	};
+
+	//replace the first one with the combined import
+	stateUtilsImports.at( 0 ).replaceWith( addImport( importNames ) );
+	//remove the rest
+	for ( let i = 1; i < stateUtilsImports.length; i ++ ) {
+		stateUtilsImports.at( i ).remove();
+	}
+
+	// print
+	return root.toSource( { quote: 'single' } );
+};

client/extensions/wp-super-cache/state/cache/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	WP_SUPER_CACHE_DELETE_CACHE,
 	WP_SUPER_CACHE_DELETE_CACHE_FAILURE,

client/extensions/wp-super-cache/state/notices/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import { itemsSchema } from './schema';
 import {
 	WP_SUPER_CACHE_RECEIVE_NOTICES,

client/extensions/wp-super-cache/state/settings/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import { itemsSchema } from './schema';
 import {
 	WP_SUPER_CACHE_RECEIVE_SETTINGS,

client/extensions/wp-super-cache/state/stats/reducer.js

@@ -6,8 +6,8 @@ import { get } from 'lodash';
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import { statsSchema } from './schema';
 import {
 	WP_SUPER_CACHE_DELETE_FILE,

client/state/account-recovery/reducer.js

@@ -2,9 +2,8 @@
  * Internal dependencies
  */
 import reset from './reset/reducer';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import settings from './settings/reducer';
-import { createReducer } from 'state/utils';
 
 import {
 	ACCOUNT_RECOVERY_SETTINGS_FETCH,

client/state/account-recovery/reset/reducer.js

@@ -6,8 +6,8 @@ import { stubTrue, stubFalse } from 'lodash';
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	ACCOUNT_RECOVERY_RESET_OPTIONS_ERROR,
 	ACCOUNT_RECOVERY_RESET_OPTIONS_RECEIVE,

client/state/account-recovery/settings/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	ACCOUNT_RECOVERY_SETTINGS_FETCH_SUCCESS,
 

client/state/application/reducer.js

@@ -5,8 +5,7 @@ import {
 	CONNECTION_LOST,
 	CONNECTION_RESTORED
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 export const connectionState = createReducer( 'CHECKING', {
 	[ CONNECTION_LOST ]: () => 'OFFLINE',

client/state/automated-transfer/reducer.js

@@ -7,11 +7,7 @@ import { get } from 'lodash';
  * Internal dependencies
  */
 import eligibility from './eligibility/reducer';
-import { combineReducersWithPersistence } from 'state/utils';
-import {
-	keyedReducer,
-	withSchemaValidation,
-} from 'state/utils';
+import { combineReducersWithPersistence, keyedReducer, withSchemaValidation } from 'state/utils';
 import { transferStates } from './constants';
 import { automatedTransfer as schema } from './schema';
 import {

client/state/billing-transactions/reducer.js

@@ -10,9 +10,8 @@ import {
 	BILLING_TRANSACTIONS_REQUEST_FAILURE,
 	BILLING_TRANSACTIONS_REQUEST_SUCCESS
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import { billingTransactionsSchema } from './schema';
-import { createReducer } from 'state/utils';
 
 /**
  * Returns the updated items state after an action has been dispatched.

client/state/country-states/reducer.js

@@ -7,9 +7,8 @@ import {
 	COUNTRY_STATES_REQUEST_FAILURE,
 	COUNTRY_STATES_REQUEST_SUCCESS,
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import { itemSchema } from './schema';
-import { createReducer } from 'state/utils';
 
 // Stores the complete list of states, indexed by locale key
 export const items = createReducer( {}, {

client/state/current-user/email-verification/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	EMAIL_VERIFY_REQUEST,
 	EMAIL_VERIFY_REQUEST_SUCCESS,

client/state/current-user/gravatar-status/reducer.js

@@ -7,8 +7,7 @@ import {
 	GRAVATAR_UPLOAD_REQUEST_SUCCESS,
 	GRAVATAR_UPLOAD_REQUEST_FAILURE
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 export const isUploading = createReducer( false, {
 	[ GRAVATAR_UPLOAD_REQUEST ]: () => true,

client/state/current-user/reducer.js

@@ -15,8 +15,7 @@ import {
 	SITES_UPDATE,
 	PLANS_RECEIVE
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import { idSchema, capabilitiesSchema, currencyCodeSchema, flagsSchema } from './schema';
 import gravatarStatus from './gravatar-status/reducer';
 import emailVerification from './email-verification/reducer';

client/state/document-head/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	DOCUMENT_HEAD_LINK_SET,
 	DOCUMENT_HEAD_META_SET,

client/state/geo/reducer.js

@@ -7,8 +7,7 @@ import {
 	GEO_REQUEST_FAILURE,
 	GEO_REQUEST_SUCCESS
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import { geoSchema } from './schema';
 
 /**

client/state/happiness-engineers/reducer.js

@@ -6,8 +6,8 @@ import { map } from 'lodash';
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import { itemsSchema } from './schema';
 import {
 	HAPPINESS_ENGINEERS_FETCH,

client/state/happychat/reducer.js

@@ -32,12 +32,11 @@ import {
 	HAPPYCHAT_TRANSCRIPT_RECEIVE,
 	HAPPYCHAT_SET_GEO_LOCATION,
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer, isValidStateWithSchema } from 'state/utils';
 import {
 	HAPPYCHAT_CHAT_STATUS_DEFAULT,
 } from './selectors';
 import { HAPPYCHAT_MAX_STORED_MESSAGES } from './constants';
-import { createReducer, isValidStateWithSchema } from 'state/utils';
 import { timelineSchema, geoLocationSchema } from './schema';
 
 /**

client/state/help/courses/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	HELP_COURSES_RECEIVE,
 } from 'state/action-types';

client/state/help/directly/reducer.js

@@ -1,8 +1,8 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
+
 import {
 	DIRECTLY_INITIALIZATION_START,
 	DIRECTLY_INITIALIZATION_SUCCESS,

client/state/help/ticket/reducer.js

@@ -1,8 +1,7 @@
 /**
  * Internal dependencies
  */
-import { createReducer } from 'state/utils';
-import { combineReducersWithPersistence } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 import {
 	HELP_TICKET_CONFIGURATION_REQUEST,

client/state/jetpack-connect/reducer.js

@@ -33,8 +33,7 @@ import {
 	SERIALIZE,
 	DESERIALIZE
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { isValidStateWithSchema } from 'state/utils';
+import { combineReducersWithPersistence, isValidStateWithSchema } from 'state/utils';
 import {
 	jetpackConnectSessionsSchema,
 	jetpackAuthAttemptsSchema,

client/state/jetpack/connection/reducer.js

@@ -10,8 +10,7 @@ import {
 	JETPACK_DISCONNECT_REQUEST_FAILURE,
 	JETPACK_DISCONNECT_REQUEST_SUCCESS,
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 const createRequestReducer = ( requesting ) => {
 	return ( state, { siteId } ) => ( {

client/state/jetpack/jumpstart/reducer.js

@@ -18,8 +18,7 @@ import {
 	JETPACK_JUMPSTART_STATUS_REQUEST_SUCCESS,
 	JETPACK_JUMPSTART_STATUS_REQUEST_FAILURE
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 const createRequestReducer = ( data ) => {
 	return ( state, { siteId } ) => {

client/state/jetpack/modules/reducer.js

@@ -20,8 +20,7 @@ import {
 	JETPACK_SETTINGS_RECEIVE,
 	JETPACK_SETTINGS_UPDATE_SUCCESS,
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 
 const createItemsReducer = ( active ) => {
 	return ( state, { siteId, moduleSlug } ) => {

client/state/jetpack/settings/reducer.js

@@ -21,8 +21,7 @@ import {
 	JETPACK_SETTINGS_UPDATE_SUCCESS,
 	JETPACK_SETTINGS_UPDATE_FAILURE
 } from 'state/action-types';
-import { combineReducersWithPersistence } from 'state/utils';
-import { createReducer } from 'state/utils';
+import { combineReducersWithPersistence, createReducer } from 'state/utils';
 import { normalizeSettings } from './utils';
 
 const createRequestsReducer = ( data ) => {