@tnotesjs/core 0.2.1 → 0.3.0

package/README.md

@@ -69,7 +69,6 @@ export { default } from '@tnotesjs/core/vitepress/theme'
     "tn:push": "tnotes --push",
     "tn:pull": "tnotes --pull",
     "tn:create-notes": "tnotes --create-notes",
-    "tn:fix-timestamps": "tnotes --fix-timestamps",
     "tn:help": "tnotes --help",
     "tn:init-sub-repo": "tnotes --init-sub-repo"
   }

package/config/ConfigManager.ts

@@ -0,0 +1,137 @@
+/**
+ * config/ConfigManager.ts
+ *
+ * 配置管理器 - 统一管理项目配置
+ */
+import fs from 'fs'
+import path from 'path'
+
+import { validateAndCompleteConfig } from './defaultConfig'
+
+import type { TNotesConfig } from '../types'
+
+/**
+ * 配置管理器（单例模式）
+ */
+export class ConfigManager {
+  private static instance: ConfigManager
+  private config: TNotesConfig | null = null
+  private configPath: string
+  private rootPath: string
+
+  private constructor(rootPath?: string) {
+    if (rootPath) {
+      // 显式传入根路径
+      this.rootPath = rootPath
+    } else {
+      // 默认使用 process.cwd()（CLI 和 VitePress 均在项目根目录执行）
+      this.rootPath = process.cwd()
+    }
+    this.configPath = path.normalize(
+      path.resolve(this.rootPath, '.tnotes.json'),
+    )
+  }
+
+  /**
+   * 使用指定的根路径初始化配置管理器
+   *
+   * 必须在 getInstance() 之前调用（如果需要指定 rootPath）。
+   * 如果已经初始化，则忽略重复调用。
+   */
+  static init({ rootPath }: { rootPath: string }): ConfigManager {
+    if (!ConfigManager.instance) {
+      ConfigManager.instance = new ConfigManager(rootPath)
+    }
+    return ConfigManager.instance
+  }
+
+  /**
+   * 获取单例实例
+   */
+  static getInstance(): ConfigManager {
+    if (!ConfigManager.instance) {
+      ConfigManager.instance = new ConfigManager()
+    }
+    return ConfigManager.instance
+  }
+
+  /**
+   * 加载配置文件
+   */
+  loadConfig(configPath?: string): TNotesConfig {
+    if (this.config) return this.config
+
+    const path = configPath || this.configPath
+
+    if (!fs.existsSync(path)) {
+      throw new Error(`配置文件不存在: ${path}`)
+    }
+
+    const configContent = fs.readFileSync(path, 'utf-8')
+    const rawConfig = JSON.parse(configContent)
+
+    // 验证并补全配置
+    const { config: validatedConfig, modified } =
+      validateAndCompleteConfig(rawConfig)
+
+    if (modified) {
+      console.warn(`[ConfigManager] 检测到知识库配置缺失字段，已自动补全`)
+      // 写回配置文件
+      fs.writeFileSync(path, JSON.stringify(validatedConfig, null, 2), 'utf-8')
+      console.log(`[ConfigManager] 知识库配置文件已更新`)
+      console.log(`[ConfigManager] 知识库配置文件路径: ${path}`)
+    }
+
+    this.config = validatedConfig
+
+    return this.config
+  }
+
+  /**
+   * 清除内存中的配置缓存，下次 get/getAll 时重新从磁盘加载
+   */
+  clearCache(): void {
+    this.config = null
+  }
+
+  /**
+   * 获取配置项
+   */
+  get<K extends keyof TNotesConfig>(key: K): TNotesConfig[K] {
+    if (!this.config) {
+      this.loadConfig()
+    }
+    return this.config![key]
+  }
+
+  /**
+   * 获取所有配置
+   */
+  getAll(): TNotesConfig {
+    if (!this.config) {
+      this.loadConfig()
+    }
+    return this.config!
+  }
+
+  /**
+   * 获取项目根路径
+   */
+  getRootPath(): string {
+    return this.rootPath
+  }
+
+  /**
+   * @deprecated 使用 getRootPath() 替代
+   */
+  getDirname(): string {
+    return path.resolve(this.rootPath, '.vitepress', 'tnotes', 'config')
+  }
+}
+
+/**
+ * 获取配置管理器实例（便捷函数）
+ */
+export function getConfigManager(): ConfigManager {
+  return ConfigManager.getInstance()
+}

