8000 feat(lang-service): support track virtual code generation by ShenQingchuan · Pull Request #284 · vue-vine/vue-vine · GitHub
[go: up one dir, main page]
Skip to content

feat(lang-service): support track virtual code generation #284

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 18, 2025
Merged

feat(lang-service): support track virtual code generation #284

merged 1 commit into from
Jun 18, 2025

Conversation

ShenQingchuan
Copy link
Member
@ShenQingchuan ShenQingchuan commented Jun 18, 2025 •
edited by coderabbitai bot
Loading

Description

We add one more event for track, since extension_activated is too general and actually the extension is activated when opening any TS file.

Summary by CodeRabbit

  • New Features
    • Introduced telemetry tracking for key extension events, such as virtual code creation, with environment-aware configuration and logging.
  • Refactor
    • Streamlined tracking implementation by delegating tracking logic to a shared analytics module, improving maintainability and consistency across components.
  • Chores
    • Updated dependencies to include and remove analytics-related packages as needed.

@netlify Netlify
Copy link
netlify bot commented Jun 18, 2025 •
edited
Loading

✅ Deploy Preview for vue-vine ready!

Name Link
🔨 Latest commit d8bf076
🔍 Latest deploy log https://app.netlify.com/projects/vue-vine/deploys/6852264defa87700081a8b0b
😎 Deploy Preview https://deploy-preview-284--vue-vine.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jun 18, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

A tracking system was introduced across the language server and VSCode extension packages. New modules for tracking were added, existing code was refactored to use a shared Track class, and environment-based configuration was set up. Dependency management was updated to centralize the Umami analytics client, and logging was improved with timestamped output.

Changes

File(s) Change Summary
language-server/src/track.ts New module for tracking; exports a track instance configured from environment variables.
language-server/src/index.ts Imports and injects track into plugin options for language plugin initialization.
language-service/src/track.ts New tracking module with Track class, event types, and logging utilities; integrates with Umami.
language-service/src/index.ts Adds track option to plugin options; exports tracking utilities; tracks virtual code creation events.
language-service/package.json Adds @umami/node as a dependency.
vscode-ext/src/track.ts Refactored to use Track from language-service; simplifies setup via useDataTrack async function.
vscode-ext/src/index.ts Refactored tracking and logging setup; passes env info to language server; uses built-in output channel.
vscode-ext/src/view-features.ts Updates Track import to use language-service package.
vscode-ext/package.json Removes @umami/node from devDependencies.

Sequence Diagram(s)

sequenceDiagram
    participant VSCodeExt as VSCode Extension
    participant Track as Track (language-service)
    participant LangServer as Language Server
    participant Umami as Umami Analytics

    VSCodeExt->>Track: useDataTrack(envInfo, outputChannel)
    Track-->>VSCodeExt: Track instance

    VSCodeExt->>LangServer: Start with envInfo (including tracking config)
    LangServer->>track: Initialize with env vars

    LangServer->>Track: trackEvent('virtual_code_created')
    Track->>Umami: Send event with metadata
    Umami-->>Track: Acknowledge/response
    Track-->>LangServer: Log tracking result
Loading

Poem

In the warren of code, a new path unfurled,
With tracking and logging, our metrics are twirled.
From server to extension, events now can flow,
Each hop with a timestamp, so we always know.
🐇 Analytics hop in, with Umami in tow!

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 81a794b and d8bf076.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (9)
  • packages/language-server/src/index.ts (2 hunks)
  • packages/language-server/src/track.ts (1 hunks)
  • packages/language-service/package.json (1 hunks)
  • packages/language-service/src/index.ts (5 hunks)
  • packages/language-service/src/track.ts (1 hunks)
  • packages/vscode-ext/package.json (0 hunks)
  • packages/vscode-ext/src/index.ts (2 hunks)
  • packages/vscode-ext/src/track.ts (1 hunks)
  • packages/vscode-ext/src/view-features.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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 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.

@ShenQingchuan ShenQingchuan merged commit 06f9a42 into main Jun 18, 2025
7 of 10 checks passed
@ShenQingchuan ShenQingchuan deleted the feat/track-virtual-code-generation branch June 18, 2025 02:37
@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Jun 18, 2025

Open in StackBlitz

@vue-vine/compiler

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/compiler@284

create-vue-vine

npm i https://pkg.pr.new/vue-vine/vue-vine/create-vue-vine@284

@vue-vine/eslint-config

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/eslint-config@284

@vue-vine/eslint-parser

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/eslint-parser@284

@vue-vine/eslint-plugin

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/eslint-plugin@284

@vue-vine/language-server

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/language-server@284

@vue-vine/language-service

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/language-service@284

@vue-vine/nuxt

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/nuxt@284

vue-vine-tsc

npm i https://pkg.pr.new/vue-vine/vue-vine/vue-vine-tsc@284

@vue-vine/vite-plugin

npm i https://pkg.pr.new/vue-vine/vue-vine/@vue-vine/vite-plugin@284

vue-vine

npm i https://pkg.pr.new/vue-vine/vue-vine@284

commit: d8bf076

@coderabbitai coderabbitai bot mentioned this pull request Jun 19, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ShenQingchuan
0