feat: Add npx CLI with Bun for instant linting

[jellydn]

What

Add a Bun-based TypeScript CLI that enables users to run this ESLint plugin via npx without installing it to their project.

Why

• Zero Installation: Developers can try the plugin instantly without modifying their package.json
• Quick Evaluation: Perfect for evaluating the plugin on existing codebases
• CI/CD Integration: Can be used in pipelines without adding dependencies
• Better DX: Reduces friction for first-time users and one-off checks
• Native TypeScript: Bun runs TypeScript natively without compilation step

How

Implementation

1. CLI Script (bin/lint-react-effects.ts):

   • TypeScript executed directly by Bun (no compilation needed)
   • Creates temporary directory with ESLint + plugin + TypeScript support
   • Generates minimal ESLint config (only React effect rules enabled)
   • Symlinks node_modules to user's directory for dependency resolution
   • Runs ESLint from user's current directory
   • Parses JSON output to filter only plugin-related warnings
   • Filters out "unknown rule" errors from existing eslint-disable comments
   • Auto-cleanup of temporary files and symlinks

2. Developer Experience:

   • Added bin entry in package.json pointing to TypeScript file
   • Makefile with targets: install, test-cli, check, help
   • Updated .gitignore for test files
   • Added "Quick Try" section to README

Usage

cd /path/to/your/project npx eslint-plugin-react-you-might-not-need-an-effect "src/**/*.jsx" npx eslint-plugin-react-you-might-not-need-an-effect --fix "src/**/*.{js,jsx,ts,tsx}"

Features

• ✅ Supports JavaScript (.js, .jsx) and TypeScript (.ts, .tsx)
• ✅ Only plugin rules enabled (no noise from other ESLint rules)
• ✅ Ignores unknown rule errors from eslint-disable comments
• ✅ Automatic setup and cleanup
• ✅ No installation required in target project
• ✅ Native TypeScript execution with Bun

Requirements

• Bun runtime installed
• Run from your project directory

Testing

Tested on real-world React projects with:

• Existing ESLint configurations
• Mixed JS/JSX/TS/TSX files
• Inline eslint-disable comments for various rules
• Glob patterns and individual files

Commands

# Test CLI locally make test-cli make install # Install globally for testing

---

🤖 Generated with Claude Code

[NickvanDyke]

This is a neat idea! However I'm not keen on the dependencies and maintenance it adds, and afaict it's not typical for ESLint plugins. It might make sense as a separate tool? That can transiently trial any ESLint plugin, not just this one 🙂