neatlint 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 StablDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# neatlint
+
+A command-line interface (CLI) tool designed to automatically and seamlessly set up and configure ESLint and Prettier for modern JavaScript and TypeScript projects.
+
+## Overview
+
+Configuring linting and formatting tools for new or existing projects can be tedious and prone to configuration conflicts. `neatlint` automates the entire setup process. It detects your package manager, initializes ESLint, installs Prettier, writes default configurations, patches configuration files to avoid rule conflicts, and adds execution scripts to your `package.json`.
+
+## Requirements
+
+- Node.js version `^20.19.0`, `^22.13.0`, or `>=24`.
+
+## Installation and Usage
+
+To set up ESLint and Prettier in your project directory, run:
+
+```bash
+npx neatlint init
+```
+
+Alternatively, if you are using specific package managers, you can use:
+
+```bash
+# Using bun
+bunx neatlint init
+# Using pnpm
+pnpm dlx neatlint init
+# Using yarn
+yarn dlx neatlint init
+```
+
+## What neatlint Does
+
+### 1. Runs ESLint Initialization
+It invokes the interactive ESLint initialization tool appropriate for your package manager to guide you through creating an ESLint configuration.
+
+### 2. Installs Dependencies
+It installs the following packages as development dependencies:
+- `prettier`
+- `eslint-config-prettier`
+
+### 3. Generates `.prettierrc`
+Creates a `.prettierrc` file with the following default configuration:
+```json
+{
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "es5"
+}
+```
+
+### 4. Patches ESLint Flat Config
+Locates your ESLint configuration file (`eslint.config.js`, `eslint.config.mjs`, `eslint.config.ts`, or `eslint.config.mts`) and integrates `eslint-config-prettier` by importing and appending it to the export array, preventing formatting conflicts.
+
+### 5. Configures `package.json` Scripts
+Appends the following scripts to your `package.json` (skipping any script name that already exists):
+- `"lint": "eslint ."` - Lints the workspace.
+- `"format": "prettier . --write"` - Formats all files.
+- `"format:check": "prettier . --check"` - Checks file formatting.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

package/dist/cli.js

