super_agent_bot/dsh-superagent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: translate the nine numbered documents to Chinese and rename them

Browse Source
This commit is contained in:
Wanderingss
2026-11-03 21:10:37 +08:00
parent 526089a899
commit 32347886f6
29 changed files with 2026 additions and 2023 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/docs.spec.ts
+10 -7
View File
@@ -1,10 +1,11 @@
import { existsSync, readdirSync, readFileSync } from 'node:fs'
import { dirname, join, relative, resolve } from 'node:path'
import * as path from 'node:path'
import { basename, dirname, join, relative, resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import { describe, expect, it } from 'vitest'
const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..')
const NUMBERED = /^(\d{3})-[a-z0-9-]+\.md$/
const NUMBERED = /^(\d{3})-[\p{L}0-9-]+\.md$/u
const numbered = readdirSync(join(ROOT, 'docs')).filter(name => NUMBERED.test(name)).sort()
const entries = ['README.md', 'SETUP.md']
const documents = [...entries, ...readdirSync(join(ROOT, 'docs')).filter(name => name.endsWith('.md')).map(name => `docs/${name}`)]
@@ -13,13 +14,15 @@ function links(file: string): string[] {
return [...readFileSync(file, 'utf8').matchAll(/\]\(([^)\s]+)\)/g)].map(match => match[1]!.split('#')[0]!).filter(target => target && !/^[a-z]+:/.test(target))
}
const files = (directory: string): string[] => readdirSync(join(ROOT, directory), { recursive: true, withFileTypes: true })
.filter(entry => entry.isFile()).map(entry => relative(ROOT, join(entry.parentPath, entry.name)))
.filter(entry => entry.isFile()).map(entry => relative(ROOT, join(entry.parentPath, entry.name))
.split(path.sep)
.join('/'))
/**
* Extract repo-relative file paths from the first column of a table under `## <heading>` in `docs/007-architecture.md`.
* Extract repo-relative file paths from the first column of a table under `## <heading>` in `docs/007-架构.md`.
* Bare filenames inherit the directory of the preceding path in the same cell.
*/
function listed(heading: string): string[] {
const lines = read('docs/007-architecture.md').split('\n')
const lines = read('docs/007-架构.md').split('\n')
const start = lines.indexOf(`## ${heading}`)
const end = lines.findIndex((line, index) => index > start && line.startsWith('## '))
// The first two rows are the header and its separator.
@@ -27,7 +30,7 @@ function listed(heading: string): string[] {
return rows.flatMap(row => {
let directory = ''
return [...row.split('|')[1]!.matchAll(/`([^`]+)`/g)].map(([, name]) => {
if (!name!.includes('/')) return join(directory, name!)
if (!name!.includes('/')) return join(directory, name!).split(path.sep).join('/')
directory = dirname(name!)
return name!
})
@@ -42,7 +45,7 @@ describe('documentation', () => {
const violations = numbered.flatMap(name => links(join(ROOT, 'docs', name)).flatMap(target => {
const linked = resolve(ROOT, 'docs', target)
if (!linked.endsWith('.md')) return []
const number = NUMBERED.exec(linked.slice(linked.lastIndexOf('/') + 1))?.[1]
const number = NUMBERED.exec(basename(linked))?.[1]
return dirname(linked) === join(ROOT, 'docs') && number !== undefined && number < name.slice(0, 3) ? [] : [`${name} → ${target}`]
}))
expect(violations).toEqual([])