mirror of
https://github.com/alrayyes/wiki.git
synced 2024-11-25 04:56:23 +00:00
feat(frontmatter): configure max length for description (#946)
* Sentence length check * Replace external links with domain name. * Updated documentation. * Updated replacement values. * Updated Regex based on feedback. * Check description for undefined * Updated external url transform regex. * Updated formatting
This commit is contained in:
parent
bd05950c2d
commit
bcb5b2df09
2 changed files with 36 additions and 8 deletions
|
@ -14,6 +14,7 @@ If the frontmatter contains a `description` property, it is used (see [[authorin
|
||||||
This plugin accepts the following configuration options:
|
This plugin accepts the following configuration options:
|
||||||
|
|
||||||
- `descriptionLength`: the maximum length of the generated description. Default is 150 characters. The cut off happens after the first _sentence_ that ends after the given length.
|
- `descriptionLength`: the maximum length of the generated description. Default is 150 characters. The cut off happens after the first _sentence_ that ends after the given length.
|
||||||
|
- `replaceExternalLinks`: If `true` (default), replace external links with their domain and path in the description (e.g. `https://domain.tld/some_page/another_page?query=hello&target=world` is replaced with `domain.tld/some_page/another_page`).
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
|
|
|
@ -5,12 +5,19 @@ import { escapeHTML } from "../../util/escape"
|
||||||
|
|
||||||
export interface Options {
|
export interface Options {
|
||||||
descriptionLength: number
|
descriptionLength: number
|
||||||
|
replaceExternalLinks: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
const defaultOptions: Options = {
|
const defaultOptions: Options = {
|
||||||
descriptionLength: 150,
|
descriptionLength: 150,
|
||||||
|
replaceExternalLinks: true,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const urlRegex = new RegExp(
|
||||||
|
/(https?:\/\/)?(?<domain>([\da-z\.-]+)\.([a-z\.]{2,6})(:\d+)?)(?<path>[\/\w\.-]*)(\?[\/\w\.=&;-]*)?/,
|
||||||
|
"g",
|
||||||
|
)
|
||||||
|
|
||||||
export const Description: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
|
export const Description: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
|
||||||
const opts = { ...defaultOptions, ...userOpts }
|
const opts = { ...defaultOptions, ...userOpts }
|
||||||
return {
|
return {
|
||||||
|
@ -19,19 +26,39 @@ export const Description: QuartzTransformerPlugin<Partial<Options> | undefined>
|
||||||
return [
|
return [
|
||||||
() => {
|
() => {
|
||||||
return async (tree: HTMLRoot, file) => {
|
return async (tree: HTMLRoot, file) => {
|
||||||
const frontMatterDescription = file.data.frontmatter?.description
|
let frontMatterDescription = file.data.frontmatter?.description
|
||||||
const text = escapeHTML(toString(tree))
|
let text = escapeHTML(toString(tree))
|
||||||
|
|
||||||
|
if (opts.replaceExternalLinks) {
|
||||||
|
frontMatterDescription = frontMatterDescription?.replace(
|
||||||
|
urlRegex,
|
||||||
|
"$<domain>" + "$<path>",
|
||||||
|
)
|
||||||
|
text = text.replace(urlRegex, "$<domain>" + "$<path>")
|
||||||
|
}
|
||||||
|
|
||||||
const desc = frontMatterDescription ?? text
|
const desc = frontMatterDescription ?? text
|
||||||
const sentences = desc.replace(/\s+/g, " ").split(".")
|
const sentences = desc.replace(/\s+/g, " ").split(/\.\s/)
|
||||||
let finalDesc = ""
|
let finalDesc = ""
|
||||||
let sentenceIdx = 0
|
let sentenceIdx = 0
|
||||||
const len = opts.descriptionLength
|
const len = opts.descriptionLength
|
||||||
while (finalDesc.length < len) {
|
|
||||||
const sentence = sentences[sentenceIdx]
|
if (sentences[0] !== undefined && sentences[0].length >= len) {
|
||||||
if (!sentence) break
|
const firstSentence = sentences[0].split(" ")
|
||||||
finalDesc += sentence + "."
|
while (finalDesc.length < len) {
|
||||||
sentenceIdx++
|
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.description = finalDesc
|
||||||
|
|
Loading…
Reference in a new issue