Skip to content

Conversation

Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from Copilot June 5, 2025 06:23
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 refactors the prismjs plugin by adding comprehensive JSDoc comments (including Chinese translations) and improving documentation across both source code and user guides.

  • Added detailed JSDoc comments and examples to utility functions, parsers, and plugin configuration.
  • Updated markdown documentation in both English and Chinese to improve clarity and consistency.

Reviewed Changes

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

Show a summary per file
File Description
plugins/markdown/plugin-prismjs/src/node/utils/resolveLanguage.ts Added JSDoc comments with bilingual examples
plugins/markdown/plugin-prismjs/src/node/utils/escapeRegExp.ts Added JSDoc comments with bilingual examples
plugins/markdown/plugin-prismjs/src/node/types.ts Improved documentation for options with Chinese translations
plugins/markdown/plugin-prismjs/src/node/resolveHighlighter.ts Added detailed JSDoc comments and examples
plugins/markdown/plugin-prismjs/src/node/prismjsPlugin.ts Added top-level plugin documentation
plugins/markdown/plugin-prismjs/src/node/parser/*.ts Added or updated JSDoc comments in multiple parser files
docs/zh/plugins/markdown/prismjs.md Updated Chinese docs with refined language
docs/plugins/markdown/prismjs.md Updated English docs for better clarity
.github/copilot-instructions.md Adjusted internal documentation formatting
Comments suppressed due to low confidence (1)

plugins/markdown/plugin-prismjs/src/node/parser/highlightWord.ts:55

  • The JSDoc example code block formatting seems malformed in this example. Please update the code fence to a valid format (for example, using a single pair of triple backticks) to clearly demonstrate the intended usage.
* `` ```js /Hello|Hi/ ``

@coveralls
Copy link

coveralls commented Jun 5, 2025

Pull Request Test Coverage Report for Build 15460110404

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.858%

Totals Coverage Status
Change from base Build 15458146937: 0.0%
Covered Lines: 1319
Relevant Lines: 1992

💛 - Coveralls

@Mister-Hope Mister-Hope merged commit 15f53e7 into main Jun 5, 2025
26 checks passed
@Mister-Hope Mister-Hope deleted the prismjs-refine branch June 5, 2025 06:31
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