Skip to content

mdcode: reject non-list frontmatter tags #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amirhormati wants to merge 1 commit into
base: main
Choose a base branch
from
Open

mdcode: reject non-list frontmatter tags #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions toolbox/mdcode/src/libts/layouts/documents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export class DocumentsLayout implements CatalogLayout {
let body = '';
if (entryPath) {
const content = await fs.promises.readFile(entryPath, 'utf8');
const result = parseMarkdown(content);
const result = parseMarkdown(content, entryPath);
parsed = result.entry;
body = result.body;
}
Expand Down Expand Up @@ -182,7 +182,7 @@ function deriveParentLocalName(name: string): string | undefined {
return [...parentDir, INDEX_NAME].join('/');
}

export function parseMarkdown(content: string): { entry: md.Entry|null; body: string } {
export function parseMarkdown(content: string, source?: string): { entry: md.Entry|null; body: string } {
const lines = content.split(/\r?\n/);
if (lines[0] !== '---') {
return { entry: null, body: content };
Expand All @@ -203,7 +203,14 @@ export function parseMarkdown(content: string): { entry: md.Entry|null; body: st
entry.resource = entry.resource ?? {}
entry.resource.displayName = metadata.title;
entry.resource.description = metadata.description;
if (metadata.tags) {
if (metadata.tags !== undefined && metadata.tags !== null) {
if (!Array.isArray(metadata.tags)) {
// A bare string is iterable, so without this the tags would silently
// become one label per character.
throw new Error(
`${source ?? 'frontmatter'}: "tags" must be a list, got ${JSON.stringify(metadata.tags)}`,
);
}
entry.resource.labels = entry.resource.labels ?? {};
for (const tag of metadata.tags) {
entry.resource.labels[tag] = 'true';
Expand Down