@volt.js/eslint

@volt.js/eslint-config

A carefully crafted ESLint and Prettier configuration preset for modern JavaScript and TypeScript projects. Enforce consistent code style and catch potential errors before they make it to production.

Features

• 🎯 Optimized for TypeScript and JavaScript
• ⚡ Works seamlessly with Prettier
• 🔧 Zero configuration needed
• 📦 Easy to extend and customize

Installation & Usage

React (with Next.js)

Install dependencies:

npm i -D eslint @volt.js/eslint-config

Inside .eslintrc.json:

{
  "extends": [
    "@volt.js/eslint-config/next",
    "next/core-web-vitals"
  ]
}

React (without Next.js)

Install dependencies:

npm i -D eslint @volt.js/eslint-config

Inside .eslintrc.json:

{
  "extends": "@volt.js/eslint-config/react"
}

Node.js

Install dependencies:

npm i -D eslint @volt.js/eslint-config

Inside .eslintrc.json:

{
  "extends": "@volt.js/eslint-config/node"
}

With Prettier

This config includes Prettier settings. Add a prettier.config.js to your project:

module.exports = require('@volt.js/eslint-config/prettier')

What's Included

This configuration includes settings for:

• ESLint recommended rules
• TypeScript ESLint rules
• React and JSX/TSX support
• Import/Export rules
• Prettier integration

Customization

You can override any rules by adding them to your ESLint config file:

{
  "extends": "@volt.js/eslint-config",
  "rules": {
    // Your custom rules here
  }
}

Contributing

• Fork the repository
• Create your feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add some amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

License

MIT License - see the LICENSE file for details

Support

• 📝 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

Made with ❤️ by Anderson da Campo