@herenit/hrd-toolkit-knowledge
v1.5.2
Published
heren-design toolkit versioned knowledge assets
Readme
@herenit/hrd-toolkit-knowledge
@herenit/hrd-toolkit-knowledge 提供 heren-design 组件、Icon 和业务模板知识数据的只读访问能力,并负责组件库版本解析与 fallback。
安装
pnpm add @herenit/hrd-toolkit-knowledge公开入口
从包根入口导入:
createFileSystemKnowledgeRepository(options):创建基于文件系统的只读 Repository。fileSystemKnowledgeRepository:使用包内默认data/的 Repository 实例。getDefaultKnowledgeDataDir():返回包内默认知识数据目录。getMetadataStoreFilePath(version, dataDir?):返回指定版本组件数据文件路径。KnowledgeRepository、KnowledgeResult<T>、ResolvedKnowledgeVersion、TemplateSummary、TemplateDetail等类型。
使用示例
import { createFileSystemKnowledgeRepository } from '@herenit/hrd-toolkit-knowledge';
const repository = createFileSystemKnowledgeRepository();
const result = await repository.loadMetadataStore('1.8.0');
if (!result.ok) {
throw new Error(result.error.message);
}
console.log(result.data.version.resolvedVersion);
console.log(result.data.store.components.length);自定义数据目录时:
const repository = createFileSystemKnowledgeRepository({
dataDir: '/path/to/knowledge/data',
});适用场景
- 读取包内置的 heren-design 知识数据。
- 在服务、脚本或测试中注入自定义知识数据目录。
- 需要获得版本解析结果,而不仅是原始 JSON 文件。
