@tnotesjs/core 0.2.1 → 0.3.0

package/core/ReadmeGenerator.ts

@@ -0,0 +1,215 @@
+/**
+ * core/ReadmeGenerator.ts
+ *
+ * README 生成器 - 负责生成各种 README 内容
+ */
+
+import { readFileSync, writeFileSync, existsSync } from 'fs'
+
+import { TocGenerator } from './TocGenerator'
+import { ConfigManager } from '../config/ConfigManager'
+import { EOL } from '../config/constants'
+import {
+  logger,
+  parseNoteLine,
+  buildNoteLineMarkdown,
+  processEmptyLines,
+} from '../utils'
+import { createAddNumberToTitle } from '../utils'
+
+import type { NoteInfo } from '../types'
+
+/**
+ * README 生成器类
+ */
+export class ReadmeGenerator {
+  private tocGenerator: TocGenerator
+  private configManager: ConfigManager
+
+  constructor() {
+    this.tocGenerator = new TocGenerator()
+    this.configManager = ConfigManager.getInstance()
+  }
+
+  /**
+   * 更新笔记 README
+   * @param noteInfo - 笔记信息
+   */
+  updateNoteReadme(noteInfo: NoteInfo): void {
+    if (!noteInfo.config) {
+      logger.warn(`笔记 ${noteInfo.dirName} 缺少配置文件`)
+      return
+    }
+
+    const content = readFileSync(noteInfo.readmePath, 'utf-8')
+
+    // 跳过空内容（可能是其他进程写入时的 truncate 中间状态）
+    if (content.length === 0) return
+
+    const lines = content.split(EOL)
+
+    const repoName = this.configManager.get('repoName')
+    this.tocGenerator.updateNoteToc(
+      noteInfo.index,
+      lines,
+      noteInfo.config,
+      repoName,
+    )
+
+    const updatedContent = lines.join(EOL)
+    writeFileSync(noteInfo.readmePath, updatedContent, 'utf-8')
+  }
+
+  /**
+   * 更新首页 README
+   * 更新笔记链接的状态标记（[x] 或 [ ]），同时更新 TOC 区域
+   * @param notes - 笔记信息数组
+   * @param homeReadmePath - 首页 README 路径
+   */
+  updateHomeReadme(notes: NoteInfo[], homeReadmePath: string): void {
+    if (!existsSync(homeReadmePath)) {
+      logger.error(`根目录下的 README.md 文件未找到：${homeReadmePath}`)
+      return
+    }
+
+    const content = readFileSync(homeReadmePath, 'utf-8')
+    const lines = content.split(EOL)
+
+    // 创建笔记配置映射，以笔记索引为键
+    const noteByIndexMap = new Map<string, NoteInfo>()
+    for (const note of notes) {
+      noteByIndexMap.set(note.index, note)
+    }
+
+    // 获取仓库信息
+    const repoOwner = this.configManager.get('author')
+    const repoName = this.configManager.get('repoName')
+
+    // 跟踪已存在的笔记索引和要移除的行
+    const existingNoteIndexes = new Set<string>()
+    const linesToRemove = new Set<number>()
+
+    // 更新笔记链接的状态标记
+    const titles: string[] = []
+    const titlesNotesCount: number[] = []
+    let inTocRegion = false
+    let currentNoteCount = 0
+
+    // 标题编号器（用于自动更新二级和三级标题前边儿的编号）
+    const addNumberToTitle = createAddNumberToTitle()
+    const numberedHeaders = ['## ', '### ']
+
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i]
+
+      // 跳过 TOC region (后面会重新生成)
+      if (line.includes('<!-- region:toc -->')) {
+        inTocRegion = true
+        continue
+      }
+      if (line.includes('<!-- endregion:toc -->')) {
+        inTocRegion = false
+        continue
+      }
+      if (inTocRegion) {
+        continue
+      }
+
+      // 使用公共方法解析笔记链接
+      const parsed = parseNoteLine(line)
+      if (parsed.isMatch && parsed.noteIndex) {
+        const note = noteByIndexMap.get(parsed.noteIndex)
+
+        if (!note) {
+          // 笔记不存在，标记为移除
+          linesToRemove.add(i)
+          logger.warn(`移除不存在的笔记: ${parsed.noteIndex}`)
+          continue
+        }
+
+        existingNoteIndexes.add(parsed.noteIndex)
+        lines[i] = buildNoteLineMarkdown(note, repoOwner, repoName)
+        currentNoteCount++
+        continue
+      }
+
+      // 匹配标题: ## xxx 或 ### xxx
+      const titleMatch = line.match(/^(#{2,})\s+(.+)$/)
+      if (titleMatch) {
+        // 检查是否是需要编号的标题（2~3 级）
+        const isNumberedHeader = numberedHeaders.some((header) =>
+          line.startsWith(header),
+        )
+
+        if (isNumberedHeader) {
+          // 自动添加编号
+          const [numberedTitle] = addNumberToTitle(line)
+          lines[i] = numberedTitle
+
+          // 保存上一个标题的笔记数量
+          if (titles.length > 0) {
+            titlesNotesCount.push(currentNoteCount)
+          }
+
+          titles.push(numberedTitle)
+          currentNoteCount = 0
+        } else {
+          // 其他级别的标题，不添加编号
+          // 保存上一个标题的笔记数量
+          if (titles.length > 0) {
+            titlesNotesCount.push(currentNoteCount)
+          }
+
+          titles.push(line)
+          currentNoteCount = 0
+        }
+      }
+    }
+
+    // 移除不存在的笔记（从后往前删除，避免索引问题）
+    const sortedLinesToRemove = Array.from(linesToRemove).sort((a, b) => b - a)
+    for (const lineIndex of sortedLinesToRemove) {
+      lines.splice(lineIndex, 1)
+      if (currentNoteCount > 0) {
+        currentNoteCount--
+      }
+    }
+
+    // 查找缺失的笔记（在真实目录中存在但 README 中不存在）
+    const missingNotes: NoteInfo[] = []
+    for (const note of notes) {
+      if (!existingNoteIndexes.has(note.index)) {
+        missingNotes.push(note)
+      }
+    }
+
+    // 将缺失的笔记添加到结尾
+    if (missingNotes.length > 0) {
+      logger.info(`添加 ${missingNotes.length} 篇缺失的笔记到 README`)
+
+      // 按笔记索引排序
+      missingNotes.sort((a, b) => a.index.localeCompare(b.index))
+
+      for (const note of missingNotes) {
+        const noteLine = buildNoteLineMarkdown(note, repoOwner, repoName)
+        lines.push(noteLine)
+        currentNoteCount++
+      }
+    }
+
+    // 保存最后一个标题的笔记数量
+    if (titles.length > 0) {
+      titlesNotesCount.push(currentNoteCount)
+    }
+
+    // 更新 TOC 区域
+    this.tocGenerator.updateHomeToc(lines, titles, titlesNotesCount)
+
+    const processedLines = processEmptyLines(lines)
+
+    const updatedContent = processedLines.join(EOL)
+    writeFileSync(homeReadmePath, updatedContent, 'utf-8')
+
+    logger.info('已更新首页 README')
+  }
+}