package/config/constants.ts

@@ -0,0 +1,121 @@
+/**
+ * config/constants.ts
+ *
+ * 常量定义（从配置中派生的路径和URL常量）
+ */
+
+import { resolve } from 'path'
+
+import { getConfigManager } from './ConfigManager'
+import { getDefaultConfig } from './defaultConfig'
+
+import type { TNotesConfig } from '../types'
+
+function loadConfigOrDefault(): TNotesConfig {
+  try {
+    return getConfigManager().getAll()
+  } catch {
+    return getDefaultConfig()
+  }
+}
+
+const configManager = getConfigManager()
+const config = loadConfigOrDefault()
+
+// 导出配置项（向后兼容）
+export const {
+  author,
+  ignore_dirs,
+  menuItems,
+  port,
+  repoName,
+  sidebarShowNoteId,
+  socialLinks,
+  root_item,
+} = config
+
+// 目录常量 —— 从 ConfigManager.getRootPath() 派生
+const rootPath = configManager.getRootPath()
+
+/**
+ * TNotes.* 当前的笔记仓库根路径
+ * @example `/Users/huyouda/zm/notes/TNotes.template/`
+ */
+export const ROOT_DIR_PATH = rootPath
+export const ROOT_README_PATH = resolve(ROOT_DIR_PATH, 'README.md')
+export const ROOT_TOC_PATH = resolve(ROOT_DIR_PATH, 'TOC.md')
+export const ROOT_CONFIG_PATH = resolve(ROOT_DIR_PATH, '.tnotes.json')
+export const NOTES_DIR_PATH = resolve(ROOT_DIR_PATH, 'notes')
+export const VP_DIR_PATH = resolve(ROOT_DIR_PATH, '.vitepress')
+export const PUBLIC_PATH = resolve(ROOT_DIR_PATH, 'public')
+export const GITHUB_DIR_PATH = resolve(ROOT_DIR_PATH, '.github')
+export const GITHUB_DEPLOY_YML_PATH = resolve(
+  GITHUB_DIR_PATH,
+  'workflows',
+  'deploy.yml',
+)
+export const VP_SIDEBAR_PATH = resolve(ROOT_DIR_PATH, 'sidebar.json')
+export const ROOT_PKG_PATH = resolve(ROOT_DIR_PATH, 'package.json')
+export const VSCODE_SETTINGS_PATH = resolve(
+  ROOT_DIR_PATH,
+  '.vscode',
+  'settings.json',
+)
+export const VSCODE_TASKS_PATH = resolve(ROOT_DIR_PATH, '.vscode', 'tasks.json')
+
+// 文本常量
+export const EOL = '\n'
+
+/**
+ * TNotes 常量配置
+ */
+export const CONSTANTS = {
+  // 端口配置
+  DEFAULT_PORT: 5173,
+
+  // 笔记索引配置（文件夹前缀的 4 位数字）
+  NOTE_INDEX_LENGTH: 4,
+  NOTE_INDEX_PATTERN: /^\d{4}\./,
+  NOTE_INDEX_PREFIX_PATTERN: /^\d{4}/,
+
+  // Git 配置
+  DEFAULT_BRANCH: 'main',
+
+  // 缓存配置
+  CACHE_TTL: 5000,
+
+  // 终端输出颜色
+  COLORS: {
+    RESET: '\x1b[0m',
+    BRIGHT: '\x1b[1m',
+    DIM: '\x1b[2m',
+    RED: '\x1b[31m',
+    GREEN: '\x1b[32m',
+    YELLOW: '\x1b[33m',
+    BLUE: '\x1b[34m',
+    MAGENTA: '\x1b[35m',
+    CYAN: '\x1b[36m',
+  } as const,
+
+  // Emoji
+  EMOJI: {
+    SUCCESS: '✅',
+    ERROR: '❌',
+    WARNING: '⚠️',
+    INFO: 'ℹ️',
+    PROGRESS: '⏳',
+    ROCKET: '🚀',
+    STOP: '🛑',
+    SPARKLES: '✨',
+    LINK: '🔗',
+    FILE: '📄',
+    GIT: '📦',
+    DEBUG: '🐛',
+  } as const,
+} as const
+
+// 导出路径常量别名（向后兼容）
+export const NOTES_PATH = NOTES_DIR_PATH
+
+// GitHub URL 常量
+export const REPO_NOTES_URL = `https://github.com/${author}/${repoName}/tree/main/notes`

