chore(workflow): 集成README版本信息自动更新脚本

- 在自动更新工作流中增加运行update-readme-version脚本步骤
- 修改提交操作以同时包含package.json和README.md的变更
- 在package.json添加update-readme-version命令入口
- 新增scripts目录及update-readme-version.ts脚本实现版本同步
- README.md添加版本占位符用于动态更新展示最新数据版本
- 编写测试确保包导出项与快照一致（暂未启用）

Author: Drswith

.github/workflows/auto-update.yml

@@ -89,10 +89,10 @@ jobs:
             usb.ids.version.json
           retention-days: 30
 
-      - name: Update package.json version
+      - name: Update package.json version and README
         if: steps.check-update.outputs.skip != 'true'
         run: |
-          # 从 usb.ids.version.json 获取版本号并去掉 v 前缀
+          # 从 usb.ids.version.json 获取版本号
           NEW_VERSION=$(node -p "require('./usb.ids.version.json').version.replace(/^v/, '')")
           echo "New version: $NEW_VERSION"
 
@@ -104,13 +104,20 @@ jobs:
             fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2) + '\n');
           "
 
+          # 使用专门的脚本更新 README.md 版本信息
+          pnpm run update-readme-version
+
           # 配置 git 用户信息
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
 
           # 提交更改
-          git add package.json
-          git commit -m "chore: update to version $NEW_VERSION"
+          git add package.json README.md
+          git commit -m "chore: update to version $NEW_VERSION
+
+          - Updated package.json version to $NEW_VERSION
+          - Updated README.md with latest version info
+          - Data updated automatically"
 
       - name: Create and push tag
         if: steps.check-update.outputs.skip != 'true'

README.md