package/core/TocGenerator.ts

@@ -0,0 +1,212 @@
+/**
+ * core/TocGenerator.ts
+ *
+ * 目录生成器 - 负责生成各种目录（TOC）
+ */
+
+import { EOL } from '../config/constants'
+import {
+  generateToc as generateTocUtil,
+  createAddNumberToTitle,
+} from '../utils'
+
+import type { NoteConfig } from '../types'
+
+// URL 常量
+const BILIBILI_VIDEO_BASE_URL = 'https://www.bilibili.com/video/'
+const TNOTES_YUQUE_BASE_URL = 'https://www.yuque.com/tdahuyou/tnotes.yuque/'
+
+// 目录开始和结束标记
+const NOTES_TOC_START_TAG = '<!-- region:toc -->'
+const NOTES_TOC_END_TAG = '<!-- endregion:toc -->'
+
+/**
+ * 目录生成器类
+ */
+export class TocGenerator {
+  /**
+   * 更新笔记目录
+   * @param noteIndex - 笔记索引
+   * @param lines - 笔记内容行数组
+   * @param noteConfig - 笔记配置
+   * @param repoName - 仓库名称
+   */
+  updateNoteToc(
+    noteIndex: string,
+    lines: string[],
+    noteConfig: NoteConfig,
+    repoName: string,
+  ): void {
+    let startLineIdx = -1,
+      endLineIdx = -1
+    lines.forEach((line, idx) => {
+      if (line.startsWith(NOTES_TOC_START_TAG)) startLineIdx = idx
+      if (line.startsWith(NOTES_TOC_END_TAG)) endLineIdx = idx
+    })
+    if (startLineIdx === -1 || endLineIdx === -1) return
+
+    const titles: string[] = []
+    const numberedHeaders = ['## ', '### '] // 2~3 级标题需要编号
+    const unnumberedHeaders = ['#### ', '##### ', '###### '] // 4~6 级标题不需要编号
+    const addNumberToTitle = createAddNumberToTitle()
+
+    // 代码块检测状态
+    let inCodeBlock = false
+    let inHtmlComment = false
+
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i]
+
+      // 检测代码块边界（``` 或 ~~~）
+      if (line.trim().startsWith('```') || line.trim().startsWith('~~~')) {
+        inCodeBlock = !inCodeBlock
+        continue
+      }
+
+      // 检测 HTML 注释边界
+      if (line.trim().startsWith('<!--')) {
+        inHtmlComment = true
+      }
+      if (line.trim().includes('-->')) {
+        inHtmlComment = false
+        continue
+      }
+
+      // 跳过代码块和 HTML 注释内的内容
+      if (inCodeBlock || inHtmlComment) {
+        continue
+      }
+
+      // 检查是否是需要编号的标题（2~3 级）
+      const isNumberedHeader = numberedHeaders.some((header) =>
+        line.startsWith(header),
+      )
+      // 检查是否是不需要编号的标题（4~6 级）
+      const isUnnumberedHeader = unnumberedHeaders.some((header) =>
+        line.startsWith(header),
+      )
+
+      if (isNumberedHeader) {
+        const [numberedTitle] = addNumberToTitle(line)
+        titles.push(numberedTitle)
+        lines[i] = numberedTitle // 更新原行内容（添加编号）
+      } else if (isUnnumberedHeader) {
+        // 移除可能存在的旧编号
+        const match = line.match(/^(#+)\s*(\d+(\.\d+)*\.\s*)?(.*)/)
+        if (match) {
+          const headerSymbol = match[1]
+          const plainTitle = match[4]
+          const cleanTitle = `${headerSymbol} ${plainTitle}`
+          titles.push(cleanTitle)
+          lines[i] = cleanTitle // 更新原行内容（移除编号）
+        } else {
+          titles.push(line)
+        }
+      }
+    }
+
+    const toc = generateTocUtil(titles)
+    const bilibiliTOCItems: string[] = []
+    const tnotesTOCItems: string[] = []
+    const yuqueTOCItems: string[] = []
+
+    if (noteConfig) {
+      if (noteConfig.bilibili.length > 0) {
+        noteConfig.bilibili.forEach((bvid, i) => {
+          bilibiliTOCItems.push(
+            `  - [bilibili.${repoName}.${noteIndex}.${i + 1}](${
+              BILIBILI_VIDEO_BASE_URL + bvid
+            })`,
+          )
+        })
+      }
+      if (noteConfig.tnotes && noteConfig.tnotes.length > 0) {
+        // 生成相关知识库标题和链接列表
+        tnotesTOCItems.push(
+          `- [📒 TNotes（相关知识库）](https://tnotesjs.github.io/TNotes/)`,
+        )
+        noteConfig.tnotes.forEach((repoName) => {
+          tnotesTOCItems.push(
+            `  - [TNotes.${repoName}](https://tnotesjs.github.io/TNotes.${repoName}/)`,
+          )
+        })
+      }
+      if (noteConfig.yuque.length > 0) {
+        noteConfig.yuque.forEach((slug) => {
+          yuqueTOCItems.push(
+            `  - [TNotes.yuque.${repoName.replace(
+              'TNotes.',
+              '',
+            )}.${noteIndex}](${TNOTES_YUQUE_BASE_URL + slug})`,
+          )
+        })
+      }
+    }
+
+    const insertTocItems: string[] = []
+    const hasExternalResources =
+      bilibiliTOCItems.length > 0 ||
+      tnotesTOCItems.length > 0 ||
+      yuqueTOCItems.length > 0
+
+    if (hasExternalResources) {
+      insertTocItems.push('::: details 📚 相关资源', '')
+
+      if (bilibiliTOCItems.length > 0) {
+        insertTocItems.push(
+          `- [📺 bilibili（笔记视频资源）](https://space.bilibili.com/407241004)`,
+          ...bilibiliTOCItems,
+        )
+      }
+
+      if (tnotesTOCItems.length > 0) {
+        insertTocItems.push(...tnotesTOCItems)
+      }
+
+      if (yuqueTOCItems.length > 0) {
+        insertTocItems.push(
+          `- [📂 TNotes.yuque（笔记附件资源）](${TNOTES_YUQUE_BASE_URL})`,
+          ...yuqueTOCItems,
+        )
+      }
+
+      insertTocItems.push('', ':::', '')
+    }
+
+    lines.splice(
+      startLineIdx + 1,
+      endLineIdx - startLineIdx - 1,
+      '',
+      ...insertTocItems,
+      ...toc.replace(new RegExp(`^${EOL}`), '').split(EOL),
+    )
+  }
+
+  /**
+   * 更新首页目录
+   * @param lines - 首页内容行数组
+   * @param titles - 标题数组
+  * @param _titlesNotesCount - 每个标题下的笔记数量
+   */
+  updateHomeToc(
+    lines: string[],
+    titles: string[],
+    _titlesNotesCount: number[],
+  ): void {
+    let startLineIdx = -1,
+      endLineIdx = -1
+    lines.forEach((line, idx) => {
+      if (line.startsWith(NOTES_TOC_START_TAG)) startLineIdx = idx
+      if (line.startsWith(NOTES_TOC_END_TAG)) endLineIdx = idx
+    })
+    if (startLineIdx === -1 || endLineIdx === -1) return
+
+    const toc = generateTocUtil(titles)
+
+    lines.splice(
+      startLineIdx + 1,
+      endLineIdx - startLineIdx - 1,
+      ...toc.split(EOL),
+    )
+  }
+}

