@handong66/evidoc-frontmatter 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/index.d.ts +20 -0
- package/dist/src/index.js +149 -0
- package/dist/src/index.js.map +1 -0
- package/package.json +24 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface SourceBinding {
|
|
2
|
+
path: string;
|
|
3
|
+
symbols?: string[];
|
|
4
|
+
}
|
|
5
|
+
export interface DocumentFrontmatter {
|
|
6
|
+
id?: string;
|
|
7
|
+
owner?: string;
|
|
8
|
+
sources?: SourceBinding[];
|
|
9
|
+
lastReviewed?: string;
|
|
10
|
+
ttlDays?: number;
|
|
11
|
+
}
|
|
12
|
+
export interface ParsedDocumentFrontmatter {
|
|
13
|
+
frontmatter: DocumentFrontmatter;
|
|
14
|
+
body: string;
|
|
15
|
+
hasFrontmatter: boolean;
|
|
16
|
+
}
|
|
17
|
+
export declare function parseDocumentFrontmatter(text: string): ParsedDocumentFrontmatter;
|
|
18
|
+
export declare function serializeDocumentFrontmatter(value: DocumentFrontmatter): string;
|
|
19
|
+
export declare function backfillDocumentFrontmatter(text: string, patch: DocumentFrontmatter): string;
|
|
20
|
+
export declare function validateDocumentFrontmatter(value: DocumentFrontmatter): string[];
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
export function parseDocumentFrontmatter(text) {
|
|
2
|
+
const lines = text.split(/\r?\n/);
|
|
3
|
+
if (lines[0]?.trim() !== "---") {
|
|
4
|
+
return {
|
|
5
|
+
frontmatter: {},
|
|
6
|
+
body: text,
|
|
7
|
+
hasFrontmatter: false
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
const end = lines.findIndex((line, index) => index > 0 && line.trim() === "---");
|
|
11
|
+
if (end < 0) {
|
|
12
|
+
return {
|
|
13
|
+
frontmatter: {},
|
|
14
|
+
body: text,
|
|
15
|
+
hasFrontmatter: false
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
return {
|
|
19
|
+
frontmatter: parseFrontmatterLines(lines.slice(1, end)),
|
|
20
|
+
body: lines.slice(end + 1).join("\n"),
|
|
21
|
+
hasFrontmatter: true
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
export function serializeDocumentFrontmatter(value) {
|
|
25
|
+
const lines = ["---"];
|
|
26
|
+
if (value.id)
|
|
27
|
+
lines.push(`id: ${value.id}`);
|
|
28
|
+
if (value.owner)
|
|
29
|
+
lines.push(`owner: ${value.owner}`);
|
|
30
|
+
if (value.sources?.length) {
|
|
31
|
+
lines.push("sources:");
|
|
32
|
+
for (const source of value.sources) {
|
|
33
|
+
lines.push(` - path: ${source.path}`);
|
|
34
|
+
if (source.symbols?.length) {
|
|
35
|
+
lines.push(" symbols:");
|
|
36
|
+
for (const symbol of source.symbols) {
|
|
37
|
+
lines.push(` - ${symbol}`);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
if (value.lastReviewed)
|
|
43
|
+
lines.push(`lastReviewed: ${value.lastReviewed}`);
|
|
44
|
+
if (value.ttlDays !== undefined)
|
|
45
|
+
lines.push(`ttlDays: ${value.ttlDays}`);
|
|
46
|
+
lines.push("---");
|
|
47
|
+
return `${lines.join("\n")}\n`;
|
|
48
|
+
}
|
|
49
|
+
export function backfillDocumentFrontmatter(text, patch) {
|
|
50
|
+
const parsed = parseDocumentFrontmatter(text);
|
|
51
|
+
const frontmatter = mergeFrontmatter(parsed.frontmatter, patch);
|
|
52
|
+
const body = parsed.body.replace(/^\n+/, "");
|
|
53
|
+
return `${serializeDocumentFrontmatter(frontmatter)}${body}`;
|
|
54
|
+
}
|
|
55
|
+
export function validateDocumentFrontmatter(value) {
|
|
56
|
+
const errors = [];
|
|
57
|
+
for (const source of value.sources ?? []) {
|
|
58
|
+
if (!source.path || source.path.startsWith("/")) {
|
|
59
|
+
errors.push("sources.path must be a non-empty repository-relative path");
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
if (value.ttlDays !== undefined && (!Number.isInteger(value.ttlDays) || value.ttlDays <= 0)) {
|
|
63
|
+
errors.push("ttlDays must be a positive integer when provided");
|
|
64
|
+
}
|
|
65
|
+
return errors;
|
|
66
|
+
}
|
|
67
|
+
function parseFrontmatterLines(lines) {
|
|
68
|
+
const frontmatter = {};
|
|
69
|
+
let currentSource;
|
|
70
|
+
let inSymbols = false;
|
|
71
|
+
for (const line of lines) {
|
|
72
|
+
const trimmed = line.trim();
|
|
73
|
+
if (trimmed.startsWith("id:")) {
|
|
74
|
+
frontmatter.id = trimmed.slice("id:".length).trim();
|
|
75
|
+
inSymbols = false;
|
|
76
|
+
continue;
|
|
77
|
+
}
|
|
78
|
+
if (trimmed.startsWith("owner:")) {
|
|
79
|
+
frontmatter.owner = trimmed.slice("owner:".length).trim();
|
|
80
|
+
inSymbols = false;
|
|
81
|
+
continue;
|
|
82
|
+
}
|
|
83
|
+
if (trimmed.startsWith("lastReviewed:")) {
|
|
84
|
+
frontmatter.lastReviewed = trimmed.slice("lastReviewed:".length).trim();
|
|
85
|
+
inSymbols = false;
|
|
86
|
+
continue;
|
|
87
|
+
}
|
|
88
|
+
if (trimmed.startsWith("ttlDays:")) {
|
|
89
|
+
frontmatter.ttlDays = Number.parseInt(trimmed.slice("ttlDays:".length).trim(), 10);
|
|
90
|
+
inSymbols = false;
|
|
91
|
+
continue;
|
|
92
|
+
}
|
|
93
|
+
if (trimmed === "sources:") {
|
|
94
|
+
frontmatter.sources ??= [];
|
|
95
|
+
inSymbols = false;
|
|
96
|
+
continue;
|
|
97
|
+
}
|
|
98
|
+
if (trimmed.startsWith("- path:")) {
|
|
99
|
+
frontmatter.sources ??= [];
|
|
100
|
+
currentSource = {
|
|
101
|
+
path: trimmed.slice("- path:".length).trim()
|
|
102
|
+
};
|
|
103
|
+
frontmatter.sources.push(currentSource);
|
|
104
|
+
inSymbols = false;
|
|
105
|
+
continue;
|
|
106
|
+
}
|
|
107
|
+
if (trimmed === "symbols:") {
|
|
108
|
+
currentSource ??= { path: "" };
|
|
109
|
+
currentSource.symbols ??= [];
|
|
110
|
+
inSymbols = true;
|
|
111
|
+
continue;
|
|
112
|
+
}
|
|
113
|
+
if (inSymbols && trimmed.startsWith("- ") && currentSource) {
|
|
114
|
+
currentSource.symbols ??= [];
|
|
115
|
+
currentSource.symbols.push(trimmed.slice(2).trim());
|
|
116
|
+
continue;
|
|
117
|
+
}
|
|
118
|
+
if (trimmed && !line.startsWith(" ")) {
|
|
119
|
+
inSymbols = false;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
return frontmatter;
|
|
123
|
+
}
|
|
124
|
+
function mergeFrontmatter(base, patch) {
|
|
125
|
+
return {
|
|
126
|
+
...base,
|
|
127
|
+
...patch,
|
|
128
|
+
sources: mergeSources(base.sources ?? [], patch.sources ?? [])
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
function mergeSources(base, patch) {
|
|
132
|
+
const byPath = new Map();
|
|
133
|
+
for (const source of [...base, ...patch]) {
|
|
134
|
+
const existing = byPath.get(source.path);
|
|
135
|
+
byPath.set(source.path, {
|
|
136
|
+
path: source.path,
|
|
137
|
+
symbols: unique([...(existing?.symbols ?? []), ...(source.symbols ?? [])])
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
const sources = [...byPath.values()].map((source) => ({
|
|
141
|
+
path: source.path,
|
|
142
|
+
...(source.symbols?.length ? { symbols: source.symbols } : {})
|
|
143
|
+
}));
|
|
144
|
+
return sources.length ? sources : undefined;
|
|
145
|
+
}
|
|
146
|
+
function unique(values) {
|
|
147
|
+
return [...new Set(values)];
|
|
148
|
+
}
|
|
149
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAmBA,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;QAC/B,OAAO;YACL,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,IAAI;YACV,cAAc,EAAE,KAAK;SACtB,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC,CAAC;IACjF,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACZ,OAAO;YACL,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,IAAI;YACV,cAAc,EAAE,KAAK;SACtB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACvD,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACrC,cAAc,EAAE,IAAI;KACrB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,KAA0B;IACrE,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;IAEtB,IAAI,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,KAAK,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACrD,IAAI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACvC,IAAI,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;gBAC3B,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC3B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpC,KAAK,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,YAAY;QAAE,KAAK,CAAC,IAAI,CAAC,iBAAiB,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;IAC1E,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACzE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAElB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,IAAY,EACZ,KAA0B;IAE1B,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,OAAO,GAAG,4BAA4B,CAAC,WAAW,CAAC,GAAG,IAAI,EAAE,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,KAA0B;IACpE,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC;QAC5F,MAAM,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAe;IAC5C,MAAM,WAAW,GAAwB,EAAE,CAAC;IAC5C,IAAI,aAAwC,CAAC;IAC7C,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAE5B,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,WAAW,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;YACpD,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,WAAW,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;YAC1D,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;YACxE,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YACnF,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3B,WAAW,CAAC,OAAO,KAAK,EAAE,CAAC;YAC3B,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,WAAW,CAAC,OAAO,KAAK,EAAE,CAAC;YAC3B,aAAa,GAAG;gBACd,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE;aAC7C,CAAC;YACF,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACxC,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3B,aAAa,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAC/B,aAAa,CAAC,OAAO,KAAK,EAAE,CAAC;YAC7B,SAAS,GAAG,IAAI,CAAC;YACjB,SAAS;QACX,CAAC;QAED,IAAI,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,EAAE,CAAC;YAC3D,aAAa,CAAC,OAAO,KAAK,EAAE,CAAC;YAC7B,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACpD,SAAS;QACX,CAAC;QAED,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAyB,EAAE,KAA0B;IAC7E,OAAO;QACL,GAAG,IAAI;QACP,GAAG,KAAK;QACR,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;KAC/D,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB,EAAE,KAAsB;IACjE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEhD,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;SAC3E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACpD,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC/D,CAAC,CAAC,CAAC;IACJ,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED,SAAS,MAAM,CAAC,MAAgB;IAC9B,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9B,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@handong66/evidoc-frontmatter",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"scripts": {
|
|
6
|
+
"prepublishOnly": "node ../../scripts/ensure-built-package.mjs"
|
|
7
|
+
},
|
|
8
|
+
"exports": {
|
|
9
|
+
".": "./dist/src/index.js"
|
|
10
|
+
},
|
|
11
|
+
"types": "./dist/src/index.d.ts",
|
|
12
|
+
"files": [
|
|
13
|
+
"dist/src"
|
|
14
|
+
],
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "git+https://github.com/handong66/Evidoc.git"
|
|
19
|
+
},
|
|
20
|
+
"bugs": {
|
|
21
|
+
"url": "https://github.com/handong66/Evidoc/issues"
|
|
22
|
+
},
|
|
23
|
+
"homepage": "https://github.com/handong66/Evidoc#readme"
|
|
24
|
+
}
|