Skip to content

Update dependency @eslint/compat to v2 #6116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −9
Open

Update dependency @eslint/compat to v2 #6116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"@changesets/cli": "^2.26.0",
"@changesets/pre": "^2.0.0",
"@changesets/read": "^0.6.0",
"@eslint/compat": "^1.2.1",
"@eslint/compat": "^2.0.0",
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify Node.js version compatibility with @eslint/compat v2.0.0.

@eslint/compat v2.0.0 requires Node.js v20.19.0 or later, a significant increase from v1.x. Confirm that the project's CI/CD pipelines and local development environments support Node.js 20.19.0+ (or 22.13.0+, or >=24). This is a breaking change that could prevent linting on machines running older Node.js versions.

Run the following script to verify Node.js version constraints are properly configured:

🏁 Script executed:

#!/bin/bash
# Description: Check current Node.js version constraints in the repository

echo "=== Checking engines field in package.json ==="
jq '.engines // "No engines field found"' package.json

echo -e "\n=== Checking .nvmrc file ==="
if [ -f .nvmrc ]; then
  cat .nvmrc
else
  echo "No .nvmrc file found"
fi

echo -e "\n=== Checking .node-version file ==="
if [ -f .node-version ]; then
  cat .node-version
else
  echo "No .node-version file found"
fi

echo -e "\n=== Checking GitHub Actions workflows for Node.js version constraints ==="
find .github/workflows -type f \( -name "*.yml" -o -name "*.yaml" \) 2>/dev/null | while read file; do
  if grep -q "node-version\|setup-node" "$file"; then
    echo "Found in $file:"
    grep -A 2 "node-version\|setup-node" "$file" | head -10
  fi
done || echo "No Node.js version constraints found in workflows"

Length of output: 262

Add Node.js version constraint to package.json to enforce @eslint/compat v2.0.0 compatibility.

The upgrade from @eslint/compat v1.2.1 to v2.0.0 introduces a breaking change with stricter Node.js requirements. However, the repository lacks any explicit Node.js version constraints in package.json (no engines field), version management files (.nvmrc, .node-version), or CI workflow specifications. This means developers and CI systems cannot detect the new Node.js requirement, risking silent failures during linting.

Add an engines field to package.json to explicitly declare the minimum Node.js version required:

"engines": {
  "node": "^20.19.0 || ^22.13.0 || >=24"
}

Also verify that GitHub Actions workflows are configured to use compatible Node.js versions or will inherit them correctly.

🤖 Prompt for AI Agents 
In package.json around line 59, there is no Node.js engine constraint which is
required because @eslint/compat v2.0.0 has stricter Node requirements; add an
"engines" field to package.json with the node constraint "node": "^20.19.0 ||
^22.13.0 || >=24" (or equivalent semver range) so package managers and tools can
detect the minimum Node version, and also add/update a .nvmrc or .node-version
file and/or ensure GitHub Actions workflows set compatible Node versions (20.19,
22.13, or >=24) to keep local and CI environments consistent.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

Verify Node.js version compatibility with @eslint/compat v2.0.0.

@eslint/compat v2.0.0 requires Node.js v20.19.0 or later, compared to its v1.x versions. This is a breaking change that may impact CI/CD pipelines and local development if the project currently supports Node.js versions below 20.19.0 or 22.13.0.

Ensure the project's Node.js version constraints are updated accordingly.

Run the following script to check the project's current Node.js version constraints:

🏁 Script executed:

#!/bin/bash
# Description: Check for Node.js version constraints in the repository

# Check if package.json has an engines field
echo "=== Checking engines field in package.json ==="
jq '.engines // "No engines field found"' package.json

# Check for .nvmrc file
echo -e "\n=== Checking .nvmrc file ==="
if [ -f .nvmrc ]; then
  cat .nvmrc
else
  echo "No .nvmrc file found"
fi

# Check for .node-version file
echo -e "\n=== Checking .node-version file ==="
if [ -f .node-version ]; then
  cat .node-version
else
  echo "No .node-version file found"
fi