@@ -6,6 +6,14 @@
 
 [![GitHub Pages](https://img.shields.io/github/actions/workflow/status/Drswith/usb.ids/github-pages.yml?label=github%20pages)](https://github.com/Drswith/usb.ids/actions/workflows/github-pages.yml)
 
+<!-- START VERSION PLACEHOLDER -->
+> **📦 Latest Release**
+> **Version:** `1.0.1756734426891`
+> **Updated:** `2025-09-01 13:47:06 UTC`
+> **Status:** ✅ Auto-updated daily
+
+<!-- END VERSION PLACEHOLDER -->
+
 An automated USB device ID database project that provides a CLI tool and data files. It fetches the latest USB.IDS data every 24 hours and publishes updated data files to npm.
 
 ## 🚀 Features

package.json

@@ -58,7 +58,8 @@
     "typecheck": "tsc --noEmit",
     "prepare": "simple-git-hooks",
     "bumpp": "bumpp",
-    "lint-staged": "lint-staged"
+    "lint-staged": "lint-staged",
+    "update-readme-version": "tsx scripts/update-readme-version.ts"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^4.2.1",

scripts/README.md

@@ -0,0 +1,73 @@
+# Scripts Directory
+
+This directory contains utility scripts for the USB.IDS project. Each script serves a specific purpose in the project's automation and maintenance workflow.
+
+## Available Scripts
+
+### `update-readme-version.ts`
+
+Updates the version information in the project's README.md file based on data from `usb.ids.version.json`.
+
+#### Purpose
+Synchronizes the version information displayed in README.md with the actual data version to ensure documentation accuracy.
+
+#### Usage
+
+```bash
+# Run using npm script (recommended)
+pnpm run update-readme-version
+
+# Or run directly with tsx
+tsx scripts/update-readme-version.ts
+```
+
+#### What it does
+
+1. Uses `loadVersionInfo()` from `src/core.ts` to read version data
+2. Locates the version placeholder markers in README.md
+3. Updates the version block with new information using proper Markdown formatting
+4. Provides detailed logging using the project's logger utility
+
+#### Key Features
+
+- **TypeScript Support**: Written in TypeScript for type safety
+- **Code Reuse**: Leverages existing functions from `src/core.ts`, `src/config.ts`, and `src/utils.ts`
+- **ES Module Compatible**: Properly handles ES module imports and execution detection
+- **Robust Error Handling**: Comprehensive error checking with helpful messages
+- **Standardized Logging**: Uses the project's logger utility for consistent output formatting
+- **Detailed Statistics**: Shows version, update time, vendor count, and device count
+
+#### Requirements
+
+- `usb.ids.version.json` must exist in the project root
+- README.md must contain the version placeholders:
+  ```markdown
+  <!-- START VERSION PLACEHOLDER -->
+  <!-- END VERSION PLACEHOLDER -->
+  ```
+- TypeScript dependencies (`tsx`) must be installed
+
+#### Output Format
+
+The script updates README.md with a styled version block:
+
+```markdown
+> **📦 Latest Release**
+> **Version:** `1.0.xxxxx`
+> **Updated:** `YYYY-MM-DD HH:MM:SS UTC`
+> **Status:** ✅ Auto-updated daily
+```
+
+---
+
+## Script Development Guidelines
+
+When adding new scripts to this directory:
+
+1. **Use TypeScript**: All scripts should be written in TypeScript for type safety
+2. **Reuse Existing Code**: Leverage functions from `src/` modules instead of reimplementing
+3. **Follow Naming Convention**: Use descriptive kebab-case names ending with `.ts`
+4. **Add Documentation**: Update this README.md with script description and usage
+5. **Use Project Logger**: Use `logger` from `src/utils.ts` for consistent output formatting
+6. **Include npm Script**: Add corresponding script entry in `package.json`
+7. **Handle Errors Gracefully**: Provide helpful error messages and proper exit codes

scripts/update-readme-version.ts

@@ -0,0 +1,96 @@
+#!/usr/bin/env tsx
+
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { USB_IDS_VERSION_JSON_FILE } from '../src/config.js'
+import { loadVersionInfo } from '../src/core.js'
+import { logger } from '../src/utils.js'
+
+// ES module 中获取当前文件路径
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+/**
+ * 更新 README.md 中的版本信息
+ * 从 usb.ids.version.json 读取版本信息并更新到 README.md 的指定位置
+ */
+function updateReadmeVersion(): void {
+  try {
+    const root = process.cwd()
+
+    // 使用 src 中的函数读取版本信息
+    const versionFilePath = path.join(root, USB_IDS_VERSION_JSON_FILE)
+    const versionData = loadVersionInfo(versionFilePath)
+
+    if (!versionData) {
+      logger.error(`Failed to load version info from ${USB_IDS_VERSION_JSON_FILE}`)
+      logger.error('Please ensure the file exists and is valid JSON')
+      process.exit(1)
+    }
+
+    const version = versionData.version.replace(/^v/, '') // 移除 v 前缀
+    const updateTime = versionData.fetchTimeFormatted
+
+    logger.info(`Updating README.md with version: ${version}`)
+    logger.info(`Update time: ${updateTime}`)
+
+    // 读取 README.md 文件
+    const readmePath = path.join(root, 'README.md')
+    if (!fs.existsSync(readmePath)) {
+      logger.error('README.md not found')
+      process.exit(1)
+    }
+
+    const readmeContent = fs.readFileSync(readmePath, 'utf8')
+
+    // 查找版本占位符
+    const startMarker = '<!-- START VERSION PLACEHOLDER -->'
+    const endMarker = '<!-- END VERSION PLACEHOLDER -->'
+
+    const startIndex = readmeContent.indexOf(startMarker)
+    const endIndex = readmeContent.indexOf(endMarker)
+
+    if (startIndex === -1 || endIndex === -1) {
+      logger.error('Version placeholders not found in README.md')
+      logger.error('Please ensure the README.md contains:')
+      logger.error('<!-- START VERSION PLACEHOLDER -->')
+      logger.error('<!-- END VERSION PLACEHOLDER -->')
+      process.exit(1)
+    }
+
+    // 构建新的版本信息块
+    const newVersionBlock = `
+> **📦 Latest Release**  
+> **Version:** \`${version}\`  
+> **Updated:** \`${updateTime}\`  
+> **Status:** ✅ Auto-updated daily
+
+`
+
+    // 替换版本信息
+    const beforeMarker = readmeContent.substring(0, startIndex + startMarker.length)
+    const afterMarker = readmeContent.substring(endIndex)
+    const newReadmeContent = beforeMarker + newVersionBlock + afterMarker
+
+    // 写入更新后的内容
+    fs.writeFileSync(readmePath, newReadmeContent, 'utf8')
+
+    logger.success('README.md version info updated successfully')
+    logger.info(`Version: ${version}`)
+    logger.info(`Updated: ${updateTime}`)
+    logger.info(`Vendor count: ${versionData.vendorCount}`)
+    logger.info(`Device count: ${versionData.deviceCount}`)
+  }
+  catch (error) {
+    logger.error(`Failed to update README.md: ${(error as Error).message}`)
+    process.exit(1)
+  }
+}
+
+// 如果直接运行此脚本
+if (import.meta.url === `file://${process.argv[1]}`) {
+  updateReadmeVersion()
+}
+
+export { updateReadmeVersion }

tests/exports.test.ts

@@ -0,0 +1,26 @@
+import { x } from 'tinyexec'
+import { describe, expect, it } from 'vitest'
+import { getPackageExportsManifest } from 'vitest-package-exports'
+import yaml from 'yaml'
+
+// TODO: remove this when you are ready for the first release
+const IS_READY = false
+
+describe.runIf(IS_READY)('exports-snapshot', async () => {
+  const packages: { name: string, path: string, private?: boolean }[] = JSON.parse(
+    await x('pnpm', ['ls', '--only-projects', '-r', '--json']).then(r => r.stdout),
+  )
+
+  for (const pkg of packages) {
+    if (pkg.private)
+      continue
+    it(`${pkg.name}`, async () => {
+      const manifest = await getPackageExportsManifest({
+        importMode: 'src',
+        cwd: pkg.path,
+      })
+      await expect(yaml.stringify(manifest.exports))
+        .toMatchFileSnapshot(`./exports/${pkg.name}.yaml`)
+    })
+  }
+})