-
Notifications
You must be signed in to change notification settings - Fork 10
/
functions.ts
242 lines (219 loc) · 5.47 KB
/
functions.ts
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
import {
CLEAN_EXPLICIT_FILTER_RULES,
FEATURE_FILTER_RULES,
LIVE_FILTER_RULES,
NORMALIZE_FEATURE_FILTER_RULES,
PARODY_FILTER_RULES,
REISSUE_FILTER_RULES,
REMASTERED_FILTER_RULES,
SUFFIX_FILTER_RULES,
TRIM_SYMBOLS_FILTER_RULES,
VERSION_FILTER_RULES,
YOUTUBE_TRACK_FILTER_RULES,
VARIOUS_ARTISTS_FILTER_RULES,
FilterRule,
ADDITIONAL_ARTISTS_FILTER_RULES,
} from './rules';
const escapeHtmlEntityMap: Record<string, RegExp> = {
'&': /&/g,
'<': /</g,
'>': />/g,
'"': /"/g,
};
/**
* Generate Album Artist from Artist when "feat. Artist B" is present.
*
* @param text String to be filtered
*
* @return Transformed string
*/
export function albumArtistFromArtist(text: string): string {
if (text.includes(' feat. ')) {
return text.split(' feat. ')[0];
}
return text;
}
/**
* Decode HTML entities in given text string.
*
* @param text String with HTML entities
*
* @return Decoded string
*/
export function decodeHtmlEntities(text: string): string {
let filteredText = text;
for (const target in escapeHtmlEntityMap) {
const source = escapeHtmlEntityMap[target];
filteredText = filteredText.replace(source, target);
}
filteredText = filteredText.replace(/&#x([a-fA-f0-9]+);/g, (_, hex) => {
const dec = parseInt(hex, 16);
return String.fromCharCode(dec);
});
filteredText = filteredText.replace(/&#(\d+);/g, (_, dec) => {
return String.fromCharCode(dec);
});
return filteredText;
}
/**
* Replace text according to given filter rules.
*
* @param text String to be filtered
* @param filterRules Array of replace rules
*
* @return Filtered string
*/
export function filterWithFilterRules(
text: string,
filterRules: FilterRule[]
): string {
return filterRules.reduce((text, filterRule) => {
const { source, target } = filterRule;
return text.replace(source, target);
}, text);
}
/**
* Replace "Title - X Remix" suffix with "Title (X Remix) and similar".
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function fixTrackSuffix(text: string): string {
return filterWithFilterRules(text, SUFFIX_FILTER_RULES);
}
/**
* Replace "Various Artists something goes here" with "Various Artists".
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function fixVariousArtists(text: string): string {
return filterWithFilterRules(text, VARIOUS_ARTISTS_FILTER_RULES);
}
/**
* Generate normalized "feat. Artist B" text from [feat. Artist B] style.
*
* @param text String to be filtered
*
* @return Transformed string
*/
export function normalizeFeature(text: string): string {
return filterWithFilterRules(text, NORMALIZE_FEATURE_FILTER_RULES);
}
/**
* Remove "Explicit" and "Clean"-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeCleanExplicit(text: string): string {
return filterWithFilterRules(text, CLEAN_EXPLICIT_FILTER_RULES);
}
/**
* Remove "feat"-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeFeature(text: string): string {
return filterWithFilterRules(text, FEATURE_FILTER_RULES);
}
/**
* Remove "&" and "x"-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeAdditionalArtists(text: string): string {
return filterWithFilterRules(text, ADDITIONAL_ARTISTS_FILTER_RULES);
}
/**
* Remove "Live..."-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeLive(text: string): string {
return filterWithFilterRules(text, LIVE_FILTER_RULES);
}
/**
* Remove "(Parody of "X" by Y)"-like strings from the text.
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeParody(text: string): string {
return filterWithFilterRules(text, PARODY_FILTER_RULES);
}
export function removeReissue(text: string): string {
return filterWithFilterRules(text, REISSUE_FILTER_RULES);
}
/**
* Remove "Remastered..."-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeRemastered(text: string): string {
return filterWithFilterRules(text, REMASTERED_FILTER_RULES);
}
/**
* Remove "(Single|Album|Mono version}"-like strings from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeVersion(text: string): string {
return filterWithFilterRules(text, VERSION_FILTER_RULES);
}
/**
* Remove zero-width characters from given string.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function removeZeroWidth(text: string): string {
return text.replace(/[\u200B-\u200D\uFEFF]/g, '');
}
/**
* Replace all non-breaking space symbols with a space symbol.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function replaceNbsp(text: string): string {
return text.replace(/\u00a0/g, '\u0020');
}
/**
* Remove Youtube-related garbage from the text.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function youtube(text: string): string {
return filterWithFilterRules(text, [
...YOUTUBE_TRACK_FILTER_RULES,
...TRIM_SYMBOLS_FILTER_RULES,
]);
}
/**
* Replace smart quotes with regular quotes.
*
* @param text String to be filtered
*
* @return Filtered string
*/
export function replaceSmartQuotes(text: string): string {
return text.replace(/[\u2018\u2019]/g, "'").replace(/[\u201c\u201d]/g, '"');
}