//Forked from [[User:Novem Linguae/Scripts/DetectPromo.js]]
//now highlights the words in the article text and those in the top bar are now clickable
// <nowiki>
/*
- Let reviewer know when certain promotional and POV keywords are detected.
- Displays a bar at the top of the article, listing the detected keywords.
- Highlights detected promotional words with a yellow background and red border within the article text.
- Makes the words in the top bar clickable, scrolling to their first occurrence in the article.
*/
class DetectPromo {
/** @type {string[]} */
wordsToSearch = [
'% growth', '6-figure', '7-figure', '8-figure', '9-figure',
'B2B', 'B2C', 'a record', 'acclaimed', 'accomplished',
'are a necessity', 'around the world', 'award winning', 'award-winning',
'beloved', 'best available', 'bestselling', 'boasts', 'comprehensive',
'countless hours', 'create a revolution', 'critical acclaim',
'disrupt', 'drastically', 'dynamic', 'elevate', 'eminent', 'engaging',
'entrepreneur', 'evangelist', 'excelled', 'exceptional', 'exemplified',
'exemplify', 'expert', 'expertise', 'extensive', 'famous', 'fascinating',
'fast growing', 'fast-growing', 'fastest growing', 'fastest-growing',
'finest', 'fully integrated', 'fully-integrated', 'globally',
'globally recognized', 'growing popularity', 'highlights',
'highly accomplished', 'highly praised', 'highly specialized',
'historic', 'honored with', 'hypnotic', 'illustrious', 'impressive',
'indelible', 'inexhaustible', 'influential', 'innovation', 'innovative',
'insights', 'inspired by', 'integrate', 'invaluable', 'leader in',
'leading', 'legendary', 'leverag', 'massive', 'mastermind', 'more than',
'most highly', 'most important', 'most impressive', 'most notable',
'mystical', 'natural charm', 'noteworthy', 'numerous', 'organically',
'outstanding', 'perfect', 'philanthropist', 'picturesque', 'pioneer',
'pioneering', 'popular destination', 'popularity', 'premiere',
'prestigious', 'prominence', 'prominent', 'promising', 'promulgator',
'ranked', 'reinvent', 'remarkable', 'renowed', 'renowned', 'resonating',
'respected', 'revolutionary', 'rising star', 'save millions', 'savvy',
'seamless', 'sensual', 'several offers', 'showcased', 'signature',
'significant', 'soulful', 'spanning', 'state of art', 'state of the art',
'state-of-art', 'state-of-the-art', 'striking', 'super famous',
'tailored', 'tranquility', 'transcend', 'transform', 'underpin',
'ventured into', 'very first', 'visionary', 'wide selection',
'widely used', 'world class', 'world-class', 'worldwide', 'zero to hero'
];
/**
* @param {Object} mw
* @param {jQuery} $
*/
constructor(mw, $) {
this.mw = mw;
this.$ = $;
}
async execute() {
if (!this.shouldRunOnThisPage()) {
return;
}
const title = this.mw.config.get('wgPageName');
const wikicode = await this.getWikicode(title);
if (!wikicode) return;
const cleanedWikicode = this.cleanWikicode(wikicode);
const searchResults = this.getSearchResults(cleanedWikicode);
if (searchResults.length > 0) {
this.displayResults(searchResults);
this.highlightPromoWords(searchResults);
}
}
/**
* @param {string[]} searchResults
*/
displayResults(searchResults) {
const MAX_DISPLAYED_RESULTS = 20;
const displayedResults = searchResults.slice(0, MAX_DISPLAYED_RESULTS);
let html = `
<div id="DetectPromo" style="background-color: #ccc; padding: 10px; margin-bottom: 10px;">
<span style="font-weight: bold;">Promotional words detected:</span>
`;
html += displayedResults.map(word =>
`<a href="#" class="promo-word" data-word="${word}" style="color: blue; text-decoration: underline; cursor: pointer;">${word}</a>`
).join(', ');
if (searchResults.length > MAX_DISPLAYED_RESULTS) {
html += ', ...... and more.';
}
html += '</div>';
this.$('#contentSub').after(html);
// Add click event listeners
this.$('.promo-word').on('click', (e) => {
e.preventDefault();
const word = this.$(e.target).data('word');
this.scrollToWord(word);
});
}
/**
* Scroll to the first occurrence of a word in the article
* @param {string} word
*/
scrollToWord(word) {
const content = this.$('#mw-content-text');
const regex = new RegExp(`\\b${this.escapeRegEx(word)}\\b`, 'i');
const elements = content.find('*').contents().filter(function() {
return this.nodeType === Node.TEXT_NODE && regex.test(this.textContent);
});
if (elements.length > 0) {
const firstOccurrence = elements[0];
firstOccurrence.parentElement.scrollIntoView({ behavior: 'smooth', block: 'center' });
}
}
/**
* Highlight promotional words with yellow background and red border within the article text
* @param {string[]} searchResults
*/
highlightPromoWords(searchResults) {
const content = this.$('#mw-content-text');
const highlightStyle = 'background-color: yellow; border: 1px solid red; padding: 2px; margin: -2px;';
searchResults.forEach(word => {
const regex = new RegExp(`\\b${this.escapeRegEx(word)}\\b`, 'gi');
content.find('*').contents().filter(function() {
return this.nodeType === Node.TEXT_NODE;
}).each((_, textNode) => {
const text = textNode.textContent;
if (regex.test(text)) {
const newHtml = text.replace(regex, `<span class="promo-highlight" data-word="${word}" style="${highlightStyle}">$&</span>`);
const newElement = document.createElement('span');
newElement.innerHTML = newHtml;
textNode.parentNode.replaceChild(newElement, textNode);
}
});
});
}
/**
* @param {string} wikicode
* @return {string[]} searchResults
*/
getSearchResults(wikicode) {
return this.wordsToSearch.filter(word => {
let regEx;
if (word.toLowerCase() === 'leading') {
regEx = new RegExp(`\\bleading\\b(?!\\s+to\\b)`, 'i');
} else {
regEx = new RegExp(`(?<!\\w)${this.escapeRegEx(word)}(?!\\w)`, 'i');
}
return regEx.test(wikicode);
});
}
/**
* @param {string} wikicode
* @return {string} cleanedWikicode
*/
cleanWikicode(wikicode) {
return wikicode
.replace(/\[\[|\]\]/g, '') // Remove [[ ]]
.replace(/<ref[^<]*<\/ref>|<ref[^>]*\/>/gm, ''); // Remove <ref></ref> and <ref />
}
/**
* @return {boolean}
*/
shouldRunOnThisPage() {
const action = this.mw.config.get('wgAction');
const isDiff = this.mw.config.get('wgDiffNewId');
const isDeletedPage = !this.mw.config.get('wgCurRevisionId');
const namespace = this.mw.config.get('wgNamespaceNumber');
const title = this.mw.config.get('wgPageName');
return (
action === 'view' &&
!isDiff &&
!isDeletedPage &&
([0, 118].includes(namespace) || title === 'User:Novem_Linguae/sandbox')
);
}
/**
* @param {string} title
* @return {Promise<string|null>} wikicode
*/
async getWikicode(title) {
try {
const api = new this.mw.Api();
const response = await api.get({
action: 'parse',
page: title,
prop: 'wikitext',
formatversion: '2',
format: 'json'
});
return response.parse.wikitext;
} catch (error) {
console.error('Error fetching wikicode:', error);
return null;
}
}
/**
* @param {string} string
* @return {string} escapedString
*/
escapeRegEx(string) {
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
}
}
$(() => {
mw.loader.using(['mediawiki.api']).then(() => {
new DetectPromo(mw, $).execute();
});
});
// </nowiki>