# Search for GitHub Actions workflows that specify Node.js version
echo -e "\n=== Checking GitHub Actions workflows for Node.js version ==="
find .github/workflows -name "*.yml" -o -name "*.yaml" 2>/dev/null | xargs grep -h "node-version\|uses.*setup-node" 2>/dev/null || echo "No GitHub Actions workflows found or no Node.js version specified"

Length of output: 316


---

🏁 Script executed:

```shell
#!/bin/bash
# Description: More thorough check for CI configurations and version constraints

# Check if .github/workflows directory exists and list contents
echo "=== Checking .github directory structure ==="
if [ -d .github ]; then
  find .github -type f \( -name "*.yml" -o -name "*.yaml" -o -name "*.json" \) | head -20
else
  echo ".github directory does not exist"
fi

# Check for other CI configuration files
echo -e "\n=== Checking for other CI configuration files ==="
for file in .travis.yml .circleci/config.yml Jenkinsfile azure-pipelines.yml .gitlab-ci.yml; do
  if [ -f "$file" ]; then
    echo "Found: $file"
  fi
done
echo "Done"

# Display the full package.json to see context
echo -e "\n=== Checking package.json for engines and eslint-related entries ==="
jq '.engines, .devDependencies | select(. != null)' package.json 2>/dev/null || cat package.json | grep -A5 -B5 "eslint\|engines" | head -30

Length of output: 1907

🏁 Script executed:

#!/bin/bash
# Description: Check documentation for Node.js requirements

echo "=== Checking README for Node.js requirements ==="
if [ -f README.md ]; then
  grep -i "node\|version\|requirement" README.md | head -10 || echo "No Node.js version info found in README"
else
  echo "No README.md found"
fi

echo -e "\n=== Checking for CHANGELOG or similar docs ==="
find . -maxdepth 1 -type f \( -name "CHANGELOG*" -o -name "HISTORY*" -o -name "RELEASES*" \) 2>/dev/null | head -5

Length of output: 1726


---

🏁 Script executed:

```shell
#!/bin/bash
# Description: Check GitHub workflow files for Node.js version specifications

echo "=== Checking workflow files for Node.js version ==="
for workflow in .github/workflows/*.yml; do
  if [ -f "$workflow" ]; then
    echo "--- $workflow ---"
    grep -E "node-version|setup-node|uses:.*node" "$workflow" | head -5
  fi
done

echo -e "\n=== Checking .github/actions/setup/action.yml for Node.js setup ==="
if [ -f .github/actions/setup/action.yml ]; then
  cat .github/actions/setup/action.yml
fi

Length of output: 944

🏁 Script executed:

#!/bin/bash
# Description: Check CHANGELOG for Node.js version policy

echo "=== Checking CHANGELOG for Node.js version requirements ==="
grep -i "node" CHANGELOG.md | head -15 || echo "No Node.js info in CHANGELOG"

echo -e "\n=== Checking if PR diff mentions engines field ==="
# This would check if engines was added, but we need context from user
echo "Note: Need to verify if this PR intended to add engines field"

Length of output: 345

Add engines field to enforce Node.js version requirement for @eslint/compat v2.0.0.

CI is correctly configured with Node.js 24.x. However, @eslint/compat v2.0.0 requires Node.js ^20.19.0 || ^22.13.0 || >=24, and package.json lacks an engines field to enforce this requirement for local development and package installation. This could allow installation on incompatible Node versions, causing runtime failures.

Add to package.json:

"engines": {
  "node": "^20.19.0 || ^22.13.0 || >=24"
}
🤖 Prompt for AI Agents 
In package.json around line 59, add an "engines" field to enforce the Node.js
versions required by @eslint/compat v2.0.0; update package.json to include an
"engines" object specifying node: ^20.19.0 || ^22.13.0 || >=24 so local installs
and development will be blocked or warned on incompatible Node versions.

"@nomicfoundation/hardhat-chai-matchers": "^2.0.6",
"@nomicfoundation/hardhat-ethers": "^3.0.9",
"@nomicfoundation/hardhat-network-helpers": "^1.0.13",
Expand Down