webViper

vipe the web using the webViper!

webViper in short

webViper is a highly configureable element removal/cleaner for the web.

Usage options for the viper

• webViper-userScript.js for usage with a browser "userscript"-addons like Tampermonkey, Violentmonkey (currently recommended!)

• webViper in the folder addon-srcs to load as temporary addon/extension in Firefox about:debugging, This Firefox and Load temporary extension. This is only for testing the UI for now, but rules, keywords and entered details are already applied, as long as the extension is installed. Since there is no export, it is recommended to try out the UI, but do not enter a lot of information, those would be lost on uninstall/removal.

Screenshot of a wiped item

Filter rules, how to get clearing out working

webViper sources have comments, but to make things easy, here they are. The definition for a website is in const ruleSet = { ... }, here a example:

//
// Small config rules inside "ruleSet"
//
// const ruleSet = {
//
    // A url which identifies the website
    'websiteURL.net': {
        keywords: [
            // 'keyword1',
            // 'keyword2',
        ],
        excludes: [
            // Can be empty
            // 'exlucde1',
            // 'exlucde2'
        ],
        elementContainers: {
            // CSSselector1: ['cssSelectorParent1', 'cssSelectorParent2'],
            // CSSselector2: ['cssSelectorParent1', 'cssSelectorParent2']
            //
            // For example:
            // a: ['article.stage-teaser', '.news-ticker-item'],
            // 'a.stage-teaser__anchor': ['article.stage-teaser', '.news-ticker-item'],
            // 'img.classNameClass': ['article.stage-teaser']
            //
            // You could also use:
            // 'img#id': ['.className1', '#id']
            // 'img.className': ['.className1', '#id']
            //
        },
        removeElement: true
    }
//
// }
//

Rule template

For easier editing, the file webViper-rule-template.js contains a basic template for easy copy and paste into the userscript and script file.

Video guide on how to add new rules

A video demonstration how to add and extend the ruleSet rules and identify a cleaning item.

webViper-Rules-How-To.mp4

Help, support and issues or bugs

Please create a issue, with the website url and the keyword(s) which you want to be viped out.

Note: If the website changes/updates in between, you might - in advance - add two screenshots. One screenshot of page in your browser showing the content in question and one with the HTML markup with the offending content in HTML inside the webdeveloper console. Usually the webdeveloper console can be opened using, usually, the F12-key from within your browser (Firefox, Chrome...).

The issue can be reported at issues: https://github.com/jrie/webViper/issues

Credits and kudos - shoutout!

Everyone at the Laucharme - we are a private group in Telegram, but if you know German or English, we can surely arrange a invite if you are keen to get in touch: We are cool, of course!

And this fantastic cover art?

The source of the nice viper image is of https://reptilesmagazine.com - I just made some post artwork.