Skip to content

Conversation

@Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from Copilot June 2, 2025 15:51
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Refine JSDoc comments and user-facing documentation for the Google Analytics plugin and re-export shared types.

  • Update option interfaces with clearer descriptions and default tags
  • Re-export shared types in the Node entry point
  • Enhance JSDoc on plugin factory and composable, and polish English/Chinese docs wording

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
plugins/analytics/plugin-google-analytics/src/shared/types.ts Clarify id and debug option JSDoc, add @description and @default
plugins/analytics/plugin-google-analytics/src/node/index.ts Add a type-only re-export from shared types
plugins/analytics/plugin-google-analytics/src/node/googleAnalyticsPlugin.ts Add detailed JSDoc for the plugin function
plugins/analytics/plugin-google-analytics/src/client/composables/useGoogleAnalytics.ts Refine composable JSDoc with parameter and examples
docs/zh/plugins/analytics/google-analytics.md Polish Chinese documentation phrasing
docs/plugins/analytics/google-analytics.md Polish English documentation phrasing
Comments suppressed due to low confidence (2)

plugins/analytics/plugin-google-analytics/src/client/composables/useGoogleAnalytics.ts:22

  • The JSDoc for useGoogleAnalytics is missing an @returns tag describing the return value of the composable function. Please add a @returns section for clarity.
*/

plugins/analytics/plugin-google-analytics/src/node/index.ts:2

  • The export type * from syntax is invalid in TypeScript. Use export * from '../shared/index.js' to re-export everything, or explicitly list types with export type { Foo, Bar } from '../shared/index.js'.
export type * from '../shared/index.js'

@Mister-Hope Mister-Hope merged commit 7ae97d2 into main Jun 2, 2025
26 checks passed
@Mister-Hope Mister-Hope deleted the refine-google branch June 2, 2025 15:54
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.

2 participants