ESLint Config Sylph - Vue (@sylphlab/eslint-config-sylph-vue)

This package provides the ESLint Flat Config rules specifically tailored for SylphLab Vue 3 projects (using TypeScript). It extends the foundational @sylphlab/eslint-config-sylph base configuration with specific rules recommended for Vue 3 development.

Core Philosophy & Design Principles

This configuration builds upon the base philosophy with a focus on robust Vue 3 development:

• Vue 3 Best Practices: Enforces rules from eslint-plugin-vue's recommended set (plugin:vue/vue3-recommended) to promote common patterns, prevent anti-patterns, and ensure consistency in Vue component definition, template syntax, and script setup usage.
• TypeScript Integration: Assumes usage of TypeScript within Vue components (<script setup lang="ts">) and leverages the base configuration's TypeScript rules.
• Parser Configuration: Utilizes vue-eslint-parser for parsing .vue files and @typescript-eslint/parser for the script blocks within them.
• Strictness & Consistency: Maintains the extreme strictness and focus on AI/human readability inherited from the base configuration, applying it to Vue-specific contexts.

Installation

Install this package and its peer dependencies. The easiest way is using install-peerdeps:

1# Using pnpm (recommended) - Installs this package, the base package, and all necessary plugins
2npx install-peerdeps --dev @sylphlab/eslint-config-sylph-vue -p pnpm
3
4# --- OR ---
5
6# Manual Installation (if needed):
7# 1. Install this package and the base package
8pnpm add -D @sylphlab/eslint-config-sylph-vue @sylphlab/eslint-config-sylph
9# 2. Install all peer dependencies listed in BOTH package.json files (vue's and base's)
10pnpm add -D eslint typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-import eslint-plugin-prettier eslint-plugin-unicorn eslint-plugin-vue vue-eslint-parser

(Ensure you have eslint and typescript installed in your project as well.)

Usage

Import and include the configuration array in your eslint.config.js or eslint.config.ts. This package exports a combined array that includes the base configuration automatically.

1// eslint.config.ts
2import sylphVueConfig from '@sylphlab/eslint-config-sylph-vue';
3// Optionally import base config if you need to layer rules specifically
4// import sylphBaseConfig from '@sylphlab/eslint-config-sylph';
5
6export default [
7  // Include the combined Vue config
8  ...sylphVueConfig,
9
10  // Your project-specific rules or overrides
11  {
12    files: ['**/*.vue'], // Target Vue files specifically if needed
13    languageOptions: {
14      parserOptions: {
15        project: './tsconfig.json', // Point to your project's tsconfig for script blocks
16      },
17    },
18    rules: {
19      // Example: Allow console logs
20      'no-console': 'warn',
21      // Example: Relax abbreviation rule for 'props'
22      'unicorn/prevent-abbreviations': ['error', { replacements: { props: false } }],
23      // Example: Override a Vue rule
24      'vue/no-v-html': 'off',
25    },
26  },
27  {
28    // Example: Ignoring specific files/folders from linting
29    ignores: ['**/dist/**', '**/node_modules/**'],
30  },
31];

See the main monorepo README for more details on the overall philosophy and available configurations.