| | |
| | | import { PluggableList } from "unified" |
| | | import { Root as HTMLRoot } from 'hast' |
| | | import { toString } from "hast-util-to-string" |
| | | import { QuartzTransformerPlugin } from "../types" |
| | |
| | | descriptionLength: 150 |
| | | } |
| | | |
| | | export class Description extends QuartzTransformerPlugin { |
| | | name = "Description" |
| | | opts: Options |
| | | const escapeHTML = (unsafe: string) => { |
| | | return unsafe.replaceAll('&', '&').replaceAll('<', '<').replaceAll('>', '>').replaceAll('"', '"').replaceAll("'", '''); |
| | | } |
| | | |
| | | constructor(opts?: Partial<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) => { |
| | | const frontMatterDescription = file.data.frontmatter?.description |
| | | const text = escapeHTML(toString(tree)) |
| | | |
| | | markdownPlugins(): PluggableList { |
| | | return [] |
| | | } |
| | | const desc = frontMatterDescription ?? text |
| | | const sentences = desc.replace(/\s+/g, ' ').split('.') |
| | | let finalDesc = "" |
| | | let sentenceIdx = 0 |
| | | const len = opts.descriptionLength |
| | | while (finalDesc.length < len) { |
| | | finalDesc += sentences[sentenceIdx] + '.' |
| | | sentenceIdx++ |
| | | } |
| | | |
| | | htmlPlugins(): PluggableList { |
| | | return [ |
| | | () => { |
| | | return async (tree: HTMLRoot, file) => { |
| | | const frontMatterDescription = file.data.frontmatter?.description |
| | | const text = toString(tree) |
| | | |
| | | const desc = frontMatterDescription ?? text |
| | | 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++ |
| | | file.data.description = finalDesc |
| | | file.data.text = text |
| | | } |
| | | |
| | | file.data.description = finalDesc |
| | | file.data.text = text |
| | | } |
| | | } |
| | | ] |
| | | ] |
| | | } |
| | | } |
| | | } |
| | | |