@mindfiredigital/eslint-plugin-hub/lib/utils/check-eslint-config.js

eslint-plugin-hub is a powerful, flexible ESLint plugin that provides a curated set of rules to enhance code readability, maintainability, and prevent common errors. Whether you're working with vanilla JavaScript, TypeScript, React, or Angular, eslint-plu

const fs = require('fs');
const path = require('path');
const { execSync } = require('child_process');
const readline = require('readline');

// List of possible ESLint config files
const eslintConfigFiles = [
  '.eslintrc.js',
  'eslint.config.js',
  'eslint.config.mjs',
  '.eslintrc.json',
  '.eslintrc.yaml',
  '.eslintrc.yml',
];

// Function to find the project root (where package.json is located)
function findProjectRoot(startDir) {
  let currentDir = startDir;
  while (currentDir !== path.parse(currentDir).root) {
    if (fs.existsSync(path.join(currentDir, 'package.json'))) {
      return currentDir;
    }
    currentDir = path.dirname(currentDir);
  }
  return null;
}

const projectDir = findProjectRoot(process.cwd()) || process.cwd();

// Check if any ESLint configuration file exists
const hasEslintConfig = eslintConfigFiles.some(configFile =>
  fs.existsSync(path.join(projectDir, configFile))
);

if (!hasEslintConfig) {
  console.log(`
    WARNING: No ESLint configuration found in your project.
  `);

  // Set up readline for user input
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
  });

  rl.question(
    'Would you like to automatically install ESLint and set up configuration? (y/n): ',
    userResponse => {
      const response = userResponse.toLowerCase();

      if (response === 'y') {
        try {
          // Change to project directory before running commands
          process.chdir(projectDir);

          // Run ESLint configuration setup using npm init @eslint/config@latest
          console.log('Setting up basic ESLint configuration...');
          execSync('npm init @eslint/config@latest', { stdio: 'inherit' });

          console.log(`
            ESLint has been successfully installed and configured!
          
            To customize your setup further, check the eslint.config* file created in your project.
            Don't forget to add "@mindfiredigital/eslint-plugin-hub" to the ESLint configuration file under "plugins".
          
            For more details, visit the npm package page or the official documentation.
          `);
        } catch (error) {
          console.error(
            'An error occurred during the installation or setup process:',
            error.message
          );
        }
      } else {
        console.log(
          'Skipping ESLint setup. Please make sure to configure it manually.'
        );
      }

      rl.close(); // Close the readline interface after the response
    }
  );
} else {
  console.log('ESLint configuration found in your project.');
}