Skip to content

Conversation

Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from Copilot June 4, 2025 09:52
Copy link

@Copilot 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

This PR enhances documentation and localization for the markdown-preview plugin.

  • Updates comment casing and adds Chinese translations in locale definitions
  • Improves JSDoc on the plugin entry and adds a type export for options
  • Refactors both English and Chinese docs for <VPPreview> localization

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/markdown/plugin-markdown-preview/src/shared/locales.ts Capitalize comment and add Chinese translation
plugins/markdown/plugin-markdown-preview/src/node/options.ts Clarify localization config comment and add Chinese
plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts Add JSDoc block with example and Chinese description
plugins/markdown/plugin-markdown-preview/src/node/index.ts Add export type * from './options.js' re-export
docs/zh/plugins/markdown/markdown-preview.md Update bilingual doc text and formatting
docs/plugins/markdown/markdown-preview.md Simplify detail line formatting
Comments suppressed due to low confidence (3)

docs/zh/plugins/markdown/markdown-preview.md:92

  • The docs reference MarkdownPreviewLocaleData, but the code defines MarkdownPreviewPluginLocaleData. Align the interface name in the documentation to match the code.
export interface MarkdownPreviewLocaleData {

docs/plugins/markdown/markdown-preview.md:97

  • The docs reference MarkdownPreviewLocaleData, but the code defines MarkdownPreviewPluginLocaleData. Update the interface name here for consistency.
export interface MarkdownPreviewLocaleData {

plugins/markdown/plugin-markdown-preview/src/node/index.ts:2

  • The syntax export type * from './options.js' may not be valid TypeScript. Consider using export * from './options.js' or explicitly exporting types, e.g., export type { MarkdownPreviewPluginOptions } from './options.js'.
export type * from './options.js'

@Mister-Hope Mister-Hope merged commit 7c0d5a4 into main Jun 4, 2025
26 checks passed
@Mister-Hope Mister-Hope deleted the markdwn-preview-refine branch June 4, 2025 09:53
@coveralls
Copy link

Pull Request Test Coverage Report for Build 15439229378

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 59.517%

Totals Coverage Status
Change from base Build 15439224576: 0.0%
Covered Lines: 1358
Relevant Lines: 2058

💛 - Coveralls

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