Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import { existsSync, mkdirSync } from 'node:fs';
import { join, resolve } from 'node:path';
import type { LintPluginId } from '@inkeep/open-knowledge-core';
import { tracedWriteFileSync } from '../fs-traced.ts';
import { scanInPlaceSkills } from '../in-place-skills.ts';
import { CONFIG_FILENAME } from '../init-project.ts';
import {
installPackSkill,
resolvePackSkillHome,
resolvePackSkillSources,
} from './install-pack-skill.ts';
import { assertEntryPathInProject } from './path-safety.ts';
import { enableRequiredPlugins } from './required-plugins.ts';
import { buildStarterFolderFrontmatterYaml, DEFAULT_PACK_ID, resolvePack } from './starter.ts';
import type { ApplyError, ApplyResult, FileEntry, ScaffoldPlan, SeedOptions } from './types.ts';
import { SeedRootDirError } from './types.ts';
function resolveFileContent(
templateId: string,
pack: ReturnType<typeof resolvePack>,
): string | undefined {
if (pack.rootFiles?.[templateId] !== undefined) {
return pack.rootFiles[templateId];
}
const fmMatch = /^(.+)\/\.ok\/frontmatter\.yml$/.exec(templateId);
if (fmMatch) {
const folder = pack.folders.find((f) => f.path === fmMatch[1]);
if (!folder) return undefined;
return buildStarterFolderFrontmatterYaml(folder);
}
const tplMatch = /^(.+)\/\.ok\/templates\/([^/]+)\.md$/.exec(templateId);
if (tplMatch) {
const templateName = tplMatch[2] ?? '';
return pack.templates[templateName];
}
return undefined;
}
export async function applySeed(plan: ScaffoldPlan, opts: SeedOptions = {}): Promise<ApplyResult> {
const started = Date.now();
const projectDir = resolve(opts.projectDir ?? process.cwd());
const pack = resolvePack(opts.packId ?? DEFAULT_PACK_ID);
let applied = 0;
const errors: ApplyError[] = [];
const safeEntries: Array<{ entry: FileEntry; absPath: string }> = [];
for (const entry of plan.created) {
try {
const absPath = assertEntryPathInProject(projectDir, entry.path);
safeEntries.push({ entry, absPath });
} catch (err) {
errors.push({
path: typeof entry.path === 'string' ? entry.path : String(entry.path),
error:
err instanceof SeedRootDirError
? err.message
: err instanceof Error
? err.message
: String(err),
});
}
}
for (const { entry, absPath } of safeEntries.filter(
(e): e is { entry: FileEntry & { kind: 'folder' }; absPath: string } =>
e.entry.kind === 'folder',
)) {
try {
mkdirSync(absPath, { recursive: true });
applied += 1;
} catch (err) {
errors.push({ path: entry.path, error: err instanceof Error ? err.message : String(err) });
}
}
for (const { entry, absPath } of safeEntries.filter(
(e): e is { entry: FileEntry & { kind: 'file' }; absPath: string } => e.entry.kind === 'file',
)) {
const templateId = entry.template ?? entry.path;
const content = resolveFileContent(templateId, pack);
if (content === undefined) {
errors.push({
path: entry.path,
error: `No content template registered for template id "${templateId}" in pack "${pack.id}"`,
});
continue;
}
if (existsSync(absPath)) {
continue;
}
try {
/* STOP: `wx` (O_EXCL) is load-bearing — `path-safety`'s ancestor walk
short-circuits on the first existing component and cannot see a
DANGLING symlinked leaf (existsSync reports it absent), so O_EXCL is
what stops a write-through to the link target outside the project.
Do not relax to `w`. */
tracedWriteFileSync(absPath, content, { encoding: 'utf-8', flag: 'wx' });
applied += 1;
} catch (err) {
errors.push({ path: entry.path, error: err instanceof Error ? err.message : String(err) });
}
}
const packSkillInstall = await installPackSkill(projectDir, pack.id);
if (!('refusal' in resolvePackSkillHome(projectDir))) {
const presentNames = new Set(scanInPlaceSkills(projectDir).map((sk) => sk.name));
for (const { name } of resolvePackSkillSources(pack.id)) {
const inStore = existsSync(join(projectDir, '.ok', 'skills', name, 'SKILL.md'));
if (!presentNames.has(name) && !inStore) {
errors.push({ path: name, error: 'skill source could not be authored' });
}
}
}
let pluginsEnabled: LintPluginId[] = [];
try {
pluginsEnabled = enableRequiredPlugins(projectDir, pack.requiredPlugins ?? []);
} catch (err) {
errors.push({
path: `.ok/${CONFIG_FILENAME}`,
error: `could not enable required plugin(s): ${err instanceof Error ? err.message : String(err)}`,
});
}
return {
applied,
errors,
durationMs: Date.now() - started,
packSkillsInstalled: packSkillInstall.editors,
packSkillConflicts: packSkillInstall.conflicts,
pluginsEnabled,
};
}