@@ -0,0 +1,229 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import cac from "cac";
+import pc6 from "picocolors";
+
+// src/package-manager.ts
+function detectPackageManager() {
+  const userAgent = process.env.npm_config_user_agent;
+  if (userAgent) {
+    if (userAgent.startsWith("pnpm")) return "pnpm";
+    if (userAgent.startsWith("yarn")) return "yarn";
+    if (userAgent.startsWith("bun")) return "bun";
+    if (userAgent.startsWith("npm")) return "npm";
+  }
+  return "npm";
+}
+
+// src/eslint-init.ts
+import { execa } from "execa";
+import pc from "picocolors";
+async function runEslintInit(pm, cwd) {
+  let command;
+  let args;
+  switch (pm) {
+    case "npm":
+      command = "npm";
+      args = ["init", "@eslint/config@latest"];
+      break;
+    case "pnpm":
+      command = "pnpm";
+      args = ["create", "@eslint/config@latest"];
+      break;
+    case "yarn":
+      command = "yarn";
+      args = ["create", "@eslint/config"];
+      break;
+    case "bun":
+      command = "bunx";
+      args = ["@eslint/create-config@latest"];
+      break;
+  }
+  console.log(pc.cyan("Running ESLint initializer..."));
+  await execa(command, args, {
+    cwd,
+    stdio: "inherit"
+  });
+}
+
+// src/install.ts
+import { execa as execa2 } from "execa";
+import pc2 from "picocolors";
+async function installPrettier(pm, cwd) {
+  let command;
+  let args;
+  const deps = ["prettier", "eslint-config-prettier"];
+  switch (pm) {
+    case "npm":
+      command = "npm";
+      args = ["install", "-D", ...deps];
+      break;
+    case "pnpm":
+      command = "pnpm";
+      args = ["add", "-D", ...deps];
+      break;
+    case "yarn":
+      command = "yarn";
+      args = ["add", "-D", ...deps];
+      break;
+    case "bun":
+      command = "bun";
+      args = ["add", "-d", ...deps];
+      break;
+  }
+  console.log(pc2.cyan("Installing Prettier..."));
+  await execa2(command, args, {
+    cwd,
+    stdio: "inherit"
+  });
+}
+
+// src/prettier.ts
+import fs from "fs/promises";
+import path from "path";
+import pc3 from "picocolors";
+async function createPrettierRc(cwd) {
+  const prettierrcPath = path.join(cwd, ".prettierrc");
+  const content = {
+    semi: true,
+    singleQuote: false,
+    trailingComma: "es5"
+  };
+  console.log(pc3.cyan("Writing .prettierrc..."));
+  await fs.writeFile(prettierrcPath, JSON.stringify(content, null, 2) + "\n", "utf8");
+}
+
+// src/patch-eslint.ts
+import fs2 from "fs/promises";
+import path2 from "path";
+import pc4 from "picocolors";
+async function patchEslintConfig(cwd) {
+  console.log(pc4.cyan("Patching ESLint config..."));
+  const configFiles = [
+    "eslint.config.js",
+    "eslint.config.mjs",
+    "eslint.config.ts",
+    "eslint.config.mts"
+  ];
+  let configPath = null;
+  let content = "";
+  for (const file of configFiles) {
+    const fullPath = path2.join(cwd, file);
+    try {
+      content = await fs2.readFile(fullPath, "utf8");
+      configPath = fullPath;
+      break;
+    } catch {
+    }
+  }
+  const manualSnippet = `
+import eslintConfigPrettier from "eslint-config-prettier";
+
+export default [
+  // existing config
+  eslintConfigPrettier,
+];`;
+  if (!configPath) {
+    console.log(pc4.yellow("Warning: ESLint flat config file not found."));
+    console.log(pc4.yellow("Please add prettier manually:"));
+    console.log(pc4.white(manualSnippet));
+    return;
+  }
+  if (content.includes("eslint-config-prettier")) {
+    console.log(pc4.green("ESLint config already contains eslint-config-prettier."));
+    return;
+  }
+  const exportDefaultRegex = /export\s+default\s+(?:[\w.]+\s*\()?\s*\[/;
+  if (!exportDefaultRegex.test(content)) {
+    console.log(pc4.yellow(`Warning: Could not automatically patch ${path2.basename(configPath)}.`));
+    console.log(pc4.yellow("Please add prettier manually:"));
+    console.log(pc4.white(manualSnippet));
+    return;
+  }
+  const lastBracketIndex = content.lastIndexOf("]");
+  if (lastBracketIndex === -1) {
+    console.log(pc4.yellow(`Warning: Could not automatically patch ${path2.basename(configPath)}.`));
+    console.log(pc4.yellow("Please add prettier manually:"));
+    console.log(pc4.white(manualSnippet));
+    return;
+  }
+  const before = content.slice(0, lastBracketIndex);
+  const after = content.slice(lastBracketIndex);
+  const trimmedBeforeRight = before.trimEnd();
+  const needsComma = trimmedBeforeRight.length > 0 && !trimmedBeforeRight.endsWith(",") && !trimmedBeforeRight.endsWith("[");
+  const importStatement = `import eslintConfigPrettier from "eslint-config-prettier";
+`;
+  const injection = (needsComma ? "," : "") + "\n  eslintConfigPrettier,\n";
+  let newContent = trimmedBeforeRight + injection + after;
+  const importRegex = /import\s+[\s\S]*?from\s+['"][^'"]+['"];?|import\s+['"][^'"]+['"];?/g;
+  let lastImportIndex = 0;
+  let match;
+  while ((match = importRegex.exec(newContent)) !== null) {
+    lastImportIndex = match.index + match[0].length;
+  }
+  if (lastImportIndex > 0) {
+    const beforeImport = newContent.slice(0, lastImportIndex);
+    const afterImport = newContent.slice(lastImportIndex).trimStart();
+    newContent = beforeImport + "\n" + importStatement + "\n" + afterImport;
+  } else {
+    newContent = importStatement + "\n" + newContent.trimStart();
+  }
+  await fs2.writeFile(configPath, newContent, "utf8");
+  console.log(pc4.green(`Patched ${path2.basename(configPath)}.`));
+}
+
+// src/package-json.ts
+import fs3 from "fs/promises";
+import path3 from "path";
+import pc5 from "picocolors";
+async function updatePackageJsonScripts(cwd) {
+  console.log(pc5.cyan("Updating package.json..."));
+  const pkgPath = path3.join(cwd, "package.json");
+  let pkg;
+  try {
+    const content = await fs3.readFile(pkgPath, "utf8");
+    pkg = JSON.parse(content);
+  } catch (err) {
+    console.log(pc5.yellow("Warning: Could not read package.json"));
+    return;
+  }
+  if (!pkg.scripts) {
+    pkg.scripts = {};
+  }
+  const newScripts = {
+    "lint": "eslint .",
+    "format": "prettier . --write",
+    "format:check": "prettier . --check"
+  };
+  for (const [key, value] of Object.entries(newScripts)) {
+    if (pkg.scripts[key]) {
+      console.log(pc5.yellow(`Warning: Script "${key}" already exists. Skipping.`));
+    } else {
+      pkg.scripts[key] = value;
+    }
+  }
+  await fs3.writeFile(pkgPath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+}
+
+// src/cli.ts
+var cli = cac("neatlint");
+cli.command("init", "Set up ESLint and Prettier").action(async () => {
+  try {
+    const cwd = process.cwd();
+    const pm = detectPackageManager();
+    console.log(pc6.green(`Using package manager: ${pm}`));
+    await runEslintInit(pm, cwd);
+    await installPrettier(pm, cwd);
+    await createPrettierRc(cwd);
+    await patchEslintConfig(cwd);
+    await updatePackageJsonScripts(cwd);
+    console.log(pc6.green("Done."));
+  } catch (err) {
+    console.error(pc6.red("An error occurred:"));
+    console.error(err);
+    process.exit(1);
+  }
+});
+cli.help();
+cli.parse();

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "neatlint",
+  "version": "2.0.0",
+  "description": "CLI tool to automatically set up ESLint and Prettier for a project.",
+  "author": "StablDev <thestabldev@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stabldev/neatlint.git"
+  },
+  "homepage": "https://github.com/stabldev/neatlint#readme",
+  "bugs": "https://github.com/stabldev/neatlint/issues",
+  "publishConfig": {
+    "provenance": true
+  },
+  "type": "module",
+  "main": "./dist/cli.js",
+  "bin": {
+    "neatlint": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "^20.19.0 || ^22.13.0 || >=24"
+  },
+  "keywords": [
+    "eslint",
+    "prettier",
+    "linter",
+    "format",
+    "lint",
+    "code",
+    "style",
+    "quality",
+    "testing",
+    "typescript",
+    "javascript"
+  ],
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "^11.1.1",
+      "onFail": "download"
+    }
+  },
+  "dependencies": {
+    "cac": "^7.0.0",
+    "execa": "^9.6.1",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.7.0",
+    "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3"
+  },
+  "scripts": {
+    "dev": "tsx src/cli.ts",
+    "build": "tsup src/cli.ts --format esm --clean"
+  }
+}