@luanthnh/eslint-config

Shared ESLint and Prettier configurations for Next.js projects.

Installation

You can install this package using any package manager:

# npm
npm install -D @luanthnh/eslint-config

# pnpm
pnpm add -D @luanthnh/eslint-config

# yarn
yarn add -D @luanthnh/eslint-config

# bun
bun add -d @luanthnh/eslint-config

Usage

1. ESLint Configuration (eslint.config.mjs)

You can easily extend and override any rules from the base configuration.

import { baseEslintConfig } from '@luanthnh/eslint-config';

const config = [
  ...baseEslintConfig,
  {
    // Customization & Overrides
    rules: {
      'no-console': 'warn', // Allow console with warning instead of error
      'react/prop-types': 'error', // Force prop-types if needed
      '@typescript-eslint/no-explicit-any': 'off', // Allow 'any' type
    },
    // You can also adjust file patterns or ignore certain paths
    ignores: ['node_modules/', '.next/', 'public/'],
  },
];

export default config;

2. Prettier Configuration (prettier.config.js)

You can also customize Prettier settings while keeping most defaults.

import { basePrettierConfig } from '@luanthnh/eslint-config';

/** @type {import('prettier').Config} */
const config = {
  ...basePrettierConfig,
  // Overrides
  printWidth: 120, // Wider lines
  semi: false, // No semicolons
};

export default config;

Features

• Strict Rules: High standards for code quality and consistency.
• Auto-fixable: Most rules are designed to be fixed automatically on save.
• Kebab-case Enforcement: Ensures consistent file naming.
• Import Sorting: Automatically organizes and cleans up your imports.
• Tailwind CSS Support: Specialized sorting for Tailwind classes.