create-young-proj 1.2.1 → 1.4.0

package/template-vitepress/README.md

@@ -0,0 +1,102 @@
+# template-vitepress
+
+[![](https://img.shields.io/badge/Author-BluesYoung--web-blue)](https://gitee.com/BluesYoung-web)
+
+## 本地运行
+
+::: code-group
+```bash [yarn]
+# 装依赖
+yarn
+# 运行
+yarn dev
+```
+```bash [pnpm]
+# 装依赖
+pnpm i
+# 运行
+pnpm dev
+```
+```bash [bun]
+# 装依赖
+bun i
+# 运行
+bun dev
+```
+```bash [npm]
+# 装依赖
+npm i
+# 运行
+npm run dev
+```
+:::
+
+## 到手之后需要自行调整的内容
+
+### `.vitepress/config.mts`
+
+<TodoItem>seo 相关<code ml-1>title, description</code></TodoItem>
+
+:::danger
+<TodoItem>部署相关<code ml-1>base</code></TodoItem>
+
+- 根路径部署就删掉，否则为部署的路径，**必须以 `/` 结尾**
+
+- [官方文档](https://vitepress.dev/reference/site-config#base)
+:::
+
+<TodoItem><a href="https://vitepress.dev/reference/default-theme-nav" target="_blank">顶部导航</a> <code ml-1>themeConfig -> nav</code></TodoItem>
+
+<TodoItem><a href="https://vitepress.dev/reference/default-theme-sidebar" target="_blank">侧边栏导航</a> <code ml-1>themeConfig -> sidebar</code></TodoItem>
+
+<TodoItem>替换仓库地址 <code ml-1>themeConfig -> socialLinks -> link</code></TodoItem>
+
+<TodoItem>替换仓库地址 <code ml-1>themeConfig -> editLink -> pattern</code></TodoItem>
+
+### `index.md`
+
+<TodoItem>标题及描述 <code ml-1>hero -> [name, text, tagline]</code></TodoItem>
+
+<TodoItem>快捷导航 <code ml-1>hero -> actions</code></TodoItem>
+
+<TodoItem>特性介绍 <code ml-1>features</code></TodoItem>
+
+### 首页贡献者
+
+`.vitepress/components/HomePage.vue -> teamMembers` 按需修改
+
+:::info
+如果不需要展示，将 `.vitepress/theme/index.ts -> 'home-features-after'` 这一行注释即可
+:::
+
+## 文档书写
+
+### 简介
+
+标题：`使用 # 符号表示标题，数量代表标题级别。例如：# 一级标题、## 二级标题`
+
+段落和换行：`段落之间使用空行分隔，要插入换行符，可以在行末添加两个空格`
+
+强调：`使用 * 或 _ 包围文本来斜体显示，使用两个 * 或 _ 包围文本来加粗显示。例如：*斜体文本*、**加粗文本**`
+
+列表：`使用 *、+ 或 - 开头创建无序列表，使用数字后跟句点创建有序列表。嵌套列表时缩进四个空格或一个制表符`
+
+链接：`使用 [显示文本](链接地址) 的格式创建链接。例如：[OpenAI](https://openai.com)`
+
+图片：`使用 ![替代文本](图片链接地址) 的格式插入图片。例如：![Logo](https://example.com/logo.png)`
+
+引用块：`使用 > 表示引用块。可以嵌套使用多个 > 表示多层引用`
+
+代码块：`使用三个反引号 ```` 或四个空格缩进来创建代码块。可以指定语言以进行语法高亮`
+
+水平线：`使用三个或更多连续的 -、* 或 _ 创建水平线分隔线`
+
+转义字符：`在特殊字符前添加反斜杠 \ 可以转义字符的原始含义`
+
+### 外部教程
+
+[vitepress 扩展语法](https://vitepress.dev/guide/markdown)
+
+[基础语法](https://www.markdownguide.org/basic-syntax/)
+
+[中文技术文档的写作规范——阮一峰](https://github.com/ruanyf/document-style-guide)

package/template-vitepress/_gitignore

@@ -0,0 +1,6 @@
+node_modules
+*.log
+cache
+dist
+.output
+.nitro

package/template-vitepress/_npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+strict-peer-dependencies=false

package/template-vitepress/_nvmrc

@@ -0,0 +1 @@
+20.9.0

package/template-vitepress/boot.mjs

@@ -0,0 +1,17 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-09-16 11:48:05
+ * @LastEditTime: 2023-11-09 11:59:07
+ * @Description:
+ */
+(async () => {
+  const env = process.env.DEPLOY_ENV || 'dev';
+  const listenPort = process.env.LISTEN_PORT || 3333;
+  console.log('当前环境：', env);
+  console.log('服务监听端口：', listenPort);
+
+  process.env.NITRO_PORT = listenPort;
+
+  await import('./.output/server/index.mjs');
+})();
+

package/template-vitepress/index.md

@@ -0,0 +1,53 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: 前端知识库
+  text: 知识共建，共创未来
+  tagline: 多种实用工具，满足不同需求
+  image:
+    src: https://api.iconify.design/noto:rocket.svg?color=%2312b2e7&width=320
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /newer
+    - theme: alt
+      text: 前端规范
+      link: /standards
+    - theme: alt
+      text: 常见问题及解决方案
+      link: /problems
+
+features:
+  - title: '@bluesyoung/ui-vue3-element-plus'
+    icon: <span class="i-ep-element-plus text-[#409eff]"></span>
+    details: 基于 element-plus 二次封装的常用组件库
+    link: /libs/public/ui-vue3-element-plus
+
+  - title: '@bluesyoung/http'
+    icon: <span class="i-logos-lighttpd"></span>
+    details: 基于 axios 封装的 http 请求库, 拥有完善的 TS 类型提示, 支持 web/微信小程序
+    link: /libs/public/http
+
+  - title: '@bluesyoung/utils'
+    icon: <span class="i-tabler-tools text-[#409eff]"></span>
+    details: 常用工具函数
+    link: https://gitee.com/-/ide/project/BluesYoung-web/young/edit/master/-/packages/utils/dist/index.d.ts
+
+  - title: '@bluesyoung/logger'
+    icon: <span class="i-vscode-icons-file-type-log"></span>
+    details: 基于 consola 封装的日志工具, 默认格式化为容器部署要求的格式, 并保留了扩充能力
+    link: /libs/public/logger
+  
+  - title: '@bluesyoung/rpc'
+    icon: <span class="i-simple-icons-trpc text-[#409eff]"></span>
+    details: 页面与其嵌套的 iframe 或由其打开的子页面之间进行通信
+    link: /libs/public/rpc
+
+  - title: '@bluesyoung/ui-vue3'
+    icon: <span class="i-logos-vue"></span>
+    details: 基于 vue3 + @vueuse/core 封装的组件，无额外的依赖
+    link: /libs/public/ui-vue3
+---
+

package/template-vitepress/nitro.config.ts

@@ -0,0 +1,19 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-28 11:59:56
+ * @LastEditTime: 2023-11-14 09:18:38
+ * @Description:
+ */
+export default defineNitroConfig({
+  /**
+   * 托管前端静态资源
+   */
+  serveStatic: 'node',
+  publicAssets: [
+    {
+      dir: '.vitepress/dist',
+    },
+  ],
+  preset: 'bun'
+});
+

package/template-vitepress/package.json

@@ -0,0 +1,26 @@
+{
+  "scripts": {
+    "dev": "vitepress dev",
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview",
+    "build": "vitepress build && nitropack build",
+    "postinstall": "nitropack prepare"
+  },
+  "devDependencies": {
+    "@iconify/json": "^2.2.139",
+    "@types/md5": "^2.3.5",
+    "@types/node": "20",
+    "nitropack": "^2.7.2",
+    "pathe": "^1.1.1",
+    "unocss": "^0.57.2",
+    "unplugin-vue-components": "^0.25.2",
+    "vitepress": "^1.0.0-rc.25",
+    "vue": "^3.3.8"
+  },
+  "dependencies": {
+    "c12": "^1.5.1",
+    "md5": "^2.3.0"
+  },
+  "version": "1.0.0"
+}

package/template-vitepress/plugins/init.ts

@@ -0,0 +1,204 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2023-11-10 18:02:07
+ * @LastEditTime: 2023-11-27 15:01:31
+ * @Description:
+ */
+import { resolve } from 'node:path'
+import { loadConfig } from 'c12'
+import md5 from 'md5'
+
+/**
+ * 签名
+ * @param params 参与签名的参数
+ * @param token 秘钥
+ */
+export function signFn(params: Record<string, any>, token: string) {
+  const asciiSortedIndexArr = Object.keys(params).sort()
+  let str = ''
+  const obj: Record<string, any> = {}
+  if (asciiSortedIndexArr.length > 0) {
+    for (const key of asciiSortedIndexArr) {
+      const v = params[key]
+      if (v !== null && v !== '') {
+        str += `${key}=${encodeURIComponent(v)}&`
+        obj[key] = v
+      }
+    }
+  }
+  str += `token=${token}`
+  return {
+    sign: md5(str).toUpperCase(),
+    rawValue: obj,
+  }
+}
+
+/**
+ * 服务上报
+ */
+export async function useServerReport(port: number) {
+  enum ReportURL {
+    上线 = '/register/login',
+    心跳 = '/register/heart',
+  }
+
+  const commonReq = async <T>(url: string, data: Record<string, any>, token: string) => {
+    const api_server_url
+      = process.env.NUXT_PUBLIC_API_SERVER || `http://${process.env.APIGATEHOST}`
+    const { sign, rawValue } = signFn(data, token)
+
+    console.log('🚀 ~ file: env.ts:41 ~ commonReq ~ api_server_url:', api_server_url, rawValue)
+
+    const headers = {
+      'Authorization': `Bearer ${token}`,
+      'content-type': 'application/json; charset=utf-8;',
+      'time': `${Math.floor(Date.now() / 1000)}`,
+      sign,
+    }
+
+    return $fetch<T>(`${api_server_url}${url}`, {
+      method: 'post',
+      headers,
+      body: JSON.stringify(rawValue),
+    })
+  }
+
+  /**
+   * auth token
+   */
+  let token: string
+
+  /**
+   * 登录/获取 token
+   */
+  const login = async () => {
+    const data = {
+      serverId: process.env.APP_SERVER_ID,
+      serverName: process.env.APP_SERVER_NAME,
+    }
+
+    const { data: _data } = await commonReq<{
+      code: number
+      message: string
+      data: { token: string }
+    }>('/account/v1/internal/service/get_token', data, process.env.APP_SERVER_SECERET as string)
+
+    console.log('🚀 ~ file: env.ts:73 ~ login ~ _data:', _data)
+
+    const { token } = _data
+    console.log('login success, token: ', token, '\ntime: ', new Date().toLocaleString())
+    return token
+  }
+
+  /**
+   * 获取 auth token
+   */
+  const getToken = async () => {
+    if (!token) {
+      token = await login()
+      setInterval(() => {
+        // 每 23 小时刷一次 token
+        token = ''
+      }, 1000 * 3600 * 23)
+    }
+    return token
+  }
+
+  /**
+   * 服务上线
+   */
+  const report = async (url: ReportURL) => {
+    const token = await getToken()
+    try {
+      const res = await commonReq<{
+        host: string
+        port: string | number
+        weight: number
+        expire: number
+      }>(url, { port }, token)
+
+      console.log('请求成功：', url, new Date().toLocaleString())
+      return res
+    }
+    catch (error) {
+      console.error('请求失败：', url, error)
+    }
+  }
+
+  console.log('------------------------服务登录------------------------')
+  await login()
+  console.log('--------------------------------------------------------')
+
+  console.log('------------------------服务上线------------------------')
+  const info1 = await report(ReportURL.上线)
+  console.log('🚀 ~ file: init.ts:156 ~ defineNitroPlugin ~ info', info1)
+  console.log('--------------------------------------------------------')
+
+  console.log('------------------------服务心跳上报----------------------')
+  const info2 = await report(ReportURL.心跳)
+  console.log('🚀 ~ file: init.ts:163 ~ setInterval ~ info', info2)
+  console.log('----------------------------------------------------------')
+  setInterval(async () => {
+    console.log('------------------------服务心跳上报----------------------')
+    const info = await report(ReportURL.心跳)
+    console.log('🚀 ~ file: init.ts:163 ~ setInterval ~ info', info)
+    console.log('----------------------------------------------------------')
+  }, 1e4)
+}
+
+export default defineNitroPlugin(async (nitroApp) => {
+  const env = (process.env.DEPLOY_ENV as 'dev' | 'test' | 'online') || 'dev'
+  const { config } = await loadConfig<Record<string, any>>({
+    name: env,
+    cwd: resolve(process.cwd(), 'config'),
+    defaultConfig: {
+      // 此处可以放置通用的环境变量
+      // 由于频繁修改 package.json 会浪费 docker 性能，故将版本信息放于此处
+      // 优先读取环境变量中的版本信息(自己打的 Tag)
+      NUXT_PUBLIC_CURRENT_VERSION: process.env.PROJECT_VERSION || 'v0.0.1',
+
+      // 服务秘钥，不对前端开放
+      APP_SERVER_SECERET: '我是秘钥',
+      APP_SERVER_NAME: '我是服务名称',
+      APP_SERVER_ID: '我是服务id',
+    },
+  })
+
+  for (const key in config) {
+    if (process.env[key]) {
+      console.log(
+        '系统环境变量优先: ',
+        key,
+        ' = ',
+        process.env[key],
+        ' -> ',
+        config[key],
+        ' -> ',
+        '覆盖',
+      )
+      config[key] = process.env[key]
+    }
+    else {
+      process.env[key] = config[key]
+    }
+    if (!(key.indexOf('NUXT_PUBLIC_') === 0))
+      delete config[key]
+  }
+
+  console.log('------------------------读取配置文件------------------------')
+  console.log(config)
+  console.log('-------------------------------------------------------------')
+
+  nitroApp.hooks.hook('request', (event) => {
+    const headers = event.node.req.headers
+    const path = event.node.req.url
+    console.log('path', path, 'ua', headers['user-agent'], 'x-forwarded-for', headers['x-forwarded-for'], 'x-real-ip', headers['x-real-ip'])
+  })
+
+  // 本地开发，不上报
+  if (process.env.NODE_ENV === 'development')
+    return
+
+  const port = process.env.LISTEN_PORT || 3333
+  useServerReport(+port)
+})

package/template-vitepress/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.nitro/types/tsconfig.json"
+}

package/template-vitepress/vite.config.ts

@@ -0,0 +1,66 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2023-11-08 16:35:24
+ * @LastEditTime: 2023-11-08 16:37:49
+ * @Description: 
+ */
+import fs from 'node:fs'
+import type { Plugin } from 'vite'
+import { defineConfig } from 'vite'
+import Components from 'unplugin-vue-components/vite'
+import Unocss from 'unocss/vite'
+import { presetAttributify, presetIcons, presetUno } from 'unocss'
+import { resolve } from 'pathe'
+
+export default defineConfig({
+  optimizeDeps: {
+    // vitepress is aliased with replacement `join(DIST_CLIENT_PATH, '/index')`
+    // This needs to be excluded from optimization
+    exclude: ['@vueuse/core', 'vitepress'],
+  },
+  server: {
+    host: true,
+    hmr: {
+      overlay: false,
+    },
+  },
+  plugins: [
+    Components({
+      include: [/\.vue/, /\.md/],
+      dirs: '.vitepress/components',
+      dts: '.vitepress/components.d.ts',
+    }) as Plugin,
+    Unocss({
+      shortcuts: [
+        ['btn', 'px-4 py-1 rounded inline-flex justify-center gap-2 text-white leading-30px children:mya !no-underline cursor-pointer disabled:cursor-default disabled:bg-gray-600 disabled:opacity-50'],
+      ],
+      presets: [
+        presetUno({
+          dark: 'media',
+        }),
+        presetAttributify(),
+        presetIcons({
+          scale: 1.2,
+        }),
+      ],
+    }),
+    IncludesPlugin(),
+  ],
+})
+
+function IncludesPlugin(): Plugin {
+  return {
+    name: 'include-plugin',
+    enforce: 'pre',
+    transform(code, id) {
+      let changed = false
+      code = code.replace(/\[@@include\]\((.*?)\)/, (_, url) => {
+        changed = true
+        const full = resolve(id, url)
+        return fs.readFileSync(full, 'utf-8')
+      })
+      if (changed)
+        return code
+    },
+  }
+}

package/template-uni-app/.eslintignore

@@ -1 +0,0 @@
-src/uni_modules

package/template-uni-app/.eslintrc

@@ -1,16 +0,0 @@
-{
-  "root": true,
-  "extends": "@antfu",
-  "rules": {
-    "@typescript-eslint/no-use-before-define": "off",
-    "no-console": "off",
-    "n/prefer-global/process": "off",
-    "unused-imports/no-unused-vars": "off",
-    "@typescript-eslint/ban-types": "off",
-    "vue/valid-v-model": "off",
-    "@typescript-eslint/ban-ts-comment": "off",
-    "no-throw-literal": "off",
-    "prefer-promise-reject-errors": "off",
-    "no-async-promise-executor": "off"
-  }
-}