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:04
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

Refactor plugin-markdown-hint: add JSDoc comments and update documentation to clarify plugin options, correct grammar, and standardize terminology.

  • Added JSDoc headers for plugin exports and hint/alert sub-plugins
  • Fixed typos, capitalization, and replaced “danger” with “caution” in code comments and docs
  • Updated zh/en documentation examples, option descriptions, and container lists

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
plugins/markdown/plugin-markdown-hint/src/node/options.ts Fixed typos and standardized JSDoc comments for plugin options and locale data
plugins/markdown/plugin-markdown-hint/src/node/markdownHintPlugin.ts Added JSDoc summary and example usage for the main plugin export
plugins/markdown/plugin-markdown-hint/src/node/hint.ts Added JSDoc header for the hint container markdown-it plugin
plugins/markdown/plugin-markdown-hint/src/node/alert.ts Added JSDoc header for the GFM alert markdown-it plugin
docs/zh/plugins/markdown/markdown-hint.md Updated Chinese docs: container list, example links, option table, and grammar
docs/plugins/markdown/markdown-hint.md Updated English docs: container list, example links, grammar, and option descriptions
Comments suppressed due to low confidence (4)

plugins/markdown/plugin-markdown-hint/src/node/markdownHintPlugin.ts:15

  • [nitpick] Consider capitalizing each major word in the JSDoc title—e.g., "Markdown Hint Plugin"—to match the style used in other plugin docs and improve consistency.
* Markdown hint plugin

plugins/markdown/plugin-markdown-hint/src/node/hint.ts:27

  • [nitpick] For clarity, you might rename this JSDoc title to something like "Markdown-It Hint Container Plugin" so it clearly indicates the integration target.
* Hint container markdown-it plugin

docs/zh/plugins/markdown/markdown-hint.md:158

  • 该嵌套列表前面缺少缩进或列表标记,请检查 markdown 语法以确保正确渲染。
详情:提示容器标题的本地化配置。

docs/plugins/markdown/markdown-hint.md:103

  • [nitpick] For consistency with the other options (hint, injectStyles), consider adding a Default: false and/or Type: boolean line under this heading.
Details: Whether to enable GFM alert support.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 15438215181

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 15437986461: 0.0%
Covered Lines: 1358
Relevant Lines: 2058

💛 - Coveralls

@Mister-Hope Mister-Hope merged commit f540a82 into main Jun 4, 2025
30 checks passed
@Mister-Hope Mister-Hope deleted the markdown-hint-refine branch June 4, 2025 09:15
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