Update dependency @eslint/compat to v2 #6116
Conversation
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
WalkthroughThis pull request updates the Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (1)
package.json(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-04T09:13:21.278Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:3-3
Timestamp: 2025-09-04T09:13:21.278Z
Learning: In OpenZeppelin contracts, hardhat.config.js uses a sophisticated yargs-based configuration where the Solidity compiler version is set via argv.compiler (line 77) with a default of '0.8.27' defined in the yargs options (line 21), allowing flexible command-line overrides while maintaining a consistent default.
Applied to files:
package.json
📚 Learning: 2025-09-04T09:13:21.278Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:3-3
Timestamp: 2025-09-04T09:13:21.278Z
Learning: In OpenZeppelin contracts, hardhat.config.js uses yargs to configure the Solidity compiler version dynamically via command line arguments, with a default of '0.8.27' set on line 21 and the solidity configuration using argv.compile around lines 76-87, rather than hardcoded version strings.
Applied to files:
package.json
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
- GitHub Check: boostsecurity - boostsecurityio/scanner
- GitHub Check: Redirect rules - solidity-contracts
- GitHub Check: Header rules - solidity-contracts
- GitHub Check: Pages changed - solidity-contracts
- GitHub Check: tests-upgradeable
- GitHub Check: tests
- GitHub Check: tests-foundry
- GitHub Check: slither
- GitHub Check: coverage
- GitHub Check: halmos
| "@changesets/pre": "^2.0.0", | ||
| "@changesets/read": "^0.6.0", | ||
| "@eslint/compat": "^1.2.1", | ||
| "@eslint/compat": "^2.0.0", |
There was a problem hiding this comment.
🧩 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.
🧩 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 -5Length 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.
This PR contains the following updates:
^1.2.1->^2.0.0Release Notes
eslint/rewrite (@eslint/compat)
v2.0.0Compare Source
⚠ BREAKING CHANGES
Features
Dependencies
v1.4.1Compare Source
Dependencies
v1.4.0Compare Source
Features
Dependencies
v1.3.2Compare Source
Dependencies
v1.3.1Compare Source
Bug Fixes
@eslint/compateslint peerDependencies constraint (#215) (b96ec0c)Dependencies
v1.3.0Compare Source
Features
includeIgnoreFile(#211) (3e18175)Dependencies
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.