Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adguardteam/adguardassistant
Adguard Assistant userscript
https://github.com/adguardteam/adguardassistant
adguard open-source userscript
Last synced: 3 days ago
JSON representation
Adguard Assistant userscript
- Host: GitHub
- URL: https://github.com/adguardteam/adguardassistant
- Owner: AdguardTeam
- License: gpl-3.0
- Created: 2017-03-21T12:42:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T17:33:34.000Z (6 months ago)
- Last Synced: 2024-04-14T05:57:51.919Z (6 months ago)
- Topics: adguard, open-source, userscript
- Language: JavaScript
- Size: 57.4 MB
- Stars: 138
- Watchers: 32
- Forks: 19
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AdGuard Assistant
AdGuard Assistant is a userscript that helps you manage filtering right from the browser. With its aid you are able to manually block any element, whitelist or report the page, or see the website's security report — all without having to leave the current page.
### How to report an issue?
GitHub can be used to report a bug or to submit a feature request. To do so, go to [this page](https://github.com/AdguardTeam/AdguardAssistant/issues) and click the *New issue* button.
### Our plans
To see the 'big picture', to watch current progress and to get an idea of approximate dates for upcoming AdGuard Assistant releases, see this page: https://github.com/AdguardTeam/AdguardAssistant/milestones
### Releases
You can find all AdGuard Assistant releases here: https://github.com/AdguardTeam/AdguardAssistant/releases
### How to build
`yarn install`
| Command | Output Dir |
|-------------------|---------------|
| `yarn dev` | build/dev |
| `yarn beta` | build/beta |
| `yarn release` | build/release |
Each command builds next files inside directory:
- `assistant.meta.js` - meta information for userscript
- `assistant.user.js` - userscript code
- `assistant.js` - code for embedding in another projects (it has functionality for selection of DOM nodes and rules building)
- `build.txt` - bamboo environment variables
Embedded version run as:
```
adguardAssistant().start(null, callback);
```
Callback returns a rule string.
## Usage
### Installation
#### Yarn
```
yarn add @adguard/assistant
```
#### NPM
```
npm install @adguard/assistant
```
### Usage of npm module
```
import { adguardAssistant } from '@adguard/assistant'
adguardAssistant().start(null, callback);
```
## Todo
- write tests