docs: add source

NelsonYong · NelsonYong · commit c40aa213cb99 · 2025-04-06T16:24:56.000+08:00
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -1,6 +1,6 @@
 {
   "no-inline-html": {
-    "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home","demo"]
+    "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home","demo","VPTeamPage","VPTeamPageTitle","VPTeamMembers","VPTeamPageSection"]
   },
   "MD013": false,
   "MD041": false
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
@@ -11,11 +11,11 @@ function siderbarUseRequestPlugin(): DefaultTheme.SidebarItem[] {
       items: [
         {
           text: 'global Fetching',
-          link: 'useRequest/plugins/fetchsing/',
+          link: 'useRequest/plugins/fetchsing',
         },
         {
           text: 'broadcastChannel',
-          link: 'useRequest/plugins/broadcastChannel/',
+          link: 'useRequest/plugins/broadcastChannel',
         }]
     }
   ]
@@ -140,7 +140,7 @@ export const en = defineConfig({
     },
 
     editLink: {
-      pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
+      pattern: 'https://github.com/InhiblabCore/vue-hooks-plus/edit/master/docs/:path',
       text: 'Edit this page on GitHub'
     },
 
@@ -191,6 +191,7 @@ export function sidebarHooks(): DefaultTheme.SidebarItem[] {
       text: 'State',
       items: [
         { text: 'useBoolean', link: 'useBoolean' },
+        { text: "useControlledState", link: "useControlledState" },
         { text: 'useImmer', link: 'useImmer' },
         { text: 'useUrlState', link: 'useUrlState' },
         { text: 'useFormatResult', link: 'useFormatResult' },
diff --git a/docs/.vitepress/config/shared.ts b/docs/.vitepress/config/shared.ts
@@ -7,6 +7,7 @@ import {
 import { search as zhSearch } from './zh'
 
 import { applyMdPlugin } from '../plugins/applyMdPlugin'
+import { applyFooterLinkPlugin } from '../plugins/applyFooterLinkPlugin'
 
 
 export const shared = defineConfig({
@@ -32,6 +33,7 @@ export const shared = defineConfig({
     ],
     config(md) {
       applyMdPlugin(md)
+      // md.renderer.rules.softbreak
       const fence = md.renderer.rules.fence!
       md.renderer.rules.fence = function (tokens, idx, options, env, self) {
         const { localeIndex = 'root' } = env
@@ -120,6 +122,8 @@ export const shared = defineConfig({
       }
     },
     plugins: [
+      // @ts-ignore
+      applyFooterLinkPlugin(),
       // @ts-ignore
       groupIconVitePlugin({
         customIcon: {
diff --git a/docs/.vitepress/config/zh.ts b/docs/.vitepress/config/zh.ts
@@ -142,7 +142,7 @@ export const zh = defineConfig({
     },
 
     editLink: {
-      pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
+      pattern: 'https://github.com/InhiblabCore/vue-hooks-plus/edit/master/docs/:path',
       text: '在 GitHub 上编辑此页面'
     },
 
diff --git a/docs/.vitepress/plugins/applyFooterLinkPlugin.ts b/docs/.vitepress/plugins/applyFooterLinkPlugin.ts
@@ -0,0 +1,68 @@
+import type { Plugin } from 'vite'
+import fs from 'node:fs'
+import matter from 'gray-matter'
+
+const langTitleMap = {
+  en: {
+    document: 'Document',
+    demo: 'Demo',
+    source: 'Source'
+  },
+  zh: {
+    document: '文档',
+    demo: '示例',
+    source: '源码'
+  }
+}
+
+export function applyFooterLinkPlugin(): Plugin {
+  return {
+    name: 'vitepress-md-frontmatter-append',
+    enforce: 'pre', // 确保在默认插件前执行
+
+    load(id) {
+      console.log("id", id);
+
+      if (!id.endsWith('.md')) return
+
+      const rawContent = fs.readFileSync(id, 'utf-8')
+
+      const lang = id.includes('/zh/') ? 'zh' : 'en'
+      const { data: frontmatter } = matter(rawContent)
+      const mapPath = id.replace(process.cwd() + '/docs', '')
+
+      console.log("frontmatter", frontmatter);
+
+      if (!frontmatter?.map?.path || frontmatter?.source?.show === false) {
+        return
+      }
+
+      // document
+      const isShowDemo = frontmatter?.source?.showDemo ?? true
+      const documentUrl = `https://github.com/InhiblabCore/vue-hooks-plus/blob/master/docs/${mapPath}`
+      const document = `[${langTitleMap[lang].document}](${documentUrl})`
+
+      // demo
+      const srcMatches = [...rawContent.matchAll(/<demo[^>]*src="([^"]+)"/g)];
+      const srcValues = srcMatches.map(match => match[1]);
+      const isOneDemo = srcValues.length && srcValues.length === 1
+      const demoUrl = `https://github.com/InhiblabCore/vue-hooks-plus/blob/master/docs/demo/${isOneDemo ? srcValues[0] : srcValues[0]?.split?.('/')[0]}`
+      const demo = isShowDemo ? `[${langTitleMap[lang].demo}](${demoUrl})` : ''
+
+      // source
+      const isShowSource = frontmatter?.source?.showSource ?? true
+      const sourceMapPath = frontmatter?.source?.path ? frontmatter.source.path : ''
+      const sourceUrl = sourceMapPath ? sourceMapPath : frontmatter?.map?.path ? `https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src${frontmatter.map.path}` : `https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages`
+      const source = isShowSource ? `[${langTitleMap[lang].source}](${sourceUrl})` : ''
+
+      const appentFooter = `
+       \n\n## Source
+       \n\n${source ? `${source} ·` : ""} ${`${document}`} ${demo ? `· ${demo}` : ""}
+      `
+      return {
+        code: rawContent + appentFooter,
+        map: null
+      }
+    }
+  }
+}
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -10,10 +10,9 @@ import { useRequestDevToolsPlugin } from 'vue-hooks-plus'
 import { createPinia } from 'pinia'
 
 const store = createPinia()
-
 export default {
   ...Theme,
-  enhanceApp({ app, router, siteData }) {
+  enhanceApp({ app }) {
     app.use(store)
     app.use(useRequestDevToolsPlugin)
     app.component('demo', DemoBlock)
diff --git a/docs/contributors.ts b/docs/contributors.ts
@@ -0,0 +1,52 @@
+
+type Contributors = {
+  name: string
+  avatar?: string
+  title: "Creator" | "Core developer" | "Contributor",
+  desc?: string
+  org?: string
+  orgLink?: string
+  links: {
+    icon: "github" | "twitter" | "discord",
+    link: string
+  }[]
+}
+export const members: Contributors[] = [
+  {
+    avatar: "https://github.com/NelsonYong.png",
+    name: 'YongGit',
+    title: 'Creator',
+    desc: "VueHooks Plus's Author",
+    org: 'InhiblabCore',
+    orgLink: "https://github.com/InhiblabCore",
+    links: [
+      { icon: 'github', link: 'https://github.com/NelsonYong' },
+      { icon: 'twitter', link: 'https://x.com/Yong_Git' },
+      {
+        icon: "discord",
+        link: "https://discord.com/invite/z5Ve5r9Kwp"
+      }
+    ]
+  }, {
+    avatar: 'https://www.github.com/hongaah.png',
+    name: 'Hazel Wei',
+    desc: "Swiftcode's Author",
+    org: 'InhiblabCore',
+    orgLink: "https://github.com/InhiblabCore",
+    title: 'Core developer',
+    links: [
+      { icon: 'github', link: 'https://github.com/hongaah' }
+    ]
+  },
+  {
+    avatar: 'https://www.github.com/XiaoDaiGua-Ray.png',
+    name: 'XiaoDaiGua Ray',
+    desc: "Tring be better～",
+    org: 'InhiblabCore',
+    orgLink: "https://github.com/InhiblabCore",
+    title: 'Core developer',
+    links: [
+      { icon: 'github', link: 'https://github.com/XiaoDaiGua-Ray' }
+    ]
+  },
+]
diff --git a/docs/en/hooks/useBoolean.md b/docs/en/hooks/useBoolean.md
@@ -8,6 +8,8 @@ path: /useBoolean
 
 A hook that elegantly manages boolean state.
 
+<!-- [[toc]] -->
+
 ## Code demonstration
 
 <demo src="useBoolean/demo.vue"
diff --git a/docs/en/hooks/useControlledState.md b/docs/en/hooks/useControlledState.md
@@ -0,0 +1 @@
+# useControlledState `^2.3.0`
diff --git a/docs/en/hooks/useDebounceFn.md b/docs/en/hooks/useDebounceFn.md
@@ -39,10 +39,10 @@ const {
 
 | Property | Description | Type | Default |
 | --- | --- | --- | --- |
-| wait | The number of milliseconds to delay. | `number` | `1000` |
-| leading | Specify invoking on the leading edge of the timeout. | `boolean` | `false` |
-| trailing | Specify invoking on the trailing edge of the timeout. | `boolean` | `true` |
-| maxWait | The maximum time func is allowed to be delayed before it’s invoked. | `number` | - |
+| wait | The number of milliseconds to delay. | `number`\|`Ref<number>` | `1000` |
+| leading | Specify invoking on the leading edge of the timeout. | `boolean`\|`Ref<boolean>` | `false` |
+| trailing | Specify invoking on the trailing edge of the timeout. | `boolean`\|`Ref<boolean>` | `true` |
+| maxWait | The maximum time func is allowed to be delayed before it’s invoked. | `number`\|`Ref<number>` | - |
 
 ## Result
 
@@ -51,3 +51,12 @@ const {
 | run      | Invode and pass parameters to fn.                      | `(...args: any[]) => any` |
 | cancel   | Cancel the invocation of currently debounced function. | `() => void`              |
 | flush    | Immediately invoke currently debounced function.       | `() => void`              |
+
+::: warning Remark
+
+- `options.wait` support dynamic changes.
+- `options.leading` support dynamic changes.
+- `options.trailing` support dynamic changes.
+- `options.maxWait` support dynamic changes.
+
+:::
diff --git a/docs/en/hooks/useRequest/formatResult.md b/docs/en/hooks/useRequest/formatResult.md
@@ -3,7 +3,7 @@ map:
   # 映射到docs的路径
   path: /useRequest/formatResult/
 source:
-  show: false
+  showSource: false
 ---
 
 # Format the request result
diff --git a/docs/en/hooks/useRequest/plugin.md b/docs/en/hooks/useRequest/plugin.md
diff --git a/docs/index.md b/docs/index.md
@@ -38,3 +38,34 @@ features:
     details: Perfect test, safe and reliable.
 ---
 
+<script setup>
+import {
+  VPTeamPage,
+  VPTeamPageTitle,
+  VPTeamMembers,
+  VPTeamPageSection
+} from 'vitepress/theme'
+
+import {members} from './contributors'
+
+
+</script>
+
+<VPTeamPage>
+  <VPTeamPageTitle>
+    <template #title>Team</template>
+    <template #lead> Vue Hooks Plus is developed and maintained by a     passionate team of Vue enthusiasts.
+    </template>
+  </VPTeamPageTitle>
+  <VPTeamMembers size="small" :members="members" />
+  <VPTeamPageSection>
+    <template #title>Contributors</template>
+    <template #members>
+      <div style="display: flex; justify-content: center;">
+        <a target="__blank" href="https://github.com/InhiblabCore/vue-hooks-plus/graphs/contributors">
+           <img src="https://contrib.rocks/image?repo=InhiblabCore/vue-hooks-plus" />
+        </a>
+      </div>
+    </template>
+  </VPTeamPageSection>
+</VPTeamPage>
diff --git a/docs/zh/hooks/useControlledState.md b/docs/zh/hooks/useControlledState.md
diff --git a/docs/zh/hooks/useRequest/formatResult.md b/docs/zh/hooks/useRequest/formatResult.md
@@ -3,7 +3,7 @@ map:
   # 映射到docs的路径
   path: /useRequest/formatResult/
 source:
-  show: false
+  showSource: false
 ---
 
 # 格式化请求数据
diff --git a/docs/zh/hooks/useRequest/plugin.md b/docs/zh/hooks/useRequest/plugin.md
diff --git a/eslint.config.js b/eslint.config.js
@@ -31,7 +31,8 @@ export default defineConfigWithVueTs([
       'import/default': 'off',
       'import/no-named-as-default': 'off',
       'import/no-named-as-default-member': 'off',
-
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/ban-ts-comment': 'off',
       'vue/attributes-order': 'off',
       'vue/one-component-per-file': 'off',
       'vue/html-closing-bracket-newline': 'off',
diff --git a/package.json b/package.json
@@ -60,6 +60,7 @@
     "fast-glob": "^3.2.12",
     "fs-extra": "^11.3.0",
     "gh-pages": "^4.0.0",
+    "gray-matter": "^4.0.3",
     "happy-dom": "^7.5.10",
     "husky": "^8.0.1",
     "kolorist": "^1.6.0",
diff --git a/packages/hooks/package.json b/packages/hooks/package.json
@@ -28,7 +28,7 @@
 	},
 	"dependencies": {
 		"@types/js-cookie": "^3.0.1",
-		"@vue/devtools-api": "^6.5.0",
+		"@vue/devtools-api": "7.7.2",
 		"js-cookie": "^3.0.1",
 		"lodash-es": "^4.17.21",
 		"screenfull": "^5.0.0"
diff --git a/packages/hooks/src/useDebounceFn/index.ts b/packages/hooks/src/useDebounceFn/index.ts
diff --git a/packages/use-request/package.json b/packages/use-request/package.json
diff --git a/packages/use-request/src/plugins/useDebouncePlugin.ts b/packages/use-request/src/plugins/useDebouncePlugin.ts
diff --git a/packages/use-request/src/plugins/useThrottlePlugin.ts b/packages/use-request/src/plugins/useThrottlePlugin.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"no-inline-html": {`
`3`		`- "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home","demo"]`
	`3`	`+ "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home","demo","VPTeamPage","VPTeamPageTitle","VPTeamMembers","VPTeamPageSection"]`
`4`	`4`	`},`
`5`	`5`	`"MD013": false,`
`6`	`6`	`"MD041": false`