-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f99d448
commit d666d1b
Showing
7 changed files
with
818 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export * from './excerpt.js' | ||
| export * from './text.js' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| // eslint-disable-next-line vue/prefer-import-from-vue | ||
| import { isHTMLTag } from '@vue/shared' | ||
| import type { AnyNode } from 'cheerio' | ||
| import { load } from 'cheerio' | ||
| import type { App, Page } from 'vuepress/core' | ||
| import {} from 'vuepress/shared' | ||
| import { isArray } from '../../shared/index.js' | ||
|
|
||
| const MEDIA_WITH_ALT = ['img'] | ||
|
|
||
| const REMOVED_TAGS = [ | ||
| // non content | ||
| 'title', | ||
| 'base', | ||
| 'meta', | ||
| 'template', | ||
| 'script', | ||
| 'style', | ||
| 'canvas', | ||
| 'slot', | ||
|
|
||
| // not main content | ||
| 'nav', | ||
| 'aside', | ||
| 'footer', | ||
|
|
||
| // deleted | ||
| 'del', | ||
| 's', | ||
|
|
||
| // rich media | ||
| 'audio', | ||
| 'video', | ||
| 'canvas', | ||
| 'iframe', | ||
| 'map', | ||
| 'area', | ||
| 'track', | ||
| 'object', | ||
|
|
||
| // input | ||
| 'input', | ||
| 'textarea', | ||
| 'select', | ||
| 'option', | ||
| 'optgroup', | ||
| 'datalist', | ||
| ] | ||
|
|
||
| export interface PageTextOptions { | ||
| /** | ||
| * Whether convert text to single line content | ||
| * | ||
| * 是否将文字转换成单行内容 | ||
| * | ||
| * @default false | ||
| */ | ||
| singleLine?: boolean | ||
|
|
||
| /** | ||
| * Length of text | ||
| * | ||
| * @description Text length will be the minimal possible length reaching this value | ||
| * | ||
| * 文字的长度 | ||
| * | ||
| * @description 文字的长度会尽可能的接近这个值 | ||
| * | ||
| * @default 300 | ||
| */ | ||
| length?: number | ||
|
|
||
| /** | ||
| * Tags to be removed | ||
| * | ||
| * @description Table and code blocks are removed by default. | ||
| * | ||
| * 需要移除的标签 | ||
| * | ||
| * @description 默认情况下表格和代码块会被移除 | ||
| * | ||
| * @default ['table', 'pre'] | ||
| */ | ||
| removedTags?: string[] | ||
| } | ||
|
|
||
| interface NodeOptions { | ||
| base: string | ||
| removedTags: string[] | ||
| } | ||
|
|
||
| const handleNode = ( | ||
| node: AnyNode, | ||
| { base, removedTags }: NodeOptions, | ||
| ): string => { | ||
| if (node.type === 'tag') { | ||
| // toc should be dropped | ||
| if ( | ||
| [node.attribs.class, node.attribs.id].some((item) => | ||
| ['table-of-contents', 'toc'].includes(item), | ||
| ) | ||
| ) | ||
| return '' | ||
|
|
||
| // return alt text | ||
| if (MEDIA_WITH_ALT.includes(node.tagName)) { | ||
| return node.attribs.alt || '' | ||
| } | ||
|
|
||
| // html tags can be returned | ||
| if ( | ||
| !REMOVED_TAGS.includes(node.tagName) && | ||
| !removedTags.includes(node.tagName) && | ||
| isHTMLTag(node.tagName) | ||
| ) { | ||
| return handleNodes(node.children, { base, removedTags }) | ||
| } | ||
|
|
||
| return '' | ||
| } | ||
|
|
||
| if (node.type === 'text') return node.data | ||
|
|
||
| return '' | ||
| } | ||
|
|
||
| const handleNodes = ( | ||
| nodes: AnyNode[] | null, | ||
| { base, removedTags }: NodeOptions, | ||
| ): string => | ||
| isArray(nodes) | ||
| ? nodes.map((node) => handleNode(node, { base, removedTags })).join('') | ||
| : '' | ||
|
|
||
| const $ = load('') | ||
|
|
||
| export const getPageText = ( | ||
| { options: { base } }: App, | ||
| { contentRendered }: Page, | ||
| { | ||
| length = 300, | ||
| singleLine, | ||
| removedTags = ['table', 'pre'], | ||
| }: PageTextOptions = {}, | ||
| ): string => { | ||
| let result = '' | ||
| const rootNodes = $.parseHTML(contentRendered) || [] | ||
|
|
||
| for (const node of rootNodes) { | ||
| const text = handleNode(node, { base, removedTags }) | ||
|
|
||
| if (text) { | ||
| result += text | ||
| if (text.length >= length) break | ||
| } | ||
| } | ||
|
|
||
| return singleLine ? result.replace(/\n/g, ' ').replace(/\s+/g, ' ') : result | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.