@lownoise-studio/rendershield 0.3.1 → 1.0.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/CHANGELOG.md +58 -32
- package/CONTRIBUTING.md +41 -0
- package/README.md +209 -144
- package/SECURITY.md +25 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +27 -19
- package/dist/cli.js.map +1 -1
- package/dist/commands/build.d.ts +2 -0
- package/dist/commands/build.d.ts.map +1 -0
- package/dist/commands/build.js +10 -9
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/init.d.ts +2 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/verify.d.ts +19 -0
- package/dist/commands/verify.d.ts.map +1 -0
- package/dist/commands/verify.js +57 -64
- package/dist/commands/verify.js.map +1 -1
- package/dist/core/generateRobots.d.ts +3 -0
- package/dist/core/generateRobots.d.ts.map +1 -0
- package/dist/core/generateSitemap.d.ts +3 -0
- package/dist/core/generateSitemap.d.ts.map +1 -0
- package/dist/core/generateWorker.d.ts +3 -0
- package/dist/core/generateWorker.d.ts.map +1 -0
- package/dist/core/generateWorker.js +75 -75
- package/dist/core/loadConfig.d.ts +3 -0
- package/dist/core/loadConfig.d.ts.map +1 -0
- package/dist/core/loadConfig.js +68 -25
- package/dist/core/loadConfig.js.map +1 -1
- package/dist/core/loadMarkdown.d.ts +3 -0
- package/dist/core/loadMarkdown.d.ts.map +1 -0
- package/dist/core/loadMarkdown.js +4 -3
- package/dist/core/loadMarkdown.js.map +1 -1
- package/dist/core/renderHtml.d.ts +3 -0
- package/dist/core/renderHtml.d.ts.map +1 -0
- package/dist/core/renderHtml.js +25 -10
- package/dist/core/renderHtml.js.map +1 -1
- package/dist/core/validateOutput.d.ts +28 -0
- package/dist/core/validateOutput.d.ts.map +1 -0
- package/dist/core/validateOutput.js +7 -1
- package/dist/core/validateOutput.js.map +1 -1
- package/dist/errors.d.ts +14 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +24 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +53 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +1 -1
- package/dist/types.js.map +1 -1
- package/docs/deploy-cloudflare.md +40 -14
- package/package.json +24 -2
- package/src/cli.ts +86 -75
- package/src/commands/build.ts +199 -185
- package/src/commands/verify.ts +266 -236
- package/src/core/generateWorker.ts +97 -97
- package/src/core/loadConfig.ts +261 -173
- package/src/core/loadMarkdown.ts +9 -3
- package/src/core/renderHtml.ts +36 -12
- package/src/core/validateOutput.ts +335 -328
- package/src/errors.ts +48 -0
- package/src/index.ts +40 -0
- package/src/types.ts +4 -1
package/src/core/loadMarkdown.ts
CHANGED
|
@@ -4,6 +4,7 @@ import fs from "fs-extra";
|
|
|
4
4
|
import matter from "gray-matter";
|
|
5
5
|
import MarkdownIt from "markdown-it";
|
|
6
6
|
import { MarkdownDoc, RenderShieldConfig } from "../types.js";
|
|
7
|
+
import { renderShieldError } from "../errors.js";
|
|
7
8
|
|
|
8
9
|
const md = new MarkdownIt({ html: false, linkify: true, typographer: true });
|
|
9
10
|
|
|
@@ -11,7 +12,8 @@ const REQUIRED_FIELDS = "title, excerpt, datePublished, coverImage, slug";
|
|
|
11
12
|
|
|
12
13
|
function requireString(value: unknown, field: string, file: string): string {
|
|
13
14
|
if (typeof value !== "string" || value.trim().length === 0) {
|
|
14
|
-
throw
|
|
15
|
+
throw renderShieldError(
|
|
16
|
+
"CONTENT_INVALID",
|
|
15
17
|
`Missing required frontmatter field "${field}" in ${file}. Required fields: ${REQUIRED_FIELDS}`
|
|
16
18
|
);
|
|
17
19
|
}
|
|
@@ -25,7 +27,10 @@ function normalizeDate(value: unknown, file: string): string {
|
|
|
25
27
|
if (value instanceof Date) {
|
|
26
28
|
return value.toISOString().slice(0, 10);
|
|
27
29
|
}
|
|
28
|
-
throw
|
|
30
|
+
throw renderShieldError(
|
|
31
|
+
"CONTENT_INVALID",
|
|
32
|
+
`Invalid datePublished in ${file}. Use format YYYY-MM-DD.`
|
|
33
|
+
);
|
|
29
34
|
}
|
|
30
35
|
|
|
31
36
|
export async function loadAllMarkdownDocs(cfg: RenderShieldConfig, cwd = process.cwd()): Promise<MarkdownDoc[]> {
|
|
@@ -47,7 +52,8 @@ export async function loadAllMarkdownDocs(cfg: RenderShieldConfig, cwd = process
|
|
|
47
52
|
|
|
48
53
|
const datePublishedRaw = parsed.data?.datePublished;
|
|
49
54
|
if (datePublishedRaw === undefined || datePublishedRaw === null) {
|
|
50
|
-
throw
|
|
55
|
+
throw renderShieldError(
|
|
56
|
+
"CONTENT_INVALID",
|
|
51
57
|
`Missing required frontmatter field "datePublished" in ${abs}. Required fields: ${REQUIRED_FIELDS}`
|
|
52
58
|
);
|
|
53
59
|
}
|
package/src/core/renderHtml.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { MarkdownDoc, RenderShieldConfig } from "../types.js";
|
|
1
|
+
import { MarkdownDoc, RenderShieldConfig, SchemaType } from "../types.js";
|
|
2
2
|
|
|
3
3
|
function escapeHtml(s: string): string {
|
|
4
4
|
return s
|
|
@@ -15,6 +15,37 @@ function joinUrl(base: string, pathname: string): string {
|
|
|
15
15
|
return b + p;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
+
function resolveSchemaType(cfg: RenderShieldConfig, doc: MarkdownDoc): SchemaType {
|
|
19
|
+
const collection = cfg.content.markdown.collections.find((c) => c.name === doc.collection);
|
|
20
|
+
return collection?.schemaType ?? "Article";
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
function buildJsonLd(
|
|
24
|
+
schemaType: SchemaType,
|
|
25
|
+
cfg: RenderShieldConfig,
|
|
26
|
+
doc: MarkdownDoc,
|
|
27
|
+
canonicalUrl: string,
|
|
28
|
+
ogImageUrl: string
|
|
29
|
+
): Record<string, unknown> {
|
|
30
|
+
const base = {
|
|
31
|
+
"@context": "https://schema.org",
|
|
32
|
+
"@type": schemaType,
|
|
33
|
+
mainEntityOfPage: canonicalUrl,
|
|
34
|
+
image: ogImageUrl,
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
if (schemaType === "WebPage") {
|
|
38
|
+
return { ...base, name: doc.title };
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return {
|
|
42
|
+
...base,
|
|
43
|
+
headline: doc.title,
|
|
44
|
+
author: { "@type": "Person", name: cfg.site.authorName },
|
|
45
|
+
datePublished: doc.datePublished,
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
|
|
18
49
|
export function renderPageHtml(cfg: RenderShieldConfig, doc: MarkdownDoc): string {
|
|
19
50
|
const canonicalUrl = joinUrl(cfg.site.canonicalBase, doc.routePath);
|
|
20
51
|
const ogImageUrl = doc.coverImage.startsWith("http")
|
|
@@ -23,16 +54,9 @@ export function renderPageHtml(cfg: RenderShieldConfig, doc: MarkdownDoc): strin
|
|
|
23
54
|
|
|
24
55
|
const title = `${doc.title} - ${cfg.site.siteName}`;
|
|
25
56
|
const description = doc.excerpt;
|
|
26
|
-
|
|
27
|
-
const
|
|
28
|
-
|
|
29
|
-
"@type": "Article",
|
|
30
|
-
headline: doc.title,
|
|
31
|
-
author: { "@type": "Person", name: cfg.site.authorName },
|
|
32
|
-
datePublished: doc.datePublished,
|
|
33
|
-
image: ogImageUrl,
|
|
34
|
-
mainEntityOfPage: canonicalUrl,
|
|
35
|
-
};
|
|
57
|
+
const schemaType = resolveSchemaType(cfg, doc);
|
|
58
|
+
const ogType = schemaType === "WebPage" ? "website" : "article";
|
|
59
|
+
const jsonLd = buildJsonLd(schemaType, cfg, doc, canonicalUrl, ogImageUrl);
|
|
36
60
|
|
|
37
61
|
// NOTE: doc.htmlContent is already HTML from markdown-it.
|
|
38
62
|
// We trust it as generated output, not user-injected raw HTML (markdown-it html:false).
|
|
@@ -46,7 +70,7 @@ export function renderPageHtml(cfg: RenderShieldConfig, doc: MarkdownDoc): strin
|
|
|
46
70
|
<meta name="description" content="${escapeHtml(description)}">
|
|
47
71
|
<link rel="canonical" href="${escapeHtml(canonicalUrl)}">
|
|
48
72
|
|
|
49
|
-
<meta property="og:type" content="
|
|
73
|
+
<meta property="og:type" content="${ogType}">
|
|
50
74
|
<meta property="og:title" content="${escapeHtml(doc.title)}">
|
|
51
75
|
<meta property="og:description" content="${escapeHtml(description)}">
|
|
52
76
|
<meta property="og:image" content="${escapeHtml(ogImageUrl)}">
|