eslint-config-porcupine

Sharp opinions. Pointy rules. Touch at your own risk.

Porcupine is an opinionated ESLint configuration that rules with quiet authority — and a lot of spikes. It doesn't ask for your input; it already knows what's best. You're welcome to become a vassal state — just understand that you'll be governed by a monarchy, not a democracy. Your opinions will be heard, logged, and promptly ignored.

Porcupine assumes Prettier already disciplines your code's formatting, leaving it free to focus on what actually matters: readability, correctness, and the prevention of code crimes. It builds upon well-behaved defaults, assumes type awareness as law, and abolishes redundant rules that the type system already enforces. Its plugins sharpen the edges, catching the mistakes you swear you didn't make.

✨ Sacred Edicts

• Zero Formatting: Porcupine doesn't do fashion advice — that's Prettier's domain.
• Readability & Correctness: Porcupine enforces clarity, sanity, and a modicum of self-respect.
• Type Supremacy: Porcupine governs only in lands blessed with types — JSDoc or TypeScript.
• Sacred Orders: Porcupine delegates enforcement to a circle of trusted plugins.

🏰 Becoming a Vassal State

Swear fealty to the Porcupine and receive its spiny protection:

npm install --save-dev eslint eslint-config-porcupine

Once the pact is sealed, add the Porcupine's governance in your eslint.config.js:

import { porcupine } from "eslint-config-porcupine";
import { defineConfig } from "eslint/config";

export default defineConfig(porcupine());

Then inscribe these incantations into your package.json, so the Porcupine may evaluate your sins:

{
  "type": "module",
  "scripts": {
    "eslint": "eslint --max-warnings 0",
    "prettier": "prettier --check .",
    "test": "npm run prettier && npm run eslint"
  }
}

🧾 The Rite of Lintification

To test your worthiness before the Porcupine, utter the sacred words:

npm test

If no errors arise and the spikes stay sheathed, you have pleased the Porcupine.

💎 Petitions to the Porcupine

Porcupine accepts no decrees, proposals, or revolutions — its laws are immutable. Only reports of a genuine bug or plea for assistance in deciphering its will shall be entertained. All other offerings will be ceremoniously ignored while Porcupine resumes its quiet, judgmental watch.