Skip to content
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.

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

fix(linter): update the @nx/dependency-checks rule to read the package.json content from the rule context #27476

Merged
merged 2 commits into from
Aug 16, 2024

Conversation

leosvelperez
Copy link
Member

@leosvelperez leosvelperez commented Aug 16, 2024

Current Behavior

The @nx/dependency-checks rule sometimes doesn't apply all identified fixes and wrongly succeeds. ESLint performs multiple passes to try to apply fixes, and in each pass the rule receives the updated source code with the previously applied fixes. This allows merging different fixes, but the @nx/dependency-checks rule always reads the package.json file from the filesystem, caches it globally, and mutates it. It never uses the updated source code provided in the rule context.

Expected Behavior

The @nx/dependency-checks rule should apply all identified fixes as long as they don't conflict.

Related Issue(s)

Fixes #27412

@leosvelperez leosvelperez self-assigned this Aug 16, 2024
@leosvelperez leosvelperez requested a review from a team as a code owner August 16, 2024 12:27
Copy link

vercel bot commented Aug 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
nx-dev ⬜️ Ignored (Inspect) Visit Preview Aug 16, 2024 2:45pm

@leosvelperez leosvelperez enabled auto-merge (squash) August 16, 2024 14:59
@leosvelperez leosvelperez merged commit b699207 into master Aug 16, 2024
6 checks passed
@leosvelperez leosvelperez deleted the eslint/fix-dependency-check-rule branch August 16, 2024 15:14
FrozenPandaz pushed a commit that referenced this pull request Aug 19, 2024
…e.json content from the rule context (#27476)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

The `@nx/dependency-checks` rule sometimes doesn't apply all identified
fixes and wrongly succeeds. ESLint performs multiple passes to try to
apply fixes, and in each pass the rule receives the updated source code
with the previously applied fixes. This allows merging different fixes,
but the `@nx/dependency-checks` rule always reads the `package.json`
file from the filesystem, caches it globally, and mutates it. It never
uses the updated source code provided in the rule context.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

The `@nx/dependency-checks` rule should apply all identified fixes [as
long as they don't
conflict](https://eslint.org/docs/latest/extend/custom-rules#conflicting-fixes).

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #27412

(cherry picked from commit b699207)
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dependency-check lint rule, --fix needs to be run twice
2 participants