🧹 Hyper Fetch ESLint Plugin

ESLint rules to enforce HyperFetch best practices and catch type issues early.

📖 About

This ESLint plugin provides static analysis rules specific to HyperFetch. It catches generic type issues like typos, missing values, or incorrect usage of createClient and createRequest type parameters before they cause runtime errors.

🎯 Key Capabilities

• 🔮 Catch type bugs before they run — Validates createClient and createRequest generic parameters at lint time
• ✨ No more typo-induced any — Detects misspelled keys like rsponse instead of response
• 🔧 Plug and play — Use the recommended preset or configure rules one by one

🚀 Quick Start

npm install -D eslint-plugin-hyper-fetch

{
  "extends": ["plugin:hyper-fetch/recommended"]
}

Or configure individual rules:

{
  "plugins": ["hyper-fetch"],
  "rules": {
    "hyper-fetch/client-generic-types": "error",
    "hyper-fetch/request-generic-types": "error"
  }
}

📚 Documentation

• ESLint Plugin Docs
• Getting Started

💡 Examples

Catches incorrect generic types

// ❌ This will be flagged by hyper-fetch/request-generic-types
const getUser = client.createRequest<{
  rsponse: User; // Typo: "rsponse" instead of "response"
}>()({
  endpoint: "/users/:userId",
  method: "GET",
});

// ✅ Correct usage — no lint error
const getUser = client.createRequest<{
  response: User;
}>()({
  endpoint: "/users/:userId",
  method: "GET",
});

License

MIT