package/config/defaultConfig.ts

@@ -44,9 +44,6 @@ export function getDefaultConfig(repoName?: string): TNotesConfig {
       completed_notes_count: {},
       details: `${name} 知识库`,
       link: `https://tnotesjs.github.io/${name}/`,
-      created_at: Date.now(),
-      updated_at: Date.now(),
-      days_since_birth: 0,
     },
 
     // 端口配置（根据仓库名生成）
@@ -120,6 +117,32 @@ export function mergeConfig(
   return result
 }
 
+/**
+ * 根配置 root_item 中已废弃的字段
+ */
+const DEPRECATED_ROOT_ITEM_FIELDS = [
+  'created_at',
+  'updated_at',
+  'days_since_birth',
+] as const
+
+/**
+ * 剥离 root_item 中的废弃时间戳字段
+ * @returns 是否删除了字段
+ */
+export function stripDeprecatedRootItemFields(
+  rootItem: Record<string, unknown>,
+): boolean {
+  let stripped = false
+  for (const key of DEPRECATED_ROOT_ITEM_FIELDS) {
+    if (key in rootItem) {
+      delete rootItem[key]
+      stripped = true
+    }
+  }
+  return stripped
+}
+
 /**
  * 验证并补全配置
  * @param config - 现有配置
@@ -135,8 +158,14 @@ export function validateAndCompleteConfig(config: Record<string, any>): {
   // 深度合并配置
   const mergedConfig = mergeConfig(config, defaultConfig as any)
 
+  // 剥离 root_item 废弃字段
+  const rootItem = (mergedConfig.root_item || {}) as Record<string, unknown>
+  const stripped = stripDeprecatedRootItemFields(rootItem)
+  mergedConfig.root_item = rootItem
+
   // 检查是否有修改
-  const modified = JSON.stringify(config) !== JSON.stringify(mergedConfig)
+  const modified =
+    stripped || JSON.stringify(config) !== JSON.stringify(mergedConfig)
 
   return {
     config: mergedConfig as TNotesConfig,

package/config/index.ts

@@ -0,0 +1,31 @@
+/**
+ * config/index.ts
+ *
+ * 配置层统一导出
+ */
+
+export {
+  ConfigManager,
+  getConfigManager,
+} from './ConfigManager'
+export {
+  getDefaultConfig,
+  mergeConfig,
+  validateAndCompleteConfig,
+  stripDeprecatedRootItemFields,
+} from './defaultConfig'
+export {
+  ROOT_DIR_PATH,
+  ROOT_README_PATH,
+  ROOT_TOC_PATH,
+  ROOT_CONFIG_PATH,
+  NOTES_DIR_PATH,
+  VP_SIDEBAR_PATH,
+  EOL,
+  CONSTANTS,
+  NOTES_PATH,
+  REPO_NOTES_URL,
+  port,
+  repoName,
+} from './constants'
+export * from './templates'

package/config/templates.ts

@@ -0,0 +1,49 @@
+/**
+ * config/templates.ts
+ *
+ * 模板定义
+ */
+
+/**
+ * 新增笔记 README.md 正文模板（不含一级标题）
+ */
+export const NEW_NOTES_README_MD_TEMPLATE = `
+<!-- region:toc -->
+
+- [1. 本节内容](#1-本节内容)
+- [2. 评价](#2-评价)
+
+<!-- endregion:toc -->
+
+## 1. 本节内容
+
+- todo
+
+## 2. 评价
+
+- todo
+`
+
+/**
+ * 获取新增笔记 README.md 正文
+ */
+export function getNewNoteReadmeBody(): string {
+  return NEW_NOTES_README_MD_TEMPLATE
+}
+
+/**
+ * 生成笔记一级标题
+ * @param noteIndex - 笔记索引
+ * @param title - 笔记标题
+ * @param repoUrl - 仓库URL
+ * @returns 格式化的一级标题
+ */
+export function generateNoteTitle(
+  noteIndex: string,
+  title: string,
+  repoUrl: string,
+): string {
+  const dirName = `${noteIndex}. ${title}`
+  const encodedDirName = encodeURIComponent(dirName)
+  return `# [${dirName}](${repoUrl}/${encodedDirName})`
+}