move @vue/compiler-sfc to peerDependencies

[HunterLarco]

Description

In #7271 we updated the behavior of @vue/compiler-sfc. Through that process I realized that devDependencies may not be the best way to model our vue dependency.

As written now, our code relies on interfaces starting from @vue/compiler-sfc version 3.3.1. Any client trying to use vue with this library using a version before 3.3.1 will run into obscure runtime errors.

We can meaningfully improve this by moving @vue/compiler-sfc to peerDependencies so that npm install correctly enforces version constraints between this package and a client's vue installation.

That said, vue is intended to be an optional dependency for this package as not all clients use vue. Fortunately package.json supports this through peerDependenciesMeta which we take advantage of here so that clients aren't forced to install @vue/compiler-sfc but if they do (by manually installing it themselves) we'll still check version constraints at install time.

Related #6945

Type of change

• Bug fix (non-breaking change which fixes an issue)

Checklist:

• I have followed the
  CONTRIBUTING doc and the
  style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests and linter rules pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[changeset-bot]

⚠️ No Changeset found

Latest commit: c430c6d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Chores
  • Updated peer dependency information to include @vue/compiler-sfc as an optional dependency for improved compatibility with Vue projects.

Walkthrough

The package @graphql-tools/graphql-tag-pluck was updated to add @vue/compiler-sfc as an optional peer dependency in its package.json. Additionally, ESLint disable comments related to extraneous dependencies were removed from two utility functions in the source code, with no changes to their logic or exports.

Changes

File(s)	Change Summary
packages/graphql-tag-pluck/package.json	Added @vue/compiler-sfc as an optional peer dependency using peerDependenciesMeta.
packages/graphql-tag-pluck/src/index.ts	Removed ESLint disable comments from functions loading @vue/compiler-sfc; no logic changes.

Poem

A hop and a skip, a peer now appears,
Vue’s compiler joins, but don’t shed any tears—
It’s optional, friend, so no need to fret,
The code stays the same, no errors to get.
With linting lines gone, the source is now neat,
A tidy-up treat for a rabbit’s small feat! 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/graphql-tag-pluck/package.json (1)

50-52: Peer-dependency version range looks good, but consider being explicit about the upper bound

"^3.3.1" already means “≥ 3.3.1 < 4.0.0”, but tools/readers sometimes read the caret semver less intuitively than a bounded range.
If you want to make the intent crystal-clear, you could switch to the more explicit form:

-    "@vue/compiler-sfc": "^3.3.1",
+    "@vue/compiler-sfc": ">=3.3.1 <4",

Functionally identical, so feel free to ignore if you prefer the caret style.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d2690e and c430c6d.

📒 Files selected for processing (2)

• packages/graphql-tag-pluck/package.json (1 hunks)
• packages/graphql-tag-pluck/src/index.ts (0 hunks)

💤 Files with no reviewable changes (1)

• packages/graphql-tag-pluck/src/index.ts

⏰ 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). (3)

• GitHub Check: Unit Test on Node 18 (windows-latest) and GraphQL v16
• GitHub Check: Unit Test on Node 18 (ubuntu-latest) and GraphQL v16
• GitHub Check: Unit Test on Node 18 (ubuntu-latest) and GraphQL v15

🔇 Additional comments (1)

packages/graphql-tag-pluck/package.json (1)

53-57: 👍 Correct use of peerDependenciesMeta to keep Vue truly optional

Marking the peer as optional: true prevents npm from erroring out for non-Vue consumers while still surfacing a warning when a mismatching version is present.
No further action needed.