Warn about missing ESLint plugins

src/lib/options.spec.ts

@@ -17,16 +17,18 @@ import { describe, expect, it, vi } from 'vitest';
 
 import { Environment, Framework, Language, Plugin } from '../types/shared';
 
+import * as logger from './logger';
 import {
   pickConfigOrDetect,
   hasDependency,
   detectLanguage,
   detectEnvironments,
   detectFrameworks,
   detectOpenSource,
+  detectPlugins,
+  warnAboutMissingPlugins,
   NODE_LIBRARIES,
   BROWSER_LIBRARIES,
-  detectPlugins,
 } from './options';
 
 const basePackageJson = {
@@ -36,6 +38,8 @@ const basePackageJson = {
   _id: 'id',
 };
 
+vi.mock('./logger.ts');
+
 describe('options', () => {
   describe('pickConfigOrDetect', () => {
     it('should return the config value when defined', () => {
@@ -235,4 +239,21 @@ describe('options', () => {
       expect(actual).toBe(false);
     });
   });
+
+  describe('warnAboutMissingPlugins', () => {
+    it('should log a warning if a framework is installed but not its corresponding ESLint plugin', () => {
+      const packageJson = {
+        ...basePackageJson,
+        license: 'MIT',
+        dependencies: { next: '^1.0.0' },
+      };
+
+      warnAboutMissingPlugins(packageJson);
+
+      expect(logger.warn).toHaveBeenCalledOnce();
+      expect(logger.warn).toHaveBeenCalledWith(
+        '"next" is installed but not the corresponding ESLint plugin. Please install "eslint-config-next".',
+      );
+    });
+  });
 });

src/lib/options.ts

@@ -23,6 +23,7 @@ import {
 } from '../types/shared';
 
 import { readPackageJson } from './files';
+import * as logger from './logger';
 
 // These lists are not exhaustive and should be expanded if necessary.
 export const NODE_LIBRARIES = [
@@ -34,10 +35,51 @@ export const NODE_LIBRARIES = [
 ];
 export const BROWSER_LIBRARIES = ['next', 'react', 'preact', 'svelte', 'vue'];
 
+const FRAMEWORK_PLUGINS = [
+  {
+    packages: ['next'],
+    plugin: 'eslint-config-next',
+  },
+  {
+    packages: ['@emotion/react', '@emotion/styled'],
+    plugin: 'eslint-config-next',
+  },
+  {
+    packages: ['@emotion/react', '@emotion/styled'],
+    plugin: '@emotion/eslint-plugin',
+  },
+  {
+    packages: ['jest'],
+    plugin: 'eslint-plugin-jest',
+  },
+  {
+    packages: [
+      '@testing-library/dom',
+      '@testing-library/jest-dom',
+      '@testing-library/react',
+    ],
+    plugin: 'eslint-plugin-testing-library',
+  },
+  {
+    packages: ['cypress'],
+    plugin: 'eslint-plugin-cypress',
+  },
+  {
+    packages: ['@playwright/test'],
+    plugin: 'eslint-plugin-playwright',
+  },
+  {
+    packages: ['storybook', '@storybook/react'],
+    plugin: 'eslint-plugin-storybook',
+  },
+];
+
 export function getOptions(): Required<Options> {
   const packageJson = readPackageJson();
   const config = (packageJson.foundry || {}) as Options;
 
+  warnAboutMissingPlugins(packageJson);
+
   const pick = pickConfigOrDetect(packageJson);
 
   return {
@@ -111,6 +153,20 @@ export function detectFrameworks(packageJson: PackageJson): Framework[] {
   return frameworks;
 }
 
+export function warnAboutMissingPlugins(packageJson: PackageJson): void {
+  FRAMEWORK_PLUGINS.forEach(({ packages, plugin }) => {
+    const installedPackage = packages.find((pkg) =>
+      hasDependency(packageJson, pkg),
+    );
+
+    if (installedPackage && !hasDependency(packageJson, plugin)) {
+      logger.warn(
+        `"${installedPackage}" is installed but not the corresponding ESLint plugin. Please install "${plugin}".`,
+      );
+    }
+  });
+}
+
 export function detectPlugins(packageJson: PackageJson): Plugin[] {
   const plugins: Plugin[] = [];