refactor: improve codes and update jsdoc#668
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR primarily standardizes and cleans up JSDoc / doc formatting across the repo, while also updating lint/tooling configuration and making a few small runtime-behavior changes.
Changes:
- Normalize JSDoc style across utilities, plugins, themes, and docs (wrapping, ordering,
@exampleformatting, removing redundant@descriptionblocks). - Update lint/tooling setup (oxlint config + related devDependencies) and remove/adjust local oxlint suppression comments.
- A few functional tweaks (e.g., service-worker prefetch warning logic, slimsearch worker message parsing).
Reviewed changes
Copilot reviewed 298 out of 340 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/helper/src/client/utils/isKeyMatched.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/utils/isFocusingTextControl.ts | JSDoc reflow; removes blank lines. |
| tools/helper/src/client/utils/hasGlobalComponent.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/utils/getHeaders.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/utils/data.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/noopComponent.ts | JSDoc return formatting. |
| tools/helper/src/client/composables/useLocaleConfig.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/composables/useHeaders.ts | JSDoc whitespace cleanup. |
| tools/helper/src/client/components/RenderDefault.ts | JSDoc capitalization/format normalization. |
| tools/helper/src/client/components/LoadingIcon.ts | JSDoc/interface doc reflow; example/returns ordering. |
| tools/create-vuepress/src/flow/createPackageJson.ts | JSDoc one-liner normalization. |
| themes/theme-default/tsdown.config.ts | Switch to import.meta.dirname for dirname resolution. |
| themes/theme-default/src/shared/sidebar.ts | JSDoc one-liner normalization. |
| themes/theme-default/src/shared/options.ts | JSDoc wrapping and example formatting improvements. |
| themes/theme-default/src/shared/navbar.ts | JSDoc one-liner normalization. |
| themes/theme-default/src/shared/nav.ts | JSDoc one-liner normalization. |
| themes/theme-default/src/node/typings.ts | JSDoc compacting. |
| themes/theme-default/src/node/defaultTheme.ts | Type import cleanup; adjusts extendsPage typing and option JSDoc. |
| themes/theme-default/src/client/utils/resolveAutoLink.ts | Reorder JSDoc tags (example before params). |
| themes/theme-default/src/client/composables/useUpdateDeviceStatus.ts | JSDoc wrapping; minor text adjustment. |
| themes/theme-default/src/client/composables/useRelatedLinks.ts | JSDoc wrapping. |
| themes/theme-default/src/client/composables/useDarkMode.ts | JSDoc one-liner normalization. |
| themes/theme-default/src/client/components/global/Badge.vue | Prop JSDoc compacting. |
| themes/theme-default/src/client/components/VPSidebarItem.vue | Prop JSDoc compacting. |
| themes/theme-default/src/client/components/VPNavbarDropdown.vue | Prop JSDoc capitalization + comment reflow. |
| themes/theme-default/src/client/components/VPAutoLink.vue | Prop JSDoc compacting. |
| scripts/tsdown.ts | JSDoc cleanup; adds missing @default; wraps long lines. |
| scripts/syncNpmmirror.ts | Switch to import.meta.dirname for root resolution. |
| plugins/tools/plugin-replace-assets/src/node/utils.ts | Reorders @example; removes fenced block. |
| plugins/tools/plugin-replace-assets/src/node/transformAssets.ts | JSDoc wrapping + example formatting. |
| plugins/tools/plugin-replace-assets/src/node/replaceAssetsPlugin.ts | JSDoc example formatting cleanup. |
| plugins/tools/plugin-replace-assets/src/node/constants.ts | JSDoc capitalization. |
| plugins/tools/plugin-register-components/src/node/registerComponentsPlugin.ts | JSDoc wrapping/compacting. |
| plugins/tools/plugin-register-components/src/node/createMatcher.ts | JSDoc wrapping + return capitalization. |
| plugins/tools/plugin-redirect/src/shared/locales.ts | JSDoc capitalization. |
| plugins/tools/plugin-redirect/src/shared/behavior.ts | JSDoc wrapping; default quoting standardized. |
| plugins/tools/plugin-redirect/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/tools/plugin-google-tag-manager/src/node/googleTagManagerPlugin.ts | JSDoc compacting. |
| plugins/tools/plugin-cache/src/node/utils.ts | Add oxlint suppression comment for generic type parameter. |
| plugins/tools/plugin-cache/src/node/renderCache.ts | Long comment reflow. |
| plugins/tools/plugin-cache/src/node/highlightCache.ts | Long comment reflow. |
| plugins/tools/plugin-cache/src/node/cachePlugin.ts | Long comment reflow. |
| plugins/tools/plugin-auto-frontmatter/src/node/types.ts | JSDoc capitalization and example formatting changes. |
| plugins/tools/plugin-auto-frontmatter/src/node/resolveRules.ts | JSDoc capitalization + @internal placement. |
| plugins/tools/plugin-auto-frontmatter/src/node/helper/addTitle.ts | JSDoc example formatting changes. |
| plugins/tools/plugin-auto-frontmatter/src/node/helper/addPermalink.ts | JSDoc example formatting changes. |
| plugins/tools/plugin-auto-frontmatter/src/node/helper/addCreateDate.ts | JSDoc wrapping; standardized @default quoting. |
| plugins/tools/plugin-auto-frontmatter/src/node/generateFrontmatter.ts | JSDoc wrapping. |
| plugins/tools/plugin-auto-frontmatter/src/node/autoFrontmatterPlugin.ts | JSDoc wrapping; picomatch option change. |
| plugins/seo/plugin-sitemap/src/typings/options.ts | JSDoc tweaks; standardized @default quoting; wrapping. |
| plugins/seo/plugin-sitemap/src/node/getSitemap.ts | Refactors arrow formatting to block bodies. |
| plugins/seo/plugin-seo/src/typings/schema.ts | JSDoc cleanup + wrapping; replaces some @description. |
| plugins/seo/plugin-seo/src/typings/frontmatter.ts | JSDoc compacting. |
| plugins/seo/plugin-seo/src/node/options.ts | Replaces @description with plain sentences; capitalization tweaks. |
| plugins/search/plugin-slimsearch/src/worker/dev.ts | Adjusts message destructuring defaults (runtime behavior change). |
| plugins/search/plugin-slimsearch/src/shared/worker.ts | JSDoc @default quoting normalization. |
| plugins/search/plugin-slimsearch/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/search/plugin-slimsearch/src/node/generateIndex.ts | JSDoc cleanup for tag constants. |
| plugins/search/plugin-slimsearch/src/client/utils/createSearchWorker.ts | JSDoc param capitalization. |
| plugins/search/plugin-slimsearch/src/client/composables/useSuggestions.ts | Adds explicit types to default filter function. |
| plugins/search/plugin-slimsearch/src/client/composables/useResults.ts | Adds explicit types to default filter function. |
| plugins/search/plugin-search/src/shared/locales.ts | JSDoc compacting. |
| plugins/search/plugin-search/src/node/searchPlugin.ts | JSDoc wrapping/compacting. |
| plugins/search/plugin-search/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/search/plugin-meilisearch/src/cli/utils.ts | JSDoc wrapping. |
| plugins/search/plugin-meilisearch/src/cli/shouldRescrape.ts | JSDoc wrapping. |
| plugins/search/plugin-docsearch/src/shared/options.ts | Removes oxlint suppression comment. |
| plugins/search/plugin-docsearch/src/node/docsearchPlugin.ts | JSDoc example fence removal. |
| plugins/search/plugin-docsearch/src/client/utils/pollToOpenDocSearch.ts | JSDoc one-liner normalization. |
| plugins/search/plugin-docsearch/src/client/utils/getSearchButtonTemplate.ts | JSDoc wrapping. |
| plugins/search/plugin-docsearch/src/client/helpers/docsearch.ts | JSDoc tag ordering changes. |
| plugins/search/plugin-docsearch/src/client/components/DocSearch.ts | In-function comment compacting. |
| plugins/pwa/plugin-remove-pwa/src/node/options.ts | Standardized @default quoting. |
| plugins/pwa/plugin-pwa/src/shared/manifest.ts | JSDoc one-liner normalization. |
| plugins/pwa/plugin-pwa/src/shared/locales.ts | JSDoc text change (iOS/Ios capitalization). |
| plugins/pwa/plugin-pwa/src/node/pwaPlugin.ts | Changes prefetch-warning logic (runtime behavior change). |
| plugins/pwa/plugin-pwa/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/pwa/plugin-pwa/src/client/utils/unregisterSW.ts | JSDoc wrapping. |
| plugins/pwa/plugin-pwa/src/client/utils/skipWaiting.ts | JSDoc wrapping. |
| plugins/pwa/plugin-pwa/src/client/components/PwaReadyPopup.ts | Prop JSDoc capitalization. |
| plugins/pwa/plugin-pwa/src/client/components/PwaInstallModal.ts | Prop JSDoc capitalization. |
| plugins/pwa/plugin-pwa/src/client/components/PwaInstall.ts | Prop JSDoc capitalization. |
| plugins/pwa/plugin-pwa/src/client/components/PwaFoundPopup.ts | Prop JSDoc capitalization. |
| plugins/markdown/plugin-shiki/src/node/utils.ts | JSDoc restructure (step list formatting). |
| plugins/markdown/plugin-shiki/src/node/transformers/vuepressTransformers.ts | JSDoc wrapping/compacting. |
| plugins/markdown/plugin-shiki/src/node/shikiPlugin.ts | JSDoc fence removals; comment compacting. |
| plugins/markdown/plugin-shiki/src/node/options.ts | Replace @description sentence. |
| plugins/markdown/plugin-shiki/src/node/markdown/preWrapperPlugin.ts | JSDoc tag ordering; adds @default. |
| plugins/markdown/plugin-shiki/src/node/markdown/highlighter/handleMustache.ts | Parameter docs capitalization + wrapping. |
| plugins/markdown/plugin-shiki/src/node/markdown/highlighter/getHighLightFunction.ts | JSDoc whitespace removal + wrapping. |
| plugins/markdown/plugin-shiki/src/node/markdown/highlighter/createShikiHighlighter.ts | JSDoc wrapping; tag ordering tweaks. |
| plugins/markdown/plugin-shiki/src/node/markdown/highlighter/createMarkdownFilePathGetter.ts | JSDoc whitespace cleanup. |
| plugins/markdown/plugin-revealjs/src/shared/theme.ts | Capitalization tweak in comment. |
| plugins/markdown/plugin-revealjs/src/node/revealJsPlugin.ts | JSDoc restructure; reorders defaults/params. |
| plugins/markdown/plugin-revealjs/src/node/prepare/prepareClientConfigFile.ts | Refactors forEach callback to block body. |
| plugins/markdown/plugin-revealjs/src/node/options.ts | Standardized @default quoting; comment capitalization. |
| plugins/markdown/plugin-revealjs/src/client/helpers/revealJs.ts | JSDoc tag ordering. |
| plugins/markdown/plugin-prismjs/tests/prismjs-preWrapper.spec.ts | Removes oxlint suppression comment. |
| plugins/markdown/plugin-prismjs/tests/getCodeParser.spec.ts | Expands callback into block body. |
| plugins/markdown/plugin-prismjs/src/node/utils/resolveLanguage.ts | Reorders @example vs params; capitalization. |
| plugins/markdown/plugin-prismjs/src/node/utils/languages.ts | JSDoc wrapping. |
| plugins/markdown/plugin-prismjs/src/node/utils/escapeRegExp.ts | Reorders @example vs params. |
| plugins/markdown/plugin-prismjs/src/node/resolveHighlighter.ts | Reorders @example vs params; formatting. |
| plugins/markdown/plugin-prismjs/src/node/prismjsPlugin.ts | JSDoc example formatting + tag ordering. |
| plugins/markdown/plugin-prismjs/src/node/parser/whitespace.ts | JSDoc formatting + adds FIXME note. |
| plugins/markdown/plugin-prismjs/src/node/parser/notation.ts | Reformats module header docs and section titles. |
| plugins/markdown/plugin-prismjs/src/node/parser/highlightWord.ts | Adds FIXME + example formatting. |
| plugins/markdown/plugin-prismjs/src/node/parser/highlightLines.ts | @example formatting; moves params after example. |
| plugins/markdown/plugin-prismjs/src/node/parser/getCodeParser.ts | JSDoc wrapping; @example formatting. |
| plugins/markdown/plugin-prismjs/src/node/parser/createNotationRule.ts | @example formatting; moves params after example. |
| plugins/markdown/plugin-prismjs/src/node/markdown/preWrapperPlugin.ts | JSDoc tag ordering and comment compacting. |
| plugins/markdown/plugin-prismjs/src/node/loadLanguages.ts | JSDoc tag ordering. |
| plugins/markdown/plugin-markdown-tab/src/node/markdownTabPlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-stylize/src/node/markdownStylizePlugin.ts | JSDoc tag ordering and capitalization. |
| plugins/markdown/plugin-markdown-preview/src/node/markdownPreviewPlugin.ts | JSDoc example formatting. |
| plugins/markdown/plugin-markdown-math/src/node/markdownMathPlugin.ts | JSDoc example formatting + minor return behavior simplification. |
| plugins/markdown/plugin-markdown-include/src/node/markdownIncludePlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-image/src/node/options.ts | JSDoc whitespace cleanup. |
| plugins/markdown/plugin-markdown-image/src/node/markdownImagePlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-hint/src/node/options.ts | JSDoc wrapping. |
| plugins/markdown/plugin-markdown-hint/src/node/markdownHintPlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-hint/src/node/hint.ts | Param doc capitalization. |
| plugins/markdown/plugin-markdown-hint/src/node/alert.ts | Param doc capitalization. |
| plugins/markdown/plugin-markdown-file-tree/src/node/parseFileTreeContent.ts | JSDoc wrapping. |
| plugins/markdown/plugin-markdown-file-tree/src/node/markdownFileTreePlugin.ts | Removes blank JSDoc line; example formatting. |
| plugins/markdown/plugin-markdown-ext/src/node/options.ts | JSDoc normalization; replaces @description with sentences. |
| plugins/markdown/plugin-markdown-ext/src/node/markdownExtPlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-ext/src/node/markdown-it-plugins/vPre.ts | Comment clarifies v-pre and wraps in backticks. |
| plugins/markdown/plugin-markdown-ext/src/node/markdown-it-plugins/utils.ts | Removes @description tag in favor of sentence. |
| plugins/markdown/plugin-markdown-container/src/node/options.ts | JSDoc normalization; wraps plugin name in backticks. |
| plugins/markdown/plugin-markdown-container/src/node/markdownContainerPlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-chart/src/node/options.ts | JSDoc wrapping (security-related option). |
| plugins/markdown/plugin-markdown-chart/src/node/markdownChartPlugin.ts | Removes fenced example block delimiters. |
| plugins/markdown/plugin-markdown-chart/src/node/markdown-it-plugins/mermaid.ts | JSDoc whitespace cleanup. |
| plugins/markdown/plugin-markdown-chart/src/client/utils/flowchart-presets/index.ts | Comment wrapping. |
| plugins/markdown/plugin-markdown-chart/src/client/helpers/mermaid.ts | JSDoc tag ordering. |
| plugins/markdown/plugin-markdown-chart/src/client/helpers/echarts.ts | JSDoc tag ordering. |
| plugins/markdown/plugin-links-check/src/node/options.ts | Removes @description tag => sentence. |
| plugins/markdown/plugin-links-check/src/node/linksCheckPlugin.ts | Example formatting cleanup. |
| plugins/markdown/plugin-links-check/src/node/checkMarkdownLink.ts | JSDoc wrapping. |
| plugins/markdown/plugin-append-date/src/node/options.ts | Standardized @default quoting. |
| plugins/markdown/plugin-append-date/src/node/formatDate.ts | JSDoc wrapping. |
| plugins/markdown/plugin-append-date/src/node/appendDatePlugin.ts | Example formatting + tag ordering. |
| plugins/features/plugin-watermark/src/node/watermarkPlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-watermark/src/client/helper/watermark.ts | JSDoc reflow; example fence removal. |
| plugins/features/plugin-photo-swipe/src/node/photoSwipePlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-photo-swipe/src/node/options.ts | Standardized @default quoting. |
| plugins/features/plugin-photo-swipe/src/client/utils/createPhotoSwipe.ts | Example formatting; tag ordering. |
| plugins/features/plugin-photo-swipe/src/client/helpers/photo-swipe.ts | Tag ordering; removes fenced block delimiters. |
| plugins/features/plugin-photo-swipe/src/client/composables/usePhotoSwipe.ts | Comment capitalization and tag ordering. |
| plugins/features/plugin-nprogress/src/node/nprogressPlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-notice/src/shared/notice.ts | JSDoc wrapping and example formatting. |
| plugins/features/plugin-notice/src/node/noticePlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-notice/src/client/components/Notice.ts | Adds oxlint suppression comment for default assignment. |
| plugins/features/plugin-medium-zoom/src/node/options.ts | Comment capitalization. |
| plugins/features/plugin-medium-zoom/src/client/composables/useMediumZoom.ts | Tag ordering; comment capitalization. |
| plugins/features/plugin-icon/src/node/options.ts | JSDoc wrapping; standardized @default quoting. |
| plugins/features/plugin-icon/src/node/iconPlugin.ts | Example formatting cleanup. |
| plugins/features/plugin-icon/src/client/components/VPIcon.ts | Prop docs compacting. |
| plugins/features/plugin-copyright/src/shared/options.ts | JSDoc normalization + combines bilingual summary. |
| plugins/features/plugin-copyright/src/shared/locales.ts | Removes @description tag => sentence. |
| plugins/features/plugin-copyright/src/shared/frontmatter.ts | Removes @description tag => sentence. |
| plugins/features/plugin-copyright/src/node/copyrightPlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-copy-code/src/node/options.ts | JSDoc wrapping; standardizes defaults and type list formatting. |
| plugins/features/plugin-copy-code/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/features/plugin-copy-code/src/node/copyCodePlugin.ts | Removes fenced example block delimiters. |
| plugins/features/plugin-catalog/src/node/options.ts | JSDoc wrapping + capitalization. |
| plugins/features/plugin-catalog/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/features/plugin-catalog/src/node/catalogPlugin.ts | Example formatting cleanup. |
| plugins/features/plugin-catalog/src/client/helpers/useCatalogInfoGetter.ts | Param capitalization. |
| plugins/features/plugin-catalog/src/client/components/Catalog.ts | Removes @description tag => sentence. |
| plugins/features/plugin-back-to-top/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/features/plugin-back-to-top/src/node/backToTopPlugin.ts | Example formatting cleanup. |
| plugins/development/plugin-toc/src/node/tocPlugin.ts | Example formatting cleanup. |
| plugins/development/plugin-toc/src/node/options.ts | Deprecation doc compacting in one line. |
| plugins/development/plugin-sass-palette/src/node/useSassPalettePlugin.ts | Example formatting + removes @description tag. |
| plugins/development/plugin-sass-palette/src/node/sassPalettePlugin.ts | JSDoc wrapping + adds oxlint suppression for default assignment. |
| plugins/development/plugin-sass-palette/src/node/removePalettePlugin.ts | Example formatting cleanup; quoting standardized. |
| plugins/development/plugin-sass-palette/src/node/options.ts | JSDoc cleanup; standardized @default quoting; wrapping. |
| plugins/development/plugin-sass-palette/src/node/injectScssConfigModule.ts | Removes @description tag => sentence. |
| plugins/development/plugin-rtl/src/node/rtlPlugin.ts | Example formatting cleanup. |
| plugins/development/plugin-rtl/src/client/utils/index.ts | JSDoc tag ordering and wrapping. |
| plugins/development/plugin-rtl/src/client/composables/useRtl.ts | JSDoc tag ordering; loop variable default removal (runtime behavior change). |
| plugins/development/plugin-reading-time/src/node/useReadingTimePlugin.ts | Example formatting + tag ordering. |
| plugins/development/plugin-reading-time/src/node/readingTimePlugin.ts | Example formatting + tag ordering. |
| plugins/development/plugin-reading-time/src/node/locales.ts | JSDoc one-liner normalization. |
| plugins/development/plugin-reading-time/src/node/getReadingTime.ts | JSDoc reformatting; tag ordering; capitalization. |
| plugins/development/plugin-reading-time/src/client/utils/locales.ts | Example formatting + tag ordering. |
| plugins/development/plugin-reading-time/src/client/composables/useReadingTimeLocale.ts | Example formatting + tag ordering. |
| plugins/development/plugin-reading-time/src/client/composables/useReadingTimeData.ts | Example formatting + tag ordering. |
| plugins/development/plugin-palette/src/node/prepareStyleFile.ts | Example formatting + tag ordering. |
| plugins/development/plugin-palette/src/node/preparePaletteFile.ts | Example formatting + tag ordering. |
| plugins/development/plugin-palette/src/node/palettePlugin.ts | Example formatting cleanup. |
| plugins/development/plugin-git/src/shared/index.ts | JSDoc compacting and wrapping. |
| plugins/development/plugin-git/src/node/utils/sanitizeHTML.ts | Moves @see after returns; JSDoc cleanup. |
| plugins/development/plugin-git/src/node/utils/inferGitProvider.ts | JSDoc wrapping. |
| plugins/development/plugin-git/src/node/utils/getCommits.ts | JSDoc wrapping + @see positioning. |
| plugins/development/plugin-git/src/node/utils/checkGithubUsername.ts | Comment capitalization changes. |
| plugins/development/plugin-git/src/node/utils/checkGitRepo.ts | JSDoc wrapping. |
| plugins/development/plugin-git/src/node/typings.ts | JSDoc compacting. |
| plugins/development/plugin-git/src/node/resolveContributors.ts | Removes extra blank doc lines. |
| plugins/development/plugin-git/src/node/resolveChangelog.ts | Changes parseTagName return type for empty refs. |
| plugins/development/plugin-git/src/node/gitPlugin.ts | Example formatting cleanup. |
| plugins/development/plugin-git/src/client/utils/resolveRepoLink.ts | JSDoc whitespace cleanup. |
| plugins/development/plugin-git/src/client/components/VPHeader.ts | Prop docs capitalization. |
| plugins/development/plugin-git/src/client/components/GitContributors.ts | Prop docs capitalization. |
| plugins/development/plugin-git/src/client/components/GitChangelog.ts | Prop docs capitalization. |
| plugins/development/plugin-active-header-links/src/node/activeHeaderLinksPlugin.ts | JSDoc wrapping. |
| plugins/blog/plugin-feed/src/typings/frontmatter.ts | Removes @description tags; compact docs. |
| plugins/blog/plugin-feed/src/typings/feed.ts | Capitalization tweaks and wrapping. |
| plugins/blog/plugin-feed/src/node/utils/encodeXML.ts | Moves @see line. |
| plugins/blog/plugin-feed/src/node/generator/rss/index.ts | Moves @see line; compacts some comments. |
| plugins/blog/plugin-feed/src/node/generator/json/typings.ts | JSDoc compacting/rewrites. |
| plugins/blog/plugin-feed/src/node/generator/json/index.ts | Moves @see line. |
| plugins/blog/plugin-feed/src/node/generator/atom/index.ts | Moves @see line; compacts comments. |
| plugins/blog/plugin-feed/src/node/feedPlugin.ts | Removes @description tag; example fence removal. |
| plugins/blog/plugin-comment/src/shared/options/twikoo.ts | Standardized @default quoting. |
| plugins/blog/plugin-comment/src/shared/options/giscus.ts | Standardized @default quoting; removes @description tags => sentences. |
| plugins/blog/plugin-comment/src/shared/options/base.ts | JSDoc wrapping. |
| plugins/blog/plugin-comment/src/shared/frontmatter.ts | Removes @description tag => sentence. |
| plugins/blog/plugin-comment/src/node/options.ts | Removes oxlint suppression comment. |
| plugins/blog/plugin-comment/src/node/locales.ts | JSDoc one-liner normalization + removes oxlint suppression. |
| plugins/blog/plugin-comment/src/node/commentPlugin.ts | Example fence removal. |
| plugins/blog/plugin-comment/src/client/pageview/waline.ts | Makes returned pageview function use a block body. |
| plugins/blog/plugin-comment/src/client/components/WalineComment.ts | Removes oxlint suppression comment. |
| plugins/blog/plugin-blog/src/shared/frontmatter.ts | Combines bilingual comment into one line. |
| plugins/blog/plugin-blog/src/node/type/getType.ts | Adds oxlint suppression comment for default assignment. |
| plugins/blog/plugin-blog/src/node/store.ts | Removes @description tag => sentence; wraps long return doc. |
| plugins/blog/plugin-blog/src/node/blogPlugin.ts | Removes @description tag; adds Page param type on filter default. |
| plugins/blog/plugin-blog/src/client/composables/useBlogType.ts | Removes @description tag => sentence; merges bilingual param/return docs. |
| plugins/blog/plugin-blog/src/client/composables/useBlogCategory.ts | Removes @description tag => sentence; merges bilingual param/return docs. |
| plugins/analytics/plugin-umami-analytics/src/shared/options.ts | Removes @description tags => sentences; wrapping. |
| plugins/analytics/plugin-umami-analytics/src/node/umamiAnalyticsPlugin.ts | Removes @description tags => sentences; example formatting. |
| plugins/analytics/plugin-umami-analytics/src/client/composables/useUmamiAnalytics.ts | Removes @description tag => sentence; tag ordering. |
| plugins/analytics/plugin-google-analytics/src/shared/types.ts | Removes @description tag => sentence; adds blank line for @default section. |
| plugins/analytics/plugin-google-analytics/src/node/googleAnalyticsPlugin.ts | Removes @description tags => sentences; example formatting. |
| plugins/analytics/plugin-google-analytics/src/client/composables/useGoogleAnalytics.ts | Removes @description tag => sentence; tag ordering. |
| plugins/analytics/plugin-clarity-analytics/src/shared/options.ts | Removes @description tags; wraps long explanation. |
| plugins/analytics/plugin-clarity-analytics/src/node/clarityAnalyticsPlugin.ts | Removes @description tags => sentences; example formatting. |
| plugins/analytics/plugin-clarity-analytics/src/client/composables/useClarityAnalytics.ts | Removes @description tag => sentence; tag ordering. |
| plugins/analytics/plugin-baidu-analytics/src/node/options.ts | JSDoc wrapping. |
| plugins/analytics/plugin-baidu-analytics/src/node/baiduAnalyticsPlugin.ts | Removes @description tags; example formatting cleanup. |
| plugins/analytics/plugin-baidu-analytics/src/client/composables/useBaiduAnalytics.ts | Removes @description tag => sentence; tag ordering. |
| plugins/ai/plugin-llms/src/node/utils/expandTemplate.ts | Reorders @example vs params; adds inline example. |
| plugins/ai/plugin-llms/src/node/types.ts | JSDoc wrapping + example formatting changes. |
| plugins/ai/plugin-llms/src/node/remark-plugins/remarkPlease.ts | JSDoc wrapping; removes extra blank line. |
| plugins/ai/plugin-llms/src/node/remark-plugins/remarkInclude.ts | Moves example to top; renames "E.g." section. |
| plugins/ai/plugin-llms/src/node/remark-plugins/remarkImportCode.ts | JSDoc restructure and wrapping. |
| plugins/ai/plugin-llms/src/node/options.ts | JSDoc wrapping + capitalization. |
| plugins/ai/plugin-llms/src/node/markdown-it-plugins/llm-exclude.ts | JSDoc wrapping. |
| plugins/ai/plugin-llms/src/node/llmsPlugin.ts | Renames default transform arg for clarity (behavior equivalent). |
| package.json | Updates oxc/oxlint/oxfmt tool versions. |
| oxlint.config.ts | Updates config schema (ignore/vitest globs) + disables unnecessary type args rule. |
| e2e/utils/source.ts | JSDoc compacting. |
| e2e/docs/.vuepress/components/CssVariable.vue | Prop docs capitalization. |
| docs/zh/tools/helper/node/page.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/search/slimsearch.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/features/notice.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/features/copyright.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/blog/feed/getter.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/blog/feed/frontmatter.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/blog/comment/waline/config.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/blog/blog/guide.md | Removes @description tag text, keeps meaning. |
| docs/zh/plugins/blog/blog/config.md | Removes @description tag text, keeps meaning. |
| docs/tools/helper/node/page.md | Removes @description tag text, keeps meaning. |
| docs/plugins/search/slimsearch.md | Removes @description tag text, keeps meaning. |
| docs/plugins/features/notice.md | Removes @description tag text, keeps meaning. |
| docs/plugins/features/copyright.md | Removes @description tag text, keeps meaning. |
| docs/plugins/blog/feed/getter.md | Removes @description tag text, keeps meaning. |
| docs/plugins/blog/feed/frontmatter.md | Removes @description tag text, keeps meaning. |
| docs/plugins/blog/comment/waline/config.md | Removes @description tag text, keeps meaning. |
| docs/plugins/blog/blog/guide.md | Removes @description tag text, keeps meaning. |
| docs/plugins/blog/blog/config.md | Removes @description tag text, keeps meaning. |
| docs/.vuepress/utils/resolveAutoLink.ts | JSDoc tag ordering and capitalization. |
| docs/.vuepress/theme.ts | Comment wrapping/compacting. |
| docs/.vuepress/components/VPSidebarItem.vue | Prop docs compacting. |
| docs/.vuepress/components/VPNavbarDropdown.vue | Prop docs capitalization + wrapping. |
| docs/.vuepress/components/VPAutoLink.vue | Prop docs compacting. |
| docs/.vuepress/components/NpmBadge.vue | Prop docs capitalization. |
| AGENTS.md | Updates JSDoc template formatting and code fence style. |
| .ncurc.cjs | Changes update policy for @types/node; removes reject block. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (2)
plugins/search/plugin-slimsearch/src/worker/dev.ts:1
- Removing the default
locale = '/'can causedatabase[locale]to index withundefinedwhen callers omit locale (the client-side API allowslocale?: string). This will throw at runtime. Restore a default (locale = '/') or guard before indexing (e.g., usedatabase[locale ?? '/']).
import { loadJSONIndex } from 'slimsearch'
plugins/pwa/plugin-pwa/src/node/pwaPlugin.ts:54
- The warning condition appears inverted. The message recommends setting
shouldPrefetch: false, so it should warn whenshouldPrefetchistrue(prefetch enabled), not when it isfalse/undefined. Consider reverting toif (shouldPrefetch === true)(and keep the previous destructuring default if you rely on it).
if (shouldPrefetch !== true) {
logger.warn(
'The plugin will register service worker to handle assets, so we recommend you to set "shouldPrefetch: false" in VuePress config file.',
)
}
| if (app.env.isDebug) logger.info('Options:', options) | ||
|
|
||
| const { shouldPrefetch = true } = app.options | ||
| const { shouldPrefetch } = app.options |
There was a problem hiding this comment.
The warning condition appears inverted. The message recommends setting shouldPrefetch: false, so it should warn when shouldPrefetch is true (prefetch enabled), not when it is false/undefined. Consider reverting to if (shouldPrefetch === true) (and keep the previous destructuring default if you rely on it).
| const isRTL = rtlLocalePaths.includes(localePath) | ||
|
|
||
| entries(selectorOptions).forEach(([selector, attrs = {}]) => { | ||
| entries(selectorOptions).forEach(([selector, attrs]) => { |
There was a problem hiding this comment.
Previously attrs defaulted to {} (([selector, attrs = {}])), which avoids runtime errors if a selector is configured with an undefined/null attributes object. With the default removed, any later code that iterates over or reads from attrs as an object can throw. Restore the default or ensure selectorOptions' value type guarantees a plain object.
| entries(selectorOptions).forEach(([selector, attrs]) => { | |
| entries(selectorOptions).forEach(([selector, attrs = {}]) => { |
| import { readdirSync } from 'node:fs' | ||
| import { dirname, resolve } from 'node:path' | ||
| import { fileURLToPath } from 'node:url' | ||
| import { resolve } from 'node:path' |
There was a problem hiding this comment.
import.meta.dirname is not available in all Node.js ESM runtimes/environments (especially when supporting older Node versions or non-Node runners). Many other files in the repo use a fallback (import.meta.dirname || getDirname(import.meta.url)). Consider using the same pattern here to avoid runtime failures.
| import { tsdownConfig } from '../../scripts/tsdown.js' | ||
|
|
||
| const __dirname = dirname(fileURLToPath(import.meta.url)) | ||
| const __dirname = import.meta.dirname |
There was a problem hiding this comment.
import.meta.dirname is not available in all Node.js ESM runtimes/environments (especially when supporting older Node versions or non-Node runners). Many other files in the repo use a fallback (import.meta.dirname || getDirname(import.meta.url)). Consider using the same pattern here to avoid runtime failures.
| const parseTagName = (refs: string): string | null => { | ||
| if (!refs) return null |
There was a problem hiding this comment.
Changing the return type from string | undefined to string | null can force downstream callers to handle a new sentinel value (or introduce TS errors if they were typed for undefined). Unless you specifically need null, consider keeping the prior behavior (return / undefined) to preserve the function's effective contract.
| const parseTagName = (refs: string): string | null => { | |
| if (!refs) return null | |
| const parseTagName = (refs: string): string | undefined => { | |
| if (!refs) return |
| * IOS install hint text | ||
| * | ||
| * iOS 安装文字 | ||
| * IOS 安装文字 |
There was a problem hiding this comment.
In Apple platform terminology, 'iOS' should be lowercase-i / uppercase-OS. Consider changing 'IOS' back to 'iOS' in both the English and Chinese doc comments.
| * | ||
| * 返回计算的博客分类数据 | ||
| * @param key - Category key to get data for / 要获取数据的分类键 | ||
| * @returns Computed blog category dat / 返回计算的博客分类数据 |
There was a problem hiding this comment.
Typo in JSDoc: 'dat' should be 'data'.
| * @returns Computed blog category dat / 返回计算的博客分类数据 | |
| * @returns Computed blog category data / 返回计算的博客分类数据 |
No description provided.