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

Add AnalyzerUtilities to NuGet package #326

Merged

Conversation

MattKotsenas
Copy link
Collaborator

@MattKotsenas MattKotsenas commented Jan 17, 2025

This fixes a regression caused by #290.

Microsoft.CodeAnalysis.AnalyzerUtilities is not one of the assemblies provided by the host (i.e. compiler), so we need to include it in our own package.

I'm not sure how to write an automated test for this. Our current tests don't use the NuGet package. Doing something like dotnet format in theory should work, but when I tried that it passed even without this change.

This does result in a new package contents baseline, so we can chalk this one up to reviewer error and revisit if we find a better solution.

@Copilot Copilot bot review requested due to automatic review settings January 17, 2025 21:39

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (2)
  • src/Analyzers/Moq.Analyzers.csproj: Language not supported
  • tests/Moq.Analyzers.Test/PackageTests.Baseline#contents.verified.txt: Language not supported
Copy link

coderabbitai bot commented Jan 17, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the Moq.Analyzers.csproj project file to improve packaging and dependency management for the Moq Analyzers project. Two key changes were made: adding a CopyLocalLockFileAssemblies property to ensure local lock file assemblies are copied, and including the Microsoft.CodeAnalysis.AnalyzerUtilities.dll as a packaged item in the correct analyzers path. This change enhances the distribution of the analyzer package by properly bundling its dependencies.

Changes

File Change Summary
src/Analyzers/Moq.Analyzers.csproj - Added <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> property
- Added <None> item to include Microsoft.CodeAnalysis.AnalyzerUtilities.dll in package
tests/Moq.Analyzers.Test/PackageTests.Baseline#contents.verified.txt - Added Microsoft.CodeAnalysis.AnalyzerUtilities.dll to analyzers/dotnet/cs directory

Possibly related PRs

Suggested Labels

dependencies, releasable, build

Suggested Reviewers

  • rjmurillo

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7577dd2 and 90137b5.

📒 Files selected for processing (2)
  • src/Analyzers/Moq.Analyzers.csproj (2 hunks)
  • tests/Moq.Analyzers.Test/PackageTests.Baseline#contents.verified.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: build (windows-latest)
🔇 Additional comments (3)
tests/Moq.Analyzers.Test/PackageTests.Baseline#contents.verified.txt (1)

7-7: LGTM! The baseline update correctly reflects the package structure.

The addition of Microsoft.CodeAnalysis.AnalyzerUtilities.dll to the analyzers/dotnet/cs directory maintains consistency with the existing analyzer DLLs placement.

src/Analyzers/Moq.Analyzers.csproj (2)

10-10: LGTM! Appropriate solution for dependency bundling.

The addition of CopyLocalLockFileAssemblies is well documented and necessary for compiler plugins to properly bundle their dependencies.


43-43: LGTM! Correctly configured package inclusion.

The inclusion of Microsoft.CodeAnalysis.AnalyzerUtilities.dll follows the same pattern as other analyzer DLLs and places it in the correct package path.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codeclimate bot commented Jan 17, 2025

Code Climate has analyzed commit 90137b5 and detected 0 issues on this pull request.

View more on Code Climate.

@rjmurillo rjmurillo self-assigned this Jan 17, 2025
@rjmurillo rjmurillo merged commit 76d8b8e into rjmurillo:main Jan 17, 2025
9 checks passed
@rjmurillo rjmurillo added this to the vNext milestone Jan 17, 2025
rjmurillo pushed a commit that referenced this pull request Jan 17, 2025
This fixes a regression caused by #290.

`Microsoft.CodeAnalysis.AnalyzerUtilities` is not one of the assemblies
provided by the host (i.e. compiler), so we need to include it in our
own package.

I'm not sure how to write an automated test for this. Our current tests
don't use the NuGet package. Doing something like `dotnet format` in
theory should work, but when I tried that it passed even without this
change.

This does result in a new package contents baseline, so we can chalk
this one up to reviewer error and revisit if we find a better solution.
@MattKotsenas MattKotsenas deleted the bugfix/fix-utilities-package-local branch January 18, 2025 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants