gorgon-lint-cli
v1.0.1
Published
A Modern ESLint CLI tool for better code quality. This tool helps you quickly set up ESLint in your project with best practices and commonly used configurations.
Readme
Gorgon Lint CLI
A Modern ESLint CLI tool for better code quality. This tool helps you quickly set up ESLint in your project with best practices and commonly used configurations.
Features
- 🚀 Quick setup with interactive CLI
- ✨ Modern ESLint configuration
- 🔧 Support for:
- TypeScript
- React
- Prettier
- Tailwind CSS
- Accessibility (a11y)
- 📦 Zero config by default
- 🎨 Beautiful CLI interface
Usage
Simply run one of the following commands in your project directory:
# Using npm
npx gorgon-lint-cli
# Using pnpm
pnpm dlx gorgon-lint-cliThis will start an interactive setup process where you can choose which features to enable.
Configuration Options
During setup, you can enable/disable the following features:
- TypeScript: Add TypeScript support for better type safety
- React: Add React specific linting rules
- Prettier: Add code formatting rules
- Tailwind CSS: Add Tailwind CSS specific linting rules
- Accessibility: Add web accessibility rules (a11y)
Scripts Added to package.json
The setup will add the following npm scripts to your project:
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}Usage After Setup
After setup is complete, you can use the following commands:
# Check your code for issues
pnpm lint
# Automatically fix issues
pnpm lint:fixRequirements
- Node.js >= 16
- pnpm, npm, or yarn
License
MIT
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
