Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
// oxlint-disable ok/no-physical-direction-utility -- pre-rule backlog — physical margin/padding/inset utilities predate the rule; drain by swapping ml/mr → ms/me, pl/pr → ps/pe, left/right → start/end, then deleting this line. See https://github.com/inkeep/open-knowledge/blob/main/lint-plugins/ok-rules/README.md#no-physical-direction-utility
import type {
FrontmatterFieldConstraint,
SchemaParentPathSegment,
} from '@inkeep/open-knowledge-core/markdown/lint';
import { Trans, useLingui } from '@lingui/react/macro';
import {
Braces,
Brackets,
CaseSensitive,
Hash,
ListChecks,
type LucideIcon,
ToggleLeft,
Trash2,
} from 'lucide-react';
import { useState } from 'react';
import { toast } from 'sonner';
import { Button } from '@/components/ui/button';
import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue,
} from '@/components/ui/select';
import { Switch } from '@/components/ui/switch';
import { TagPillInput } from '@/components/ui/tag-pill-input';
import {
emitLintConfigChanged,
removeFrontmatterSchemaField,
renameFrontmatterSchemaField,
useProjectLintConfig,
writeFrontmatterSchemaField,
} from '@/editor/lint-config-client';
import { cn } from '@/lib/utils';
const FIELD_TYPES = ['string', 'number', 'boolean', 'array', 'object'] as const;
type FieldType = (typeof FIELD_TYPES)[number];
const TYPE_SELECT_OPTIONS = ['string', 'number', 'boolean', 'enum', 'array', 'object'] as const;
const ITEMS_TYPE_SELECT_OPTIONS = ['string', 'number', 'boolean', 'enum', 'object'] as const;
type ItemsType = 'string' | 'number' | 'boolean' | 'object';
const TYPE_ICONS: Record<
(typeof TYPE_SELECT_OPTIONS)[number],
{ Icon: LucideIcon; className: string }
> = {
string: { Icon: CaseSensitive, className: 'text-chart-2' },
number: { Icon: Hash, className: 'text-chart-1' },
boolean: { Icon: ToggleLeft, className: 'text-(--syntax-atom)' },
enum: { Icon: ListChecks, className: 'text-chart-3' },
array: { Icon: Brackets, className: 'text-chart-5' },
object: { Icon: Braces, className: 'text-chart-4' },
};
function TypeSelectItemLabel({ option }: { option: (typeof TYPE_SELECT_OPTIONS)[number] }) {
const { Icon, className } = TYPE_ICONS[option];
return (
<span className="flex items-center gap-2">
<Icon aria-hidden className={cn('size-3.5 shrink-0', className)} />
{option}
</span>
);
}
function RowTypeIcon({ option }: { option: (typeof TYPE_SELECT_OPTIONS)[number] }) {
const { Icon, className } = TYPE_ICONS[option];
return <Icon aria-hidden className={cn('size-4 shrink-0', className)} />;
}
const MAX_NESTING_DEPTH = 4;
const ROOT_MODELED_KEYWORDS = new Set(['$schema', 'type', 'properties', 'required']);
const MODELED_KEYWORDS = new Set([
'type',
'enum',
'pattern',
'format',
'items',
'description',
'properties',
'required',
]);
function isRecord(value: unknown): value is Record<string, unknown> {
return value !== null && typeof value === 'object' && !Array.isArray(value);
}
function stringEnum(value: unknown): string[] | null {
if (value === undefined) return [];
if (!Array.isArray(value)) return null;
return value.every((entry) => typeof entry === 'string') ? (value as string[]) : null;
}
function hasUnmodeledKeywords(property: Record<string, unknown>): boolean {
if (Object.keys(property).some((key) => !MODELED_KEYWORDS.has(key))) return true;
const items = property.items;
if (items !== undefined) {
if (!isRecord(items)) return true;
const modeledItemsKeys = new Set(['enum', 'type', 'properties', 'required', 'description']);
if (Object.keys(items).some((key) => !modeledItemsKeys.has(key))) return true;
}
return false;
}
interface FieldOps {
save: (
field: string,
constraint: FrontmatterFieldConstraint,
parentPath: readonly SchemaParentPathSegment[],
) => void;
rename: (field: string, to: string, parentPath: readonly SchemaParentPathSegment[]) => void;
remove: (field: string, parentPath: readonly SchemaParentPathSegment[]) => void;
}
function pathKeyOf(parentPath: readonly SchemaParentPathSegment[], field: string): string {
return [...parentPath.map((seg) => (typeof seg === 'string' ? seg : '[]')), field].join('.');
}
export function FrontmatterSchemaFieldEditor({ file }: { file: string }) {
const { t } = useLingui();
const { data } = useProjectLintConfig();
const entry = data?.effective.plugins.frontmatter.schemas.find((s) => s.file === file);
const schema = entry?.schema;
const rootAdvancedKeywords = isRecord(schema)
? Object.keys(schema).filter((key) => !ROOT_MODELED_KEYWORDS.has(key))
: [];
const ops: FieldOps = {
save: (field, constraint, parentPath) => {
void (async () => {
const result = await writeFrontmatterSchemaField(file, field, constraint, parentPath);
if (result.ok) emitLintConfigChanged();
else toast.error(result.errorDetail ?? t`Failed to save the schema field`);
})();
},
rename: (field, to, parentPath) => {
void (async () => {
const result = await renameFrontmatterSchemaField(file, field, to, parentPath);
if (result.ok) emitLintConfigChanged();
else toast.error(result.errorDetail ?? t`Failed to rename the field`);
})();
},
remove: (field, parentPath) => {
void (async () => {
const result = await removeFrontmatterSchemaField(file, field, parentPath);
if (result.ok) emitLintConfigChanged();
else toast.error(result.errorDetail ?? t`Failed to remove the field`);
})();
},
};
return (
<div className="space-y-3" data-testid={`frontmatter-field-editor-${file}`}>
{schema === undefined && (
<p className="text-sm text-muted-foreground">
<Trans>
The schema file does not exist or failed to load — adding a field creates it.
</Trans>
</p>
)}
{rootAdvancedKeywords.length > 0 && (
<p
className="text-xs text-muted-foreground"
data-testid={`frontmatter-schema-root-preserved-${file}`}
>
<Trans>
This schema carries root-level advanced rules the editor does not show (
{rootAdvancedKeywords.join(', ')}) — they still validate and survive every edit. Open
the schema file to see them.
</Trans>
</p>
)}
<FieldList
node={isRecord(schema) ? schema : {}}
parentPath={[]}
depth={0}
addInputId={`frontmatter-add-field-${file}`}
ops={ops}
/>
</div>
);
}
function FieldList({
node,
parentPath,
depth,
addInputId,
ops,
}: {
node: Record<string, unknown>;
parentPath: readonly SchemaParentPathSegment[];
depth: number;
addInputId: string;
ops: FieldOps;
}) {
const properties = isRecord(node.properties) ? node.properties : {};
const required = Array.isArray(node.required)
? node.required.filter((r): r is string => typeof r === 'string')
: [];
return (
<div className="space-y-2">
{Object.entries(properties).map(([field, rawProperty]) => (
<FieldRow
key={field}
field={field}
property={isRecord(rawProperty) ? rawProperty : {}}
isRequired={required.includes(field)}
parentPath={parentPath}
depth={depth}
ops={ops}
/>
))}
<AddFieldInput
inputId={addInputId}
onAdd={(name) => ops.save(name, { type: 'string' }, parentPath)}
/>
</div>
);
}
function FieldRow({
field,
property,
isRequired,
parentPath,
depth,
ops,
}: {
field: string;
property: Record<string, unknown>;
isRequired: boolean;
parentPath: readonly SchemaParentPathSegment[];
depth: number;
ops: FieldOps;
}) {
const { t } = useLingui();
const [enumIntent, setEnumIntent] = useState(false);
const [itemsEnumIntent, setItemsEnumIntent] = useState(false);
const pathKey = pathKeyOf(parentPath, field);
const type =
typeof property.type === 'string' && (FIELD_TYPES as readonly string[]).includes(property.type)
? (property.type as FieldType)
: undefined;
const enumValues = stringEnum(property.enum);
const items = isRecord(property.items) ? property.items : {};
const itemsEnumValues = stringEnum(items.enum);
const pattern = typeof property.pattern === 'string' ? property.pattern : '';
const description = typeof property.description === 'string' ? property.description : '';
const preserved = hasUnmodeledKeywords(property);
const showAsEnum =
type !== 'array' &&
type !== 'object' &&
enumValues !== null &&
(enumIntent || (type === undefined && enumValues.length > 0));
const showChildren = type === 'object' && depth < MAX_NESTING_DEPTH;
const itemsType =
typeof items.type === 'string' &&
(ITEMS_TYPE_SELECT_OPTIONS as readonly string[]).includes(items.type)
? (items.type as ItemsType)
: undefined;
const showItemsAsEnum =
itemsType !== 'object' &&
itemsEnumValues !== null &&
(itemsEnumIntent || (itemsType === undefined && itemsEnumValues.length > 0));
const showItemChildren = type === 'array' && itemsType === 'object' && depth < MAX_NESTING_DEPTH;
return (
<div
className="space-y-2 rounded-md border p-3"
data-testid={`frontmatter-field-row-${pathKey}`}
>
<div className="flex items-center gap-2">
{(showAsEnum || type !== undefined) && (
<RowTypeIcon option={showAsEnum ? 'enum' : (type as FieldType)} />
)}
<CommitInput
id={`frontmatter-field-name-${pathKey}`}
initial={field}
ariaLabel={t`Field name`}
className="h-7 w-36 shrink-0 font-mono text-sm font-medium"
onCommit={(next) => {
if (next !== '' && next !== field) ops.rename(field, next, parentPath);
}}
/>
<CommitInput
id={`frontmatter-field-description-${pathKey}`}
initial={description}
placeholder={t`Add description`}
ariaLabel={t`Description for ${field}`}
className="h-7 min-w-0 flex-1"
onCommit={(next) =>
ops.save(field, { description: next === '' ? null : next }, parentPath)
}
/>
<Label
htmlFor={`frontmatter-field-required-${pathKey}`}
className="shrink-0 text-xs text-muted-foreground"
>
<Trans>Required</Trans>
</Label>
<Switch
id={`frontmatter-field-required-${pathKey}`}
checked={isRequired}
onCheckedChange={(next) => ops.save(field, { required: next }, parentPath)}
data-testid={`frontmatter-field-required-${pathKey}`}
/>
<Button
variant="ghost"
size="icon"
className="size-7 shrink-0"
onClick={() => ops.remove(field, parentPath)}
aria-label={t`Remove field ${field}`}
data-testid={`frontmatter-field-remove-${pathKey}`}
>
<Trash2 aria-hidden className="size-4" />
</Button>
</div>
{preserved && (
<p
className="text-xs text-muted-foreground"
data-testid={`frontmatter-field-preserved-${pathKey}`}
>
<Trans>
This field carries additional schema keywords the editor does not show — they are
preserved on save.
</Trans>
</p>
)}
<div className="grid grid-cols-2 gap-2">
<div className="space-y-1">
<Label className="text-xs" htmlFor={`frontmatter-field-type-${pathKey}`}>
<Trans>Type</Trans>
</Label>
<Select
value={showAsEnum ? 'enum' : (type ?? '')}
onValueChange={(next) => {
if (next === 'enum') {
setEnumIntent(true);
return;
}
setEnumIntent(false);
const constraint: FrontmatterFieldConstraint =
next !== 'string' && (enumValues?.length ?? 0) > 0
? { type: next as FieldType, enum: null }
: { type: next as FieldType };
ops.save(field, constraint, parentPath);
}}
>
<SelectTrigger
id={`frontmatter-field-type-${pathKey}`}
data-testid={`frontmatter-field-type-${pathKey}`}
>
<SelectValue placeholder={t`any`} />
</SelectTrigger>
<SelectContent>
{TYPE_SELECT_OPTIONS.map((option) => (
<SelectItem key={option} value={option}>
<TypeSelectItemLabel option={option} />
</SelectItem>
))}
</SelectContent>
</Select>
</div>
<div className="space-y-1">
<Label className="text-xs" htmlFor={`frontmatter-field-pattern-${pathKey}`}>
<Trans>Pattern (regex)</Trans>
</Label>
<CommitInput
id={`frontmatter-field-pattern-${pathKey}`}
initial={pattern}
onCommit={(next) => ops.save(field, { pattern: next === '' ? null : next }, parentPath)}
/>
</div>
</div>
{type !== 'array' && type !== 'object' && enumValues !== null && (
<div className="space-y-1">
<Label className="text-xs" htmlFor={`frontmatter-field-enum-${pathKey}`}>
<Trans>Allowed values (empty = any)</Trans>
</Label>
<TagPillInput
id={`frontmatter-field-enum-${pathKey}`}
value={enumValues}
grammar="free-text"
onChange={(next) =>
ops.save(field, { enum: next.length === 0 ? null : next }, parentPath)
}
placeholder={t`Add value`}
aria-label={t`Allowed values for ${field}`}
/>
</div>
)}
{type === 'array' && (
<div className="grid grid-cols-2 gap-2">
<div className="space-y-1">
<Label className="text-xs" htmlFor={`frontmatter-field-items-type-${pathKey}`}>
<Trans>Element type</Trans>
</Label>
<Select
value={showItemsAsEnum ? 'enum' : (itemsType ?? '')}
onValueChange={(next) => {
if (next === 'enum') {
setItemsEnumIntent(true);
return;
}
setItemsEnumIntent(false);
const constraint: FrontmatterFieldConstraint =
next !== 'string' && (itemsEnumValues?.length ?? 0) > 0
? { itemsType: next as ItemsType, itemsEnum: null }
: { itemsType: next as ItemsType };
ops.save(field, constraint, parentPath);
}}
>
<SelectTrigger
id={`frontmatter-field-items-type-${pathKey}`}
data-testid={`frontmatter-field-items-type-${pathKey}`}
>
<SelectValue placeholder={t`any`} />
</SelectTrigger>
<SelectContent>
{ITEMS_TYPE_SELECT_OPTIONS.map((option) => (
<SelectItem key={option} value={option}>
<TypeSelectItemLabel option={option} />
</SelectItem>
))}
</SelectContent>
</Select>
</div>
</div>
)}
{type === 'array' && itemsType !== 'object' && itemsEnumValues !== null && (
<div className="space-y-1">
<Label className="text-xs" htmlFor={`frontmatter-field-items-enum-${pathKey}`}>
<Trans>Allowed element values (empty = any)</Trans>
</Label>
<TagPillInput
id={`frontmatter-field-items-enum-${pathKey}`}
value={itemsEnumValues}
grammar="free-text"
onChange={(next) =>
ops.save(field, { itemsEnum: next.length === 0 ? null : next }, parentPath)
}
placeholder={t`Add value`}
aria-label={t`Allowed element values for ${field}`}
/>
</div>
)}
{showItemChildren && (
<div
className="ml-2 space-y-1 border-l pl-3 pt-1"
data-testid={`frontmatter-field-item-children-${pathKey}`}
>
<p className="text-xs text-muted-foreground">
<Trans>Element fields</Trans>
</p>
<FieldList
node={items}
parentPath={[...parentPath, field, { items: true }]}
depth={depth + 1}
addInputId={`frontmatter-add-field-${pathKey}.[]`}
ops={ops}
/>
</div>
)}
{showChildren && (
<div
className="ml-2 space-y-1 border-l pl-3 pt-1"
data-testid={`frontmatter-field-children-${pathKey}`}
>
<p className="text-xs text-muted-foreground">
<Trans>Nested fields</Trans>
</p>
<FieldList
node={property}
parentPath={[...parentPath, field]}
depth={depth + 1}
addInputId={`frontmatter-add-field-${pathKey}`}
ops={ops}
/>
</div>
)}
</div>
);
}
function AddFieldInput({ inputId, onAdd }: { inputId: string; onAdd: (name: string) => void }) {
const [name, setName] = useState('');
return (
<div className="flex items-end gap-2">
<div className="min-w-0 flex-1 space-y-1">
<Label htmlFor={inputId} className="text-xs">
<Trans>Add field</Trans>
</Label>
<Input
id={inputId}
value={name}
onChange={(e) => setName(e.target.value)}
placeholder="owner"
data-testid={`${inputId}-input`}
/>
</div>
<Button
size="sm"
variant="outline"
disabled={name.trim() === ''}
onClick={() => {
onAdd(name.trim());
setName('');
}}
data-testid={`${inputId}-save`}
>
<Trans>Add</Trans>
</Button>
</div>
);
}
function CommitInput({
id,
initial,
onCommit,
placeholder,
ariaLabel,
className,
}: {
id: string;
initial: string;
onCommit: (value: string) => void;
placeholder?: string;
ariaLabel?: string;
className?: string;
}) {
const [draft, setDraft] = useState(initial);
const commit = () => {
if (draft.trim() !== initial) onCommit(draft.trim());
};
return (
<Input
id={id}
value={draft}
onChange={(e) => setDraft(e.target.value)}
onBlur={commit}
onKeyDown={(e) => {
if (e.key === 'Enter') commit();
}}
placeholder={placeholder}
aria-label={ariaLabel}
className={className}
data-testid={id}
/>
);
}