GithubHelp home page GithubHelp logo

mtxadmin / hufilter-dev Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hufilter/hufilter-dev

0.0 0.0 0.0 687 KB

Hungarian adblock filter list / magyar adblock szűrőlista

License: Creative Commons Attribution 4.0 International

JavaScript 100.00%

hufilter-dev's Introduction

 

hufilter logo light mode hufilter logo dark mode

License: CC BY 4.0 Workflow state

Hufilter fejlesztői dokumentáció

Ez a leírás tartalmazza a fejlesztéshez szükséges főbb tudnivalókat. Kérjük, hogy olvasd el, ha munkáddal hozzá szeretnél járulni a hufilter projekthez!

Projekt szerkezete

Ez a fejezet ismerteti a hufilter projektben található fájlokat és könyvtárakat, valamint azok szerepét.

  • sections mappa
    • Ha közreműködsz, az érdemi fejlesztés ebben a mappában történik.
    • Itt gyűjtjük a szűrési szabályokat, különböző kategóriákra, szekciókra bontva. Egy fájl egy szekciót jelent.
    • Mindegyik fájlhoz meghatároztuk a szintaxist, erre kérjük, hogy figyelj oda!
    • ads.txt
      • Adblock Plus szintaxis
      • Hirdetéseket blokkoló szabályok
      • Különböző elemzőrendszereket, nyomkövetési technikákat blokkoló szabályok
    • ad-servers.txt
      • Adblock Plus szintaxis
      • Hirdetési szervereket blokkoló szabályok
    • annoyances.txt
      • Adblock Plus szintaxis
      • Kellemetlenségeket blokkoló szabályok
        • Ezek nem reklámok, inkább csak zavaró, ha vannak. Ilyen például:
          • Felugró ablakok, értesítések
          • Cookie értesítő ablakok, sávok
          • Becsúszó ajánlók
          • stb.
    • adguard-specific.txt
      • AdGuard szintaxis
      • Olyan szabályok, amiket csak az AdGuard tud értelmezni
      • Ezekből a szabályokból nincs sok, így ezen a fájlon belül szedjük szét őket kategóriákra
      • Előfordulhat, hogy egy sima ABP szabály csak egy speciális szabállyal együtt működik, ilyenkor a sima szabály is ide kerüljön (pl. ha elrejted a popupot sima szabállyal, de a háttér ottmarad, amihez class remove kell)
    • ublock-specific.txt
      • uBlock Origin szintaxis
      • Olyan szabályok, amiket csak az uBlock Origin tud értelmezni
      • Ezekből a szabályokból nincs sok, így ezen a fájlon belül szedjük szét őket kategóriákra
      • Előfordulhat, hogy egy sima ABP szabály csak egy speciális szabállyal együtt működik, ilyenkor a sima szabály is ide kerüljön (pl. ha elrejted a popupot sima szabállyal, de a háttér ottmarad, amihez class remove kell)
    • other.txt
      • Adblock Plus szintaxis
      • Minden olyan szabály, ami a fenti kategóriákba nem esik bele
  • A projekt további fájljai, mappái:
    • Ezek kevésbé fontosak, ha csak szűrési szabályokat szeretnél beküldeni
    • headers mappa
      • Az egyes szűrők elején megjelenő fejléceket tartalmazza, minden reklámblokkolóhoz külön beállítva.
      • Ezeket a header fájlokat szinte alig, vagy egyáltalán nem kell módosítani.
    • filters.json
      • Egy leíró fájl, a build script ez alapján készíti el a szőrőlistákat. Megadja, hogy az egyes szűrőlistákba melyik header, majd pedig melyik szekciók kerüljenek.
    • build.js
      • Ez a script végzi el a build folyamatot a filters.json fájl alapján.
    • test.js
      • Miután a build script lefutott, ez a script végzi el a tesztelést a kész szűrőlistákon.
    • RELEASE_README.md
      • A másik repo-ba ez a leírás fog megjelenni README.md-ként.

Szintaxisok, dokumentációk

Itt összegyűjtöttük az említett hirdetésblokkolók szintaxisait segítségképpen.

Build folyamat

  1. fázis:
    • Amikor push érkezik a hufilter-dev repoba, akkor a build folyamat automatikusan megtörténik a módosítások alapján.
  2. fázis:
    • Miután a build összeállította a szűrőlistákat, lefut egy tesztelő script, ami megtöri a folyamatot, hogyha hibát talál. Így nyilvánvalóan hibás szűrőlista nem tud kikerülni az éles kiadások közé.
  3. fázis:
    • Ha a szűrőlisták átmennek a tesztelésen, akkor felkerülnek ebbe a repo-ba:
    • A jelenlegi szűrőlisták:
      • hufilter.txt / hufilter-abp.txt
        • Kifejezetten az Adblock Plus-hoz készült változatok.
        • A hufilter.txt csak hirdetéseket blokkol, a hufilter-abp.txt pedig követőket, egyéb zavaró tartalmi elemeket is.
      • hufilter-adguard.txt
        • Kifejezetten az AdGuard-hoz készült változat.
        • Az összes AdGuard termék alapból tartalmazza nyelvspecifikus szűrőként.
      • hufilter-ublock.txt
        • Kifejezetten az uBlock Origin-hez készült változat.
        • Az uBlock Origin alapból tartalmazza nyelvspecifikus szűrőként.
      • hufilter-dns.txt
        • Kifejezetten hálózati szintű blokkoláshoz készült változat (pl. AdGuard Home, Pi-hole, stb.)
        • Az AdGuard Home alapból tartalmazza nyelvspecifikus szűrőként.

VSCode segítség

  • A Visual Studio Code programot ajánljuk alapértelmezett szerkesztőnek, ezzel a bővítménnyel: https://marketplace.visualstudio.com/items?itemName=adguard.adblock
    • Ez ugyanis tudja kezelni az ABP szabályok szintaxisainak a nagy részét, a highlight (szövegkiemelés) által pedig átláthatóbbá és könnyebben fejleszthetővé teszi a kódot.

hufilter-dev's People

Contributors

csillaggyujto avatar dandelionsprout avatar danielstreba avatar decentm avatar draxvint avatar enkeyz avatar eshton avatar gaboom avatar herczegzsolt avatar lezso6 avatar resike avatar rmanbio avatar scripthunter7 avatar szpeter80 avatar tacsipacsi avatar web-flow avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.