package/core/index.ts

@@ -0,0 +1,11 @@
+/**
+ * core/index.ts
+ *
+ * Core 层统一导出
+ */
+
+export { NoteManager } from './NoteManager'
+export { NoteIndexCache } from './NoteIndexCache'
+export { ReadmeGenerator } from './ReadmeGenerator'
+export { GitManager } from './GitManager'
+export { ProcessManager } from './ProcessManager'

package/dist/{chunk-5Y5IYS6C.js → chunk-UJG3UU5X.js}

@@ -32,10 +32,7 @@ function getDefaultConfig(repoName) {
       title: cleanName,
       completed_notes_count: {},
       details: `${name} \u77E5\u8BC6\u5E93`,
-      link: `https://tnotesjs.github.io/${name}/`,
-      created_at: Date.now(),
-      updated_at: Date.now(),
-      days_since_birth: 0
+      link: `https://tnotesjs.github.io/${name}/`
     },
     // 端口配置（根据仓库名生成）
     port: 8e3,
@@ -86,11 +83,29 @@ function mergeConfig(target, source) {
   }
   return result;
 }
+var DEPRECATED_ROOT_ITEM_FIELDS = [
+  "created_at",
+  "updated_at",
+  "days_since_birth"
+];
+function stripDeprecatedRootItemFields(rootItem) {
+  let stripped = false;
+  for (const key of DEPRECATED_ROOT_ITEM_FIELDS) {
+    if (key in rootItem) {
+      delete rootItem[key];
+      stripped = true;
+    }
+  }
+  return stripped;
+}
 function validateAndCompleteConfig(config) {
   const repoName = config.repoName || "TNotes.default";
   const defaultConfig = getDefaultConfig(repoName);
   const mergedConfig = mergeConfig(config, defaultConfig);
-  const modified = JSON.stringify(config) !== JSON.stringify(mergedConfig);
+  const rootItem = mergedConfig.root_item || {};
+  const stripped = stripDeprecatedRootItemFields(rootItem);
+  mergedConfig.root_item = rootItem;
+  const modified = stripped || JSON.stringify(config) !== JSON.stringify(mergedConfig);
   return {
     config: mergedConfig,
     modified
@@ -195,6 +210,7 @@ function getConfigManager() {
 
 export {
   getDefaultConfig,
+  stripDeprecatedRootItemFields,
   ConfigManager,
   getConfigManager
 };