feat: add disable_html_sanitization frontmatter option (#114)

denoland · Feb 3, 2023 · 0a43328 · 0a43328 · capogreco · Mar 4, 2023
1 parent 06641e4
commit 0a43328
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 17 deletions.
diff --git a/blog.tsx b/blog.tsx
@@ -8,6 +8,7 @@
 
 import {
   callsites,
+  ColorScheme,
   createReporter,
   dirname,
   Feed,
@@ -101,6 +102,7 @@ function errorHandler(err: unknown) {
  */
 export default async function blog(settings?: BlogSettings) {
   html.use(UnoCSS(settings?.unocss)); // Load custom unocss module if provided
+  html.use(ColorScheme("auto"));
 
   const url = callsites()[1].getFileName()!;
   const blogState = await configureBlog(url, IS_DEV, settings);
@@ -266,6 +268,7 @@ async function loadPost(postsDirectory: string, path: string) {
     ogImage: data.get("og:image"),
     tags: data.get("tags"),
     allowIframes: data.get("allow_iframes"),
+    disableHtmlSanitization: data.get("disable_html_sanitization"),
     readTime: readingTime(content),
   };
   POSTS.set(pathname, post);
@@ -310,7 +313,6 @@ export async function handler(
   }
 
   const sharedHtmlOptions: HtmlOptions = {
-    colorScheme: blogState.theme ?? "auto",
     lang: blogState.lang ?? "en",
     scripts: IS_DEV ? [{ src: "/hmr.js" }] : undefined,
     links: [

diff --git a/blog_test.ts b/blog_test.ts
@@ -5,8 +5,8 @@ import {
   assert,
   assertEquals,
   assertStringIncludes,
-} from "https://deno.land/std@0.171.0/testing/asserts.ts";
-import { fromFileUrl, join } from "https://deno.land/std@0.171.0/path/mod.ts";
+} from "https://deno.land/std@0.176.0/testing/asserts.ts";
+import { fromFileUrl, join } from "https://deno.land/std@0.176.0/path/mod.ts";
 
 const BLOG_URL = new URL("./testdata/main.js", import.meta.url).href;
 const TESTDATA_PATH = fromFileUrl(new URL("./testdata/", import.meta.url));
@@ -138,6 +138,28 @@ Deno.test("posts/ third", async () => {
   assertStringIncludes(body, `<p>Lorem Ipsum is simply dummy text`);
 });
 
+Deno.test("posts/ fourth", async () => {
+  const resp = await testHandler(new Request("https://blog.deno.dev/fourth"));
+  assert(resp);
+  assertEquals(resp.status, 200);
+  assertEquals(resp.headers.get("content-type"), "text/html; charset=utf-8");
+  const body = await resp.text();
+  assertStringIncludes(body, `<html lang="en-GB">`);
+  assertStringIncludes(
+    body,
+    `<link rel="canonical" href="https://blog.deno.dev/fourth" />`,
+  );
+  assertStringIncludes(body, `Fourth post`);
+  assertStringIncludes(
+    body,
+    `<time dateTime="2023-01-30T00:00:00.000Z">`,
+  );
+  assertStringIncludes(
+    body,
+    `<button onclick="alert('hi!')">Click me!!!!!!</button>`,
+  );
+});
+
 Deno.test("posts/ 中文", async () => {
   const resp = await testHandler(new Request("https://blog.deno.dev/中文"));
   assert(resp);

diff --git a/components.tsx b/components.tsx
@@ -166,6 +166,7 @@ interface PostPageProps {
 export function PostPage({ post, state }: PostPageProps) {
   const html = gfm.render(post.markdown, {
     allowIframes: post.allowIframes,
+    disableHtmlSanitization: post.disableHtmlSanitization,
   });
   return (
     <div className={`post ${post.pathname.substring(1)}`}>

diff --git a/deps.ts b/deps.ts
@@ -1,28 +1,29 @@
 // Copyright 2022 the Deno authors. All rights reserved. MIT license.
 
-export { serveDir } from "https://deno.land/std@0.171.0/http/file_server.ts";
-export { walk } from "https://deno.land/std@0.171.0/fs/walk.ts";
+export { serveDir } from "https://deno.land/std@0.176.0/http/file_server.ts";
+export { walk } from "https://deno.land/std@0.176.0/fs/walk.ts";
 export {
   dirname,
   fromFileUrl,
   join,
   relative,
-} from "https://deno.land/std@0.171.0/path/mod.ts";
+} from "https://deno.land/std@0.176.0/path/mod.ts";
 export {
   type ConnInfo,
   serve,
-} from "https://deno.land/std@0.171.0/http/mod.ts";
-export { extract as frontMatter } from "https://deno.land/std@0.171.0/encoding/front_matter.ts";
+} from "https://deno.land/std@0.176.0/http/mod.ts";
+export { extract as frontMatter } from "https://deno.land/std@0.176.0/encoding/front_matter/any.ts";
 
-export * as gfm from "https://deno.land/x/[email protected]/mod.ts";
+export * as gfm from "https://deno.land/x/[email protected]/mod.ts";
+export { Fragment, h } from "https://deno.land/x/[email protected]/mod.ts";
 export {
-  Fragment,
-  h,
-  html,
+  default as html,
   type HtmlOptions,
   type VNode,
-} from "https://deno.land/x/[email protected]/mod.tsx";
-import { UnoCSS } from "https://deno.land/x/[email protected]/plugins.ts";
+} from "https://deno.land/x/[email protected]/html.tsx";
+import UnoCSS from "https://deno.land/x/[email protected]/plugins/unocss.ts";
+import ColorScheme from "https://deno.land/x/[email protected]/plugins/color-scheme.ts";
+
 export {
   createReporter,
   type Reporter as GaReporter,
@@ -34,7 +35,7 @@ export { default as removeMarkdown } from "https://esm.sh/[email protected]"
 // Add syntax highlighting support for C by default
 import "https://esm.sh/[email protected]/components/prism-c?no-check";
 
-export { UnoCSS };
+export { ColorScheme, UnoCSS };
 export type UnoConfig = typeof UnoCSS extends (
   arg: infer P | undefined,
 ) => unknown ? P

diff --git a/init.ts b/init.ts
@@ -1,6 +1,6 @@
 // Copyright 2022 the Deno authors. All rights reserved. MIT license.
 
-import { join, resolve } from "https://deno.land/std@0.171.0/path/mod.ts";
+import { join, resolve } from "https://deno.land/std@0.176.0/path/mod.ts";
 
 const HELP = `deno_blog
 
@@ -71,7 +71,7 @@ const DENO_JSONC_CONTENTS = `{
 const IMPORT_MAP_JSON_NAME = "import_map.json";
 const IMPORT_MAP_JSON_CONTENTS = `{
   "imports": {
-    "blog": "https://deno.land/x/blog@0.4.2/blog.tsx"
+    "blog": "https://deno.land/x/blog@0.5.0/blog.tsx"
   }
 }
 `;

diff --git a/testdata/posts/fourth.md b/testdata/posts/fourth.md
@@ -0,0 +1,10 @@
+---
+title: Fourth post
+publish_date: 2023-01-30
+abstract: Image deno_blog but with unsantized HTML...
+disable_html_sanitization: true
+---
+
+## Cool Button Demo
+
+<button onclick="alert('hi!')">Click me!!!!!!</button>
diff --git a/types.d.ts b/types.d.ts
@@ -97,5 +97,6 @@ export interface Post {
   ogImage?: string;
   tags?: string[];
   allowIframes?: boolean;
+  disableHtmlSanitization?: boolean;
   readTime: number;
 }