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

Feat: Determine if the project.json is for nuget or NX #5421

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jabaran
Copy link

@jabaran jabaran commented Aug 14, 2024

Reviewers:

There may be a better place to put a check like this where an additional read doesn't happen; however, this was the least impactful location I found to make this type of change. If it was done after the This should allow more use of --all-projects when repositories also have project.json file from using NX/js

In addition to the extra file read, this solution also creates an additional array targetFiles_temp to minimize overall code changes.

In general, if there is a preferred way to approach this instead, I'd be happy to hear that feedback.

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

The goal was to improve the experience when using --all-projects by skipping project.json files when they do not contain nuget package markers but do contain NX/js markers.

Where should the reviewer start?

How should this be manually tested?

Include a project.json file with the following content

{
  "root": "libs/mylib/",
  "targets": {
    "test": {
      "executor": "@nx/jest:jest",
      "options": {
        
      }
    },
    "build": {
      "executor": "@nx/js:tsc",
      "options": {
        
      }
    }
  }
}

Before change the result was:

[Path]project.json:
  No valid Dotnet target framework found

After change the file no longer complains about a missing target framework since it isn't a valid nuget file and has nx identifiers

Any background context you want to provide?

This was inquired about a year+ ago, approximately Jan 2023.

What are the relevant tickets?

Screenshots

Additional questions

The goal was to improve the experience when using `--all-projects`

There may be a better place to put a check like this where an additional read doesn't happen; however, this was the least impactful location I found to make this type of change. If it was done after the  This should allow more use of --all-projects when repositories also have `project.json` file from using [NX/js](https://nx.dev/)

In addition to the extra file read, this solution also creates an additional array `targetFiles_temp` to minimize overall code changes.

In general, if there is a preferred way to approach this instead, I'd be happy to hear that feedback.
@jabaran jabaran requested a review from a team as a code owner August 14, 2024 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant