chore: prettier config

.vitepress/config.mts

@@ -1,6 +1,6 @@
 import { defineConfig } from 'vitepress'
-import { algolia, head, nav, sidebar, markdown, socialLinks } from './configs'
 import { groupIconVitePlugin } from 'vitepress-plugin-group-icons'
+import { algolia, head, markdown, nav, sidebar, socialLinks } from './configs'
 
 // 导出默认配置
 export default defineConfig({

.vitepress/configs/index.ts

@@ -1,7 +1,7 @@
 export * from './algolia'
 export * from './head'
+export * from './markdown'
 export * from './nav'
 export * from './sidebar'
-export * from './table'
 export * from './socialLinks'
-export * from './markdown'
+export * from './table'

.vitepress/configs/markdown.ts

@@ -1,10 +1,10 @@
-import type { MarkdownOptions } from 'vitepress'
+import { figure } from '@mdit/plugin-figure'
 import { footnote } from '@mdit/plugin-footnote'
-import { tasklist } from '@mdit/plugin-tasklist'
 import { imgSize } from '@mdit/plugin-img-size'
-import { figure } from '@mdit/plugin-figure'
-import { table } from './index.ts'
+import { tasklist } from '@mdit/plugin-tasklist'
+import type { MarkdownOptions } from 'vitepress'
 import { groupIconMdPlugin } from 'vitepress-plugin-group-icons'
+import { table } from './index.ts'
 
 export const markdown: MarkdownOptions = {
   theme: { light: 'one-light', dark: 'dracula-soft' },

.vitepress/theme/index.ts

@@ -1,26 +1,26 @@
-import DefaultTheme from 'vitepress/theme'
 import { useRoute } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
 import { h } from 'vue'
 
-import imageViewer from 'vitepress-plugin-image-viewer'
 import {
+  Announcement,
+  DocAsideLogo,
   DocBox,
-  DocLinks,
   DocBoxCube,
+  DocLinks,
   DocVideoLink,
-  Announcement,
-  DocAsideLogo,
-  HomeUnderline,
   HomeFooter,
-  Twikoo,
+  HomeUnderline,
   ShareButton,
+  Twikoo,
   googleAnalytics,
   umamiAnalytics
 } from '@theojs/lumen'
-import { Aside_Data, Footer_Data, Twikoo_Data } from '../data'
 import '@theojs/lumen/theme'
 import 'viewerjs/dist/viewer.min.css'
 import 'virtual:group-icons.css'
+import imageViewer from 'vitepress-plugin-image-viewer'
+import { Aside_Data, Footer_Data, Twikoo_Data } from '../data'
 
 export default {
   extends: DefaultTheme,

content/code/giscus.ts

@@ -1,7 +1,7 @@
 // .vitepress/theme/index.js
-import DefaultTheme from 'vitepress/theme'
-import giscusTalk from 'vitepress-plugin-comment-with-giscus'
 import { useData, useRoute } from 'vitepress'
+import giscusTalk from 'vitepress-plugin-comment-with-giscus'
+import DefaultTheme from 'vitepress/theme'
 export default {
   ...DefaultTheme,
   enhanceApp(ctx) {

content/fe/md.md

@@ -674,9 +674,7 @@ const line4 = 'This is line 4'
 ::: code-group
 
 ```js [config.js]
-/**
- * @type {import('vitepress').UserConfig}
- */
+/** @type {import('vitepress').UserConfig} */
 const config = {
   // ...
 }
@@ -701,9 +699,7 @@ export default config
 ::: code-group
 
 ```js [config.js]
-/**
- * @type {import('vitepress').UserConfig}
- */
+/** @type {import('vitepress').UserConfig} */
 const config = {
   // ...
 }

content/notes/prettier.md

@@ -6,33 +6,42 @@ head:
       content: 记录为项目添加 Prettier 格式化代码的过程
 ---
 
-## 安装 Prettier
+## 安装 Prettier 及插件
 
 ::: code-group
 
 ```shell [pnpm]
-pnpm add --save-dev --save-exact prettier
+pnpm add --save-dev --save-exact prettier prettier-plugin-jsdoc prettier-plugin-organize-imports prettier-plugin-packagejson
 ```
 
 ```shell [npm]
-npm install --save-dev --save-exact prettier
+npm install --save-dev --save-exact prettier prettier-plugin-jsdoc prettier-plugin-organize-imports prettier-plugin-packagejson
 ```
 
 ```shell [yarn]
-yarn add --dev --exact prettier
+yarn add --dev --exact prettier prettier-plugin-jsdoc prettier-plugin-organize-imports prettier-plugin-packagejson
 ```
 
 :::
 
-## 创建 Prettier 配置文件
+## Prettier 配置
 
-新建 `.prettierrc.yml` 配置如下
+在 `package.json` 中配置 Prettier
 
-```yaml
-semi: false
-singleQuote: true
-printWidth: 80
-trailingComma: none
+```json
+{
+  "prettier": {
+    "plugins": [
+      "prettier-plugin-organize-imports",
+      "prettier-plugin-packagejson",
+      "prettier-plugin-jsdoc"
+    ],
+    "printWidth": 80,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none"
+  }
+}
 ```
 
 ## 创建 Prettier 忽略文件

package.json

@@ -1,15 +1,29 @@
 {
   "scripts": {
-    "dev": "vitepress dev",
     "build": "vitepress build",
-    "preview": "vitepress preview",
+    "dev": "vitepress dev",
     "format": "prettier --write .",
-    "format:cheak": "prettier --check ."
+    "format:cheak": "prettier --check .",
+    "preview": "vitepress preview"
   },
-  "devDependencies": {
-    "prettier": "3.4.2",
-    "simple-git-hooks": "^2.11.1",
-    "vitepress": "^1.5.0"
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": [
+      "prettier --write --ignore-unknown"
+    ]
+  },
+  "prettier": {
+    "plugins": [
+      "prettier-plugin-organize-imports",
+      "prettier-plugin-packagejson",
+      "prettier-plugin-jsdoc"
+    ],
+    "printWidth": 80,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none"
   },
   "dependencies": {
     "@mdit/plugin-figure": "^0.14.0",
@@ -23,19 +37,13 @@
     "vitepress-plugin-image-viewer": "^1.1.5",
     "vue": "^3.5.13"
   },
-  "prettier": {
-    "semi": false,
-    "singleQuote": true,
-    "printWidth": 80,
-    "trailingComma": "none"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged"
-  },
-  "lint-staged": {
-    "*": [
-      "prettier --write --ignore-unknown"
-    ]
+  "devDependencies": {
+    "prettier": "3.4.2",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "prettier-plugin-packagejson": "^2.5.6",
+    "simple-git-hooks": "^2.11.1",
+    "vitepress": "^1.5.0"
   },
   "packageManager": "[email protected]"
 }