From bcb5b2df09cb8c8fc0736ec476b2486f9b4643be Mon Sep 17 00:00:00 2001
From: Emile Bangma <ewjbangma@hotmail.com>
Date: Mon, 04 Mar 2024 17:52:28 +0000
Subject: [PATCH] feat(frontmatter): configure max length for description (#946)
---
quartz/plugins/transformers/description.ts | 90 ++++++++++++++++++++++++++++----------------
1 files changed, 57 insertions(+), 33 deletions(-)
diff --git a/quartz/plugins/transformers/description.ts b/quartz/plugins/transformers/description.ts
index 065d3bf..0f8cd8d 100644
--- a/quartz/plugins/transformers/description.ts
+++ b/quartz/plugins/transformers/description.ts
@@ -1,54 +1,78 @@
-import { PluggableList } from "unified"
-import { Root as HTMLRoot } from 'hast'
+import { Root as HTMLRoot } from "hast"
import { toString } from "hast-util-to-string"
import { QuartzTransformerPlugin } from "../types"
+import { escapeHTML } from "../../util/escape"
export interface Options {
descriptionLength: number
+ replaceExternalLinks: boolean
}
const defaultOptions: Options = {
- descriptionLength: 150
+ descriptionLength: 150,
+ replaceExternalLinks: true,
}
-export class Description extends QuartzTransformerPlugin {
- name = "Description"
- opts: Options
+const urlRegex = new RegExp(
+ /(https?:\/\/)?(?<domain>([\da-z\.-]+)\.([a-z\.]{2,6})(:\d+)?)(?<path>[\/\w\.-]*)(\?[\/\w\.=&;-]*)?/,
+ "g",
+)
- constructor(opts?: Options) {
- super()
- this.opts = { ...defaultOptions, ...opts }
- }
+export const Description: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+ const opts = { ...defaultOptions, ...userOpts }
+ return {
+ name: "Description",
+ htmlPlugins() {
+ return [
+ () => {
+ return async (tree: HTMLRoot, file) => {
+ let frontMatterDescription = file.data.frontmatter?.description
+ let text = escapeHTML(toString(tree))
- markdownPlugins(): PluggableList {
- return []
- }
+ if (opts.replaceExternalLinks) {
+ frontMatterDescription = frontMatterDescription?.replace(
+ urlRegex,
+ "$<domain>" + "$<path>",
+ )
+ text = text.replace(urlRegex, "$<domain>" + "$<path>")
+ }
- htmlPlugins(): PluggableList {
- return [
- () => {
- return async (tree: HTMLRoot, file) => {
- const frontMatterDescription = file.data.frontmatter?.description
- const desc = frontMatterDescription ?? toString(tree)
- const sentences = desc.replace(/\s+/g, ' ').split('.')
- let finalDesc = ""
- let sentenceIdx = 0
- const len = this.opts.descriptionLength
- while (finalDesc.length < len) {
- finalDesc += sentences[sentenceIdx] + '.'
- sentenceIdx++
+ const desc = frontMatterDescription ?? text
+ const sentences = desc.replace(/\s+/g, " ").split(/\.\s/)
+ let finalDesc = ""
+ let sentenceIdx = 0
+ const len = opts.descriptionLength
+
+ if (sentences[0] !== undefined && sentences[0].length >= len) {
+ const firstSentence = sentences[0].split(" ")
+ while (finalDesc.length < len) {
+ const sentence = firstSentence[sentenceIdx]
+ if (!sentence) break
+ finalDesc += sentence + " "
+ sentenceIdx++
+ }
+ finalDesc = finalDesc.trimEnd() + "..."
+ } else {
+ while (finalDesc.length < len) {
+ const sentence = sentences[sentenceIdx]
+ if (!sentence) break
+ finalDesc += sentence.endsWith(".") ? sentence : sentence + "."
+ sentenceIdx++
+ }
+ }
+
+ file.data.description = finalDesc
+ file.data.text = text
}
-
- file.data.description = finalDesc
- }
- }
- ]
+ },
+ ]
+ },
}
}
-declare module 'vfile' {
+declare module "vfile" {
interface DataMap {
description: string
+ text: string
}
}
-
--
Gitblit v1.10.0