forked from docsifyjs/docsify
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathutils.js
More file actions
114 lines (102 loc) · 3.11 KB
/
Copy pathutils.js
File metadata and controls
114 lines (102 loc) · 3.11 KB
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/**
* Converts a colon formatted string to a object with properties.
*
* This is process a provided string and look for any tokens in the format
* of `:name[=value]` and then convert it to a object and return.
* An example of this is ':include :type=code :fragment=demo' is taken and
* then converted to:
*
* ```
* {
* include: '',
* type: 'code',
* fragment: 'demo'
* }
* ```
*
* @param {string} str The string to parse.
*
* @return {{str: string, config: Record<string, string | string[]>}} The original string formatted, and parsed object, { str, config }.
*/
export function getAndRemoveConfig(str = '') {
/** @type {Record<string, string | string[]>} */
const config = {};
if (str) {
str = str
.replace(/^('|")/, '')
.replace(/('|")$/, '')
.replace(/(?:^|\s):([\w-]+:?)=?([\w-%]+)?/g, (m, key, value) => {
if (key.indexOf(':') !== -1) {
return m;
}
value = (value && value.replace(/"/g, '')) || true;
if (value !== true && config[key] !== undefined) {
if (!Array.isArray(config[key]) && value !== config[key]) {
config[key] = [config[key]];
}
config[key].includes(value) ||
/** @type {string[]} */ (config[key]).push(value);
} else {
config[key] = value;
}
return '';
})
.trim();
}
return { str, config };
}
/**
* Remove the <a> tag from sidebar when the header with link, details see issue 1069
* @param {string} str The string to deal with.
*
* @return {string} The string after delete the <a> element.
*/
export function removeAtag(str = '') {
return str.replace(/(<\/?a.*?>)/gi, '');
}
/**
* Remove the docsifyIgnore configs and return the str
* @param {string} content The string to deal with.
*
* @return {{content: string, ignoreAllSubs: boolean, ignoreSubHeading: boolean}} The string after delete the docsifyIgnore configs, and whether to ignore some or all.
*/
export function getAndRemoveDocsifyIgnoreConfig(content = '') {
let ignoreAllSubs, ignoreSubHeading;
if (/<!-- {docsify-ignore} -->/g.test(content)) {
content = content.replace('<!-- {docsify-ignore} -->', '');
ignoreSubHeading = true;
}
if (/{docsify-ignore}/g.test(content)) {
content = content.replace('{docsify-ignore}', '');
ignoreSubHeading = true;
}
if (/<!-- {docsify-ignore-all} -->/g.test(content)) {
content = content.replace('<!-- {docsify-ignore-all} -->', '');
ignoreAllSubs = true;
}
if (/{docsify-ignore-all}/g.test(content)) {
content = content.replace('{docsify-ignore-all}', '');
ignoreAllSubs = true;
}
return /** @type {{content: string, ignoreAllSubs: boolean, ignoreSubHeading: boolean}} */ ({
content,
ignoreAllSubs,
ignoreSubHeading,
});
}
/**
* Escape HTML special characters in a string to prevent XSS attacks.
*
* @param string
* @returns {string}
*/
export function escapeHtml(string) {
const entityMap = {
'&': '&',
'<': '<',
'>': '>',
'"': '"',
"'": ''',
};
return String(string).replace(/[&<>"']/g, s => entityMap[s]);
}