codecopy / ublacklist

Blocks specific sites from appearing in Google search results

uBlacklist

Blocks specific sites from appearing in Google search results

Chrome Web Store / Firefox Add-ons

Description

This browser extension prevents blacklisted sites from appearing in Google search results.

You can add rules on search result pages, or on sites to be blocked by clicking the toolbar icon. Rules can be specified either by match patterns (e.g. *://*.example.com/*) or by regular expressions (e.g. /example\.(net|org)/).

For subscription providers

To publish a blacklist as a subscription, place a blacklist file encoded in UTF-8 on a suitable HTTP(S) server, and publish the URL. Here is an example hosted on GitHub.

For developers

Build

To build this extension, Node.js and Yarn are required.

git clone https://github.com/iorate/uBlacklist.git

cd uBlacklist

yarn

yarn build:firefox:production

NOTE: The API keys and secrets for the sync feature are not included in this repository. To develop the sync feature, set your own API keys and secrets in the .env file.

DROPBOX_API_KEY=...
DROPBOX_API_SECRET=...
GOOGLE_DRIVE_API_KEY=...
GOOGLE_DRIVE_API_SECRET=...

Engine

To add support for a search engine other than Google,

1. Determine a search engine ID.
2. Create src/scripts/search-engines/${searchEngineId}.ts and export an object of type SearchEngine.
3. Open src/scripts/types.ts and update SearchEngineId.
4. Open src/scripts/supported-search-engine.ts and update supportedSearchEngines.

Locale

To add a locale,

1. Determine an ISO language code such as en referring to kLanguageInfoTable.
2. Copy src/locales/en.json.ts to src/locales/${languageCode}.json.ts and translate entries.
3. If you translated dayjsLocale, open src/scripts/dayjs-locales.ts and update imports.
4. To localize description and screenshots on Chrome Web Store and Firefox Add-ons, create web-store-assets/${languageCode}/ and add files.

Author

iorate (Twitter)

License

uBlacklist is licensed under MIT License.