@hrcd/eslint-config

A comprehensive and opinionated ESLint Flat configuration, designed to deliver an optimal development experience with minimal setup.

✨ Features

• Primed for Vue & Nuxt - Optimized for Vue 3 and the Nuxt ecosystem with tailored rules
• Advanced TypeScript Support - Specific rules for TypeScript with type checking
• Multi-language - Supports JavaScript, TypeScript, Vue, JSON, YAML, Markdown and more
• PNPM Optimized - Special rules for projects using PNPM workspaces
• PNPM Catalog Support - Integration with the new PNPM Catalog feature for better dependency management
• Automatic Formatting - Auto-fix styling issues without relying on Prettier
• Highly Customizable - Opinionated but easily adjustable to your needs
• Respects .gitignore - Automatically ignores files listed in your .gitignore

📦 Installation

# ✨ Auto-detect
npx nypm install @hrcd/eslint-config

# npm
npm install @hrcd/eslint-config

# yarn
yarn add @hrcd/eslint-config

# pnpm
pnpm install @hrcd/eslint-config

# bun
bun install @hrcd/eslint-config

🚀 Usage

Create an eslint.config.js file at the root of your project:

import { createConfig } from "@hrcd/eslint-config"

export default createConfig()

Customization

The configuration is opinionated but flexible. You can customize it to match your project's needs:

import { createConfig } from "@hrcd/eslint-config"

export default createConfig({
  // Enable/disable features
  typescript: true, // TypeScript support
  vue: true,        // Vue support
  nuxt: true,       // Nuxt support

  // Define files to ignore
  ignores: [
    'dist',
    'node_modules',
    // Other patterns
  ]
})

🔍 PNPM Catalog Support

This ESLint config includes optimized rules for projects using PNPM Catalog, the new feature that helps manage and organize packages in PNPM workspaces. It ensures proper dependency declarations, prevents hoisting issues, and maintains catalog structure consistency.

🛠️ IDE Integration

VS Code

1. Install the ESLint extension
2. Add to your settings.json:

{
  "eslint.validate": [
    "javascript",
    "typescript",
    "vue",
    "html",
    "markdown",
    "json",
    "yaml"
  ],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

🛠️ Development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using bun install

Contributing

To start contributing, you can follow these steps:

1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, feat/123 or fix/456.
4. Make changes following the local development steps above.
5. Commit your changes following the Conventional Commits specification.
6. Run tests using pnpm run test.
7. Create a pull request following the Pull Request Template.
   • To be merged, the pull request must pass the tests/workflow and have at least one approval.
   • If your changes affect the documentation, make sure to update it.
   • If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !

Sponsors

Contributors

Published under the APACHE license. Made by @HugoRCD and community 💛

---

🤖 auto updated with automd (last updated: Thu Apr 03 2025)