Eslint plugin: Add suggestions to "data-no-store-string-literals" rule

packages/eslint-plugin/rules/__tests__/data-no-store-string-literals.js

@@ -57,6 +57,85 @@ const invalid = [
 	`import { controls } from '@wordpress/data'; controls.dispatch( 'core' );`,
 	`import { controls } from '@wordpress/data'; controls.resolveSelect( 'core' );`,
 	`import { controls as controlsAlias } from '@wordpress/data'; controlsAlias.resolveSelect( 'core' );`,
+
+	// Direct function calls suggestions
+	{
+		// Replace core with coreStore and import coreStore
+		code: `import { select } from '@wordpress/data'; select( 'core' );`,
+		errors: [
+			{
+				suggestions: [
+					{
+						desc:
+							'Replace literal with store definition. Import store if neccessary.',
+						output: `import { select } from '@wordpress/data';\nimport { store as coreStore } from '@wordpress/core-data'; select( coreStore );`,
+					},
+				],
+			},
+		],
+	},
+	{
+		// Replace core with coreStore. A @wordpress/core-data already exists, so it should append the import to that one.
+		code: `import { select } from '@wordpress/data'; import { something } from '@wordpress/core-data'; select( 'core' );`,
+		errors: [
+			{
+				suggestions: [
+					{
+						desc:
+							'Replace literal with store definition. Import store if neccessary.',
+						output: `import { select } from '@wordpress/data'; import { something,store as coreStore } from '@wordpress/core-data'; select( coreStore );`,
+					},
+				],
+			},
+		],
+	},
+	{
+		// Replace core with coreStore. A @wordpress/core-data already exists, so it should append the import to that one.
+		// This time there is a comma after the import.
+		code: `import { select } from '@wordpress/data'; import { something, } from '@wordpress/core-data'; select( 'core' );`,
+		errors: [
+			{
+				suggestions: [
+					{
+						desc:
+							'Replace literal with store definition. Import store if neccessary.',
+						output: `import { select } from '@wordpress/data'; import { something,store as coreStore, } from '@wordpress/core-data'; select( coreStore );`,
+					},
+				],
+			},
+		],
+	},
+	{
+		// Replace core with coreStore. Store import already exists. It shouldn't modify the import, just replace the literal with the store definition.
+		code: `import { select } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; select( 'core' );`,
+		errors: [
+			{
+				suggestions: [
+					{
+						desc:
+							'Replace literal with store definition. Import store if neccessary.',
+						output: `import { select } from '@wordpress/data'; import { store as coreStore } from '@wordpress/core-data'; select( coreStore );`,
+					},
+				],
+			},
+		],
+	},
+	{
+		// Replace core with coreStore. There are internal and WordPress dependencies.
+		// It should append the import after the last WordPress dependency import.
+		code: `import { a } from './a'; import { select } from '@wordpress/data'; import { b } from './b'; select( 'core' );`,
+		errors: [
+			{
+				suggestions: [
+					{
+						desc:
+							'Replace literal with store definition. Import store if neccessary.',
+						output: `import { a } from './a'; import { select } from '@wordpress/data';\nimport { store as coreStore } from '@wordpress/core-data'; import { b } from './b'; select( coreStore );`,
+					},
+				],
+			},
+		],
+	},
 ];
 const errors = [
 	{
@@ -66,5 +145,7 @@ const errors = [
 
 ruleTester.run( 'data-no-store-string-literals', rule, {
 	valid: valid.map( ( code ) => ( { code } ) ),
-	invalid: invalid.map( ( code ) => ( { code, errors } ) ),
+	invalid: invalid.map( ( code ) =>
+		typeof code === 'string' ? { code, errors } : code
+	),
 } );

packages/eslint-plugin/rules/data-no-store-string-literals.js

@@ -1,3 +1,7 @@
+function arrayLast( array ) {
+	return array[ array.length - 1 ];
+}
+
 function getReferences( context, specifiers ) {
 	const variables = specifiers.reduce(
 		( acc, specifier ) =>
@@ -85,6 +89,123 @@ function collectAllNodesFromObjectPropertyFunctionCalls( context, node ) {
 	return possibleCallExpressionNodes;
 }
 
+function getSuggest( context, callNode ) {
+	return [
+		{
+			desc:
+				'Replace literal with store definition. Import store if neccessary.',
+			fix: ( fixer ) => getFixes( fixer, context, callNode ),
+		},
+	];
+}
+
+function getFixes( fixer, context, callNode ) {
+	const storeName = callNode.arguments[ 0 ].value;
+	const storeDefinitions = {
+		core: {
+			import: '@wordpress/core-data',
+			variable: 'coreStore',
+		},
+		'core/block-editor': {
+			import: '@wordpress/block-editor',
+			variable: 'blockEditorStore',
+		},
+		'core/block-directory': {
+			import: '@wordpress/block-directory',
+			variable: 'blockDirectoryStore',
+		},
+		'core/blocks': {
+			import: '@wordpress/blocks',
+			variable: 'blocksStore',
+		},
+		'core/editor': {
+			import: '@wordpress/editor',
+			variable: 'editorStore',
+		},
+		'core/notices': {
+			import: '@wordpress/notices',
+			variable: 'noticesStore',
+		},
+		'core/reusable-blocks': {
+			import: '@wordpress/reusable-blocks',
+			variable: 'reusableBlocksStore',
+		},
+		'core/keyboard-shortcuts': {
+			import: '@wordpress/keyboard-shortcuts',
+			variable: 'keyboardShortcutsStore',
+		},
+		'core/edit-post': {
+			import: '@wordpress/edit-post',
+			variable: 'editPostStore',
+		},
+		'core/edit-site': {
+			import: '@wordpress/edit-site',
+			variable: 'editSiteStore',
+		},
+		'core/interface': {
+			import: '@wordpress/interface',
+			variable: 'interfaceStore',
+		},
+		'core/viewport': {
+			import: '@wordpress/viewport',
+			variable: 'viewportStore',
+		},
+		'core/rich-text': {
+			import: '@wordpress/rich-text',
+			variable: 'richTextStore',
+		},
+	};
+	if ( ! storeDefinitions[ storeName ] ) {
+		return null;
+	}
+	const { variable: variableName, import: importName } = storeDefinitions[
+		storeName
+	];
+
+	const fixes = [
+		fixer.replaceText( callNode.arguments[ 0 ], variableName ),
+	];
+
+	const imports = context
+		.getAncestors()[ 0 ]
+		.body.filter( ( n ) => n.type === 'ImportDeclaration' );
+	const packageImports = imports.filter(
+		( n ) => n.source.value === importName
+	);
+	const i = packageImports.length > 0 ? packageImports[ 0 ] : null;
+	if ( i ) {
+		const alreadyHasStore = i.specifiers.some(
+			( s ) => s.imported.name === 'store'
+		);
+		if ( ! alreadyHasStore ) {
+			const lastSpecifier = arrayLast( i.specifiers );
+			fixes.push(
+				fixer.insertTextAfter(
+					lastSpecifier,
+					`,store as ${ variableName }`
+				)
+			);
+		}
+	} else {
+		const wpImports = imports.filter( ( n ) =>
+			n.source.value.startsWith( '@wordpress/' )
+		);
+		const lastImport =
+			wpImports.length > 0
+				? arrayLast( wpImports )
+				: arrayLast( imports );
+
+		fixes.push(
+			fixer.insertTextAfter(
+				lastImport,
+				`\nimport { store as ${ variableName } } from '${ importName }';`
+			)
+		);
+	}
+
+	return fixes;
+}
+
 module.exports = {
 	meta: {
 		type: 'problem',
@@ -131,6 +252,7 @@ module.exports = {
 							node: callNode.parent,
 							messageId: 'doNotUseStringLiteral',
 							data: { argument: callNode.arguments[ 0 ].value },
+							suggest: getSuggest( context, callNode ),
 						} );
 					} );
 			},