feat: enhance project setup with ESLint integration and configuration

Author: talhabilal-dev

src/orchestrator.js

@@ -6,23 +6,28 @@ import { setupEnv } from "./tasks/setupEnv.js";
 import { addAuth } from "./tasks/addAuth.js";
 import { addMulter } from "./tasks/addMulter.js";
 import { configureScripts } from "./tasks/configureScripts.js";
-import { configurePackageJson } from './tasks/configurePackageJson.js';
+import { configurePackageJson } from "./tasks/configurePackageJson.js";
+import { setupESLintConfig } from "./tasks/setupESLint.js";
 
 export async function orchestrateSetup() {
   console.log("🚀 Welcome to create-node-backend!");
 
   const projectName = await askQuestion("Project name: ");
   const useAuth = await askQuestion("Include auth? (y/n): ");
   const useMulter = await askQuestion("Include Multer (file uploads)? (y/n): ");
+  const useLint = await askQuestion("Use ESLint? (y/n): ");
 
   await setupNpm(projectName);
-  await installDependencies(useAuth, useMulter);
+  await installDependencies(useAuth, useMulter, useLint);
   await setupFolderStructure(projectName);
   await setupEnv(projectName);
+
   if (useAuth.toLowerCase() === "y") await addAuth(projectName);
   if (useMulter.toLowerCase() === "y") await addMulter(projectName);
+
   await configureScripts(projectName);
   await configurePackageJson(projectName);
+  if (useLint.toLowerCase() === "y") await setupESLintConfig(projectName);
 
   console.log(`👉 Project "${projectName}" created!`);
   console.log(`👉 Run: cd ${projectName} && npm run dev`);

src/tasks/configurePackageJson.js

@@ -12,6 +12,8 @@ export async function configurePackageJson(projectName) {
   packageJson.scripts = {
     ...packageJson.scripts,
     dev: "nodemon src/index.js",
+    lint: "eslint .",
+    "lint:fix": "eslint . --fix",
   };
 
   // Write back to package.json

src/tasks/installDependencies.js

@@ -1,6 +1,6 @@
 import { execSync } from "child_process";
 
-export async function installDependencies(useAuth, useMulter) {
+export async function installDependencies(useAuth, useMulter, useLint) {
   console.log("📥 Installing core dependencies...");
   execSync("npm install express dotenv", { stdio: "inherit" });
 
@@ -14,6 +14,16 @@ export async function installDependencies(useAuth, useMulter) {
     execSync("npm install multer", { stdio: "inherit" });
   }
 
+  console.log("📦 Installing dev dependencies...");
+
+  execSync("npm install --save-dev nodemon", { stdio: "inherit" });
+  if (useLint.toLowerCase() === "y") {
+    console.log("🔍 Installing ESLint...");
+    execSync("npm install --save-dev eslint eslint-plugin-n eslint-plugin-promise", {
+      stdio: "inherit",
+    });
+  }
+
   console.log("⚙️ Installing dev dependencies...");
   execSync("npm install --save-dev nodemon", { stdio: "inherit" });
 }

src/tasks/setupESLint.js

@@ -0,0 +1,54 @@
+import fs from "fs";
+import path from "path";
+
+export async function setupESLintConfig() {
+  const eslintConfigContent = `
+import eslintPluginNode from 'eslint-plugin-n';
+import eslintPluginPromise from 'eslint-plugin-promise';
+
+/** @type {import("eslint").Linter.FlatConfig} */
+export default [
+  {
+    files: ["**/*.js"],
+    languageOptions: {
+      ecmaVersion: "latest",
+      sourceType: "module",
+    },
+    plugins: {
+      node: eslintPluginNode,
+      promise: eslintPluginPromise,
+    },
+    rules: {
+      // Best practices
+      "no-unused-vars": ["warn"],
+      "no-console": "off",
+      "eqeqeq": ["error", "always"],
+      "curly": ["error", "all"],
+
+      // Style
+      "indent": ["error", 2],
+      "quotes": ["error", "single"],
+      "semi": ["error", "always"],
+      "comma-dangle": ["error", "always-multiline"],
+
+      // Node.js-specific
+      "node/callback-return": "warn",
+      "node/handle-callback-err": "warn",
+      "node/no-mixed-requires": "warn",
+      "node/no-new-require": "warn",
+
+      // Promise-specific
+      "promise/always-return": "warn",
+      "promise/no-return-wrap": "warn",
+    },
+  },
+];
+  `;
+
+  fs.writeFileSync(
+    path.join(process.cwd(), "eslint.config.js"),
+    eslintConfigContent.trim()
+  );
+
+  console.log("✅ ESLint v9+ configuration (eslint.config.js) created!");
+}