plugin integration round 2

Jacky Zhao

2023-05-30 ad6ce0d73fbd015e00e59ec30bda3cc8de777832

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
import { PluggableList } from "unified"
import { Root as HTMLRoot } from 'hast'
import { toString } from "hast-util-to-string"
import { QuartzTransformerPlugin } from "../types"
 
export interface Options {
  descriptionLength: number
}
 
const defaultOptions: Options = {
  descriptionLength: 150
}
 
export class Description extends QuartzTransformerPlugin {
  name = "Description"
  opts: Options
 
  constructor(opts?: Options) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
 
  markdownPlugins(): PluggableList {
    return []
  }
 
  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++
          }
 
          file.data.description = finalDesc
        }
      }
    ]
  }
}
 
declare module 'vfile' {
  interface DataMap {
    description: string
  }
}