eslint
Comprehensive ESLint agent for JavaScript/TypeScript code quality. Use when setting up ESLint, configuring linting rules, analyzing code for issues, fixing violations, or integrating ESLint into development workflows. Triggers on requests involving code quality, linting, static analysis, or ESLint configuration for JavaScript, TypeScript, React, or Node.js projects.
How do I install this agent skill?
npx skills add https://github.com/el-feo/ai-context --skill eslintIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides a comprehensive guide for ESLint integration and usage. It possesses a standard attack surface for indirect prompt injection, as the agent is tasked with analyzing and potentially modifying user-provided source code files which could contain malicious directives.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
7/7 files flagged
What does this agent skill do?
ESLint
Quick Start
Prerequisites
- Node.js (^18.18.0, ^20.9.0, or >=21.1.0) with SSL support
- Existing
package.jsonfile (runnpm initif needed)
Installation & Setup
Automated Setup (Recommended):
npm init @eslint/config@latest
This interactive setup will ask about your project and create an eslint.config.js file.
Manual Setup:
# Install ESLint packages
npm install --save-dev eslint@latest @eslint/js@latest
# Create configuration file
touch eslint.config.js
Basic Configuration
The new flat config format (ESLint 9.0+) uses eslint.config.js:
import { defineConfig } from "eslint/config";
import js from "@eslint/js";
export default defineConfig([
{
files: ["**/*.js"],
plugins: { js },
extends: ["js/recommended"],
rules: {
"no-unused-vars": "warn",
"no-undef": "warn"
}
}
]);
Running ESLint
# Lint a single file
npx eslint yourfile.js
# Lint a directory
npx eslint src/
# Lint with auto-fix
npx eslint src/ --fix
Core ESLint Tasks
1. Setting Up ESLint
For JavaScript Projects
npm init @eslint/config@latest
Select options:
- How would you like to use ESLint? → To check syntax, find problems, and enforce code style
- What type of modules? → JavaScript modules (import/export)
- Which framework? → None/React/Vue (as applicable)
- Does your project use TypeScript? → No
- Where does your code run? → Browser and/or Node
- Config file format → JavaScript/JSON/YAML (JavaScript recommended)
For TypeScript Projects
npm install --save-dev eslint@latest @typescript-eslint/parser @typescript-eslint/eslint-plugin typescript-eslint
Configuration for TypeScript:
import { defineConfig } from 'eslint/config';
import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';
export default defineConfig(
eslint.configs.recommended,
...tseslint.configs.recommended
);
For React + TypeScript
npm install --save-dev \
eslint \
@typescript-eslint/parser \
@typescript-eslint/eslint-plugin \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-jsx-a11y \
typescript-eslint
2. Configuring Rules
Rule Severity Levels
"off"or0- Disable the rule"warn"or1- Warning (doesn't affect exit code)"error"or2- Error (exit code will be 1)
Common Rule Configurations
Basic Rules:
export default defineConfig([
{
rules: {
// Enforce semicolons
"semi": ["error", "always"],
// Enforce const where possible
"prefer-const": "error",
// Warn on unused variables
"no-unused-vars": "warn",
// No console.log in production
"no-console": ["error", { allow: ["warn", "error"] }],
// Enforce consistent quotes
"quotes": ["error", "single"],
// Require === instead of ==
"eqeqeq": ["error", "always"]
}
}
]);
TypeScript-Specific Rules:
export default defineConfig([
{
files: ["**/*.ts", "**/*.tsx"],
rules: {
"@typescript-eslint/no-explicit-any": "warn",
"@typescript-eslint/explicit-function-return-type": ["error", {
allowExpressions: true
}],
"@typescript-eslint/naming-convention": ["error", {
selector: "interface",
format: ["PascalCase"],
custom: {
regex: "^I[A-Z]",
match: false
}
}]
}
}
]);
Configuration Comments
Disable rules inline:
/* eslint-disable no-console */
console.log('This is allowed');
/* eslint-enable no-console */
// Disable for single line
console.log('Debug'); // eslint-disable-line no-console
// Disable next line
// eslint-disable-next-line no-console
console.log('Debug');
// Disable specific rules
alert('foo'); // eslint-disable-line no-alert, no-undef
Best Practices for Inline Disables:
-
Use sparingly with clear justification
-
Document the reason:
// eslint-disable-next-line no-console -- Debugging production issue #1234 console.log('User data:', userData); -
Prefer configuration file changes over inline disables
-
Create follow-up tasks for temporary disables
3. File Patterns and Ignores
Specifying Files to Lint
export default defineConfig([
{
// Only lint TypeScript files in src/
files: ["src/**/*.ts", "src/**/*.tsx"],
// Ignore test files for certain rules
ignores: ["**/*.test.ts", "**/*.spec.ts"]
}
]);
Global Ignores
export default defineConfig([
{
ignores: [
"**/node_modules/**",
"**/dist/**",
"**/build/**",
"**/.next/**",
"**/coverage/**"
]
},
// ... rest of config
]);
4. Using Shared Configurations
ESLint supports extending from popular configurations:
import { defineConfig } from "eslint/config";
import js from "@eslint/js";
import globals from "globals";
export default defineConfig([
js.configs.recommended, // ESLint recommended rules
{
languageOptions: {
globals: {
...globals.browser,
...globals.node
}
}
}
]);
Popular Shared Configs:
eslint:recommended- ESLint's recommended rules@typescript-eslint/recommended- TypeScript recommended@typescript-eslint/strict- Stricter TypeScript rulesplugin:react/recommended- React best practicesplugin:react-hooks/recommended- React Hooks rules
5. Auto-Fixing Issues
ESLint can automatically fix many issues:
# Fix all auto-fixable issues
npx eslint src/ --fix
# Show what would be fixed (dry run)
npx eslint src/ --fix-dry-run
Auto-fixable rules include:
- Formatting issues (spacing, semicolons, quotes)
- Simple code transformations (prefer-const, arrow functions)
- Import sorting
Non-fixable issues require manual intervention:
- Logic errors (no-unused-vars with actual usage)
- Complex refactoring needs
Common Project Scenarios
React + TypeScript Project
Complete Configuration:
import { defineConfig } from 'eslint/config';
import js from '@eslint/js';
import globals from 'globals';
import reactHooks from 'eslint-plugin-react-hooks';
import reactRefresh from 'eslint-plugin-react-refresh';
import tseslint from 'typescript-eslint';
export default defineConfig([
{ ignores: ['dist'] },
js.configs.recommended,
...tseslint.configs.recommended,
{
files: ['**/*.{ts,tsx}'],
languageOptions: {
ecmaVersion: 2020,
globals: globals.browser,
parserOptions: {
project: './tsconfig.json'
}
},
plugins: {
'react-hooks': reactHooks,
'react-refresh': reactRefresh
},
rules: {
...reactHooks.configs.recommended.rules,
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true }
],
'@typescript-eslint/no-unused-vars': ['error', {
argsIgnorePattern: '^_',
varsIgnorePattern: '^_'
}]
}
}
]);
Node.js + TypeScript Project
import { defineConfig } from 'eslint/config';
import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';
import globals from 'globals';
export default defineConfig([
eslint.configs.recommended,
...tseslint.configs.recommended,
{
files: ['**/*.ts'],
languageOptions: {
globals: globals.node
},
rules: {
'@typescript-eslint/no-explicit-any': 'warn',
'no-console': 'off' // Console is fine in Node.js
}
}
]);
Monorepo Configuration
export default defineConfig([
// Global ignores
{ ignores: ['**/dist/**', '**/build/**'] },
// Frontend package
{
files: ['packages/frontend/**/*.{ts,tsx}'],
languageOptions: {
globals: globals.browser
},
// Frontend-specific rules
},
// Backend package
{
files: ['packages/backend/**/*.ts'],
languageOptions: {
globals: globals.node
},
// Backend-specific rules
}
]);
Integration
For VS Code setup, CI/CD (GitHub Actions), pre-commit hooks (Husky/lint-staged), and package.json scripts, see references/integration.md.
Troubleshooting
Common Issues
"Cannot find module 'eslint/config'"
- Update to ESLint 9.0+:
npm install eslint@latest
"Parsing error: Cannot find module '@typescript-eslint/parser'"
- Install parser:
npm install --save-dev @typescript-eslint/parser
Rules not being applied
- Check file patterns match your source files
- Verify config file is named correctly (
eslint.config.js) - Ensure config is in project root
Slow linting in large projects
- Add appropriate ignores for node_modules, dist, build folders
- Use
--cacheflag:npx eslint --cache . - Consider using
--max-warnings 0to fail on warnings in CI
Advanced Topics
Creating Custom Rules
For project-specific patterns, see references/custom_rules.md.
TypeScript Type-Aware Linting
For advanced TypeScript checks requiring type information, see references/type_aware_linting.md.
Rule Reference
For a comprehensive rule reference with examples, see references/rule_reference.md.
Migration from ESLint 8.x
For projects using the legacy .eslintrc.* format, see references/migration_guide.md.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/el-feo/ai-context/eslint">View eslint on skillZs</a>