Skip to content

Commit

Permalink
AG-31746 Move scriptlets compatibility tables to AGTree
Browse files Browse the repository at this point in the history
Merge in ADGUARD-FILTERS/tsurlfilter from fix/AG-31746-3 to master

Squashed commit of the following:

commit fc36a07
Merge: ab62884 2a02638
Author: stanislav-atr <s.atroschenko@adguard.com>
Date:   Mon May 13 19:13:36 2024 +0300

    Merge branch 'master' into fix/AG-31746-3

commit ab62884
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Mon May 13 18:33:28 2024 +0300

    packages/agtree/src/compatibility-tables/redirects/README.md edited online with Bitbucket

commit d57a183
Author: stanislav-atr <s.atroschenko@adguard.com>
Date:   Mon May 13 14:22:37 2024 +0300

    remove is_redirect field from scriplets table

commit a96cd12
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Wed May 8 18:48:51 2024 +0300

    update version_added field description in readme for scriptlets and redirects

commit 156dba5
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Wed May 8 18:36:49 2024 +0300

    Revert "draft source data and render script"

    This reverts commit b1b350f.

commit b1b350f
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Tue May 7 21:23:50 2024 +0300

    draft source data and render script

commit 9bf3865
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Tue May 7 19:09:34 2024 +0300

    move the field

commit 8a89c09
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Tue May 7 18:56:50 2024 +0300

    update readme

commit fb816cc
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Tue May 7 18:12:40 2024 +0300

    resolve fixmes, improve misc

commit cfc4772
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Mon May 6 21:10:15 2024 +0300

    add docs field to ubo entries

commit d61618d
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Mon May 6 21:07:01 2024 +0300

    add versions for ubo entries where possible

commit a2e1c2c
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Mon May 6 19:57:04 2024 +0300

    add abp entries where available

commit 1dbcdeb
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Mon May 6 17:48:01 2024 +0300

    add docs field for adg scriptlet entries

commit 212563d
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Fri May 3 18:51:34 2024 +0300

    update ubo scriptlets entries

commit 4b401de
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Thu May 2 17:45:52 2024 +0300

    add is_redirect to scriptlets schema

commit a4d6ea3
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Thu May 2 17:33:24 2024 +0300

    formet and misc improves

commit 2829a40
Author: Stanislav Atroschenko <s.atroschenko@adguard.com>
Date:   Sat Apr 27 22:10:16 2024 +0300

    draft scriptlets compatibility tables
  • Loading branch information
stanislav-atr committed May 13, 2024
1 parent 2a02638 commit ebb9f90
Show file tree
Hide file tree
Showing 89 changed files with 1,647 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ with the following fields:
| `is_blocking` | Whether the redirect is blocking. | `boolean` | `false` |
| `description` | Short description of the actual redirect. If not specified or it's value is `null`, then the description is not available. | `string\|null` | `null` |
| `docs` | Link to the documentation. If not specified or it's value is `null`, then the documentation is not available. | `string\|null` | `null` |
| `version_added` | The version of the adblocker when the redirect was added. | `string\|null` | `null` |
| `version_added` | The version of the adblocker in which the redirect was added. For AdGuard resources, the version of the library is specified. | `string\|null` | `null` |
| `version_removed` | The version of the adblocker when the redirect was removed. | `string\|null` | `null` |
| `deprecated` | Describes whether the redirect is deprecated. | `boolean` | `false` |
| `deprecation_message` | Message that describes why the redirect is deprecated. If not specified or it's value is `null`, then the message is not available. It's value is omitted if the redirect is not marked as deprecated. | `string\|null` | `null` |
Expand Down
38 changes: 20 additions & 18 deletions packages/agtree/src/compatibility-tables/scriptlets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,26 @@ Each file contains an object, where the key is the
and the value is the object with the following fields:

<!-- markdownlint-disable MD013 -->
| Field | Description | Type | Default value |
| --- | --- | --- | --- |
| `name`\* | Name of the actual scriptlet. | `string` | |
| `aliases` | List of aliases for the scriptlet (if any). | `string[]` | `[]` (no aliases) |
| `description` | Short description of the actual scriptlet. If not specified or it's value is `null`, then the description is not available. | `string\|null` | `null` |
| `docs` | Link to the documentation. If not specified or it's value is `null`, then the documentation is not available. | `string\|null` | `null` |
| `version_added` | The version of the adblocker when the scriptlet was added. | `string\|null` | `null` |
| `version_removed` | The version of the adblocker when the scriptlet was removed. | `string\|null` | `null` |
| `debug` | Describes whether the scriptlet is used only for debugging purposes. | `boolean` | `false` |
| `deprecated` | Describes whether the scriptlet is deprecated. | `boolean` | `false` |
| `deprecation_message` | Message that describes why the scriptlet is deprecated. If not specified or it's value is `null`, then the message is not available. It's value is omitted if the scriptlet is not marked as deprecated. | `string\|null` | `null` |
| `parameters` | List of parameters that the scriptlet accepts. **Every** parameter should be listed here, because we check that the scriptlet is used correctly (e.g. that the number of parameters is correct). | `Parameter[]` | `[]` (no parameters) |
| `parameters[].name`\* | Name of the actual parameter. | `string` | |
| `parameters[].required`\* | Describes whether the parameter is required. Empty parameters are not allowed. | `boolean` | |
| `parameters[].description` | Short description of the parameter. If not specified or it's value is `null`, then the description is not available. | `string\|null` | `null` |
| `parameters[].pattern` | Regular expression that matches the value of the parameter. If it's value is `null`, then the parameter value is not checked. | `string\|null` | `null` |
| `parameters[].default` | Default value of the parameter (if any) | `string\|null` | `null` |
| `parameters[].debug` | Describes whether the parameter is used only for debugging purposes. | `boolean` | `false` |

| Field | Description | Type | Default value |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------------------- |
| `name`\* | Name of the actual scriptlet. | `string` | |
| `aliases` | List of aliases for the scriptlet (if any). | `string[]` | `[]` (no aliases) |
| `description` | Short description of the actual scriptlet. If not specified or it's value is `null`, then the description is not available. | `string\|null` | `null` |
| `docs` | Link to the documentation. If not specified or it's value is `null`, then the documentation is not available. | `string\|null` | `null` |
| `version_added` | The version of the adblocker in which the scriptlet was added. For AdGuard resources, the version of the library is specified. | `string\|null` | `null` |
| `version_removed` | The version of the adblocker when the scriptlet was removed. | `string\|null` | `null` |
| `debug` | Describes whether the scriptlet is used only for debugging purposes. | `boolean` | `false` |
| `deprecated` | Describes whether the scriptlet is deprecated. | `boolean` | `false` |
| `deprecation_message` | Message that describes why the scriptlet is deprecated. If not specified or it's value is `null`, then the message is not available. It's value is omitted if the scriptlet is not marked as deprecated. | `string\|null` | `null` |
| `parameters` | List of parameters that the scriptlet accepts. **Every** parameter should be listed here, because we check that the scriptlet is used correctly (e.g. that the number of parameters is correct). | `Parameter[]` | `[]` (no parameters) |
| `parameters[].name`\* | Name of the actual parameter. | `string` | |
| `parameters[].required`\* | Describes whether the parameter is required. Empty parameters are not allowed. | `boolean` | |
| `parameters[].description` | Short description of the parameter. If not specified or it's value is `null`, then the description is not available. | `string\|null` | `null` |
| `parameters[].pattern` | Regular expression that matches the value of the parameter. If it's value is `null`, then the parameter value is not checked. | `string\|null` | `null` |
| `parameters[].default` | Default value of the parameter (if any) | `string\|null` | `null` |
| `parameters[].debug` | Describes whether the parameter is used only for debugging purposes. | `boolean` | `false` |

<!-- markdownlint-enable MD013 -->

\*: The field is required.
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: abort-current-inline-script
version_added: 1.0.4
aliases:
- abort-current-script.js
- ubo-abort-current-script.js
- acs.js
- ubo-acs.js
- ubo-abort-current-script
- ubo-acs
- abort-current-inline-script.js
- ubo-abort-current-inline-script.js
- acis.js
- ubo-acis.js
- ubo-abort-current-inline-script
- ubo-acis
- abp-abort-current-inline-script
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#abort-current-inline-script
parameters:
- name: property
required: true
- name: search
required: false

ubo_any:
name: abort-current-script.js
version_added: 1.37.0
aliases:
- acs.js
- abort-current-inline-script.js
- acis.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#abort-current-scriptjs-
parameters:
- name: property
required: true
- name: search
required: false

abp_any:
name: abort-current-inline-script
version_added: 3.4.3
docs: https://help.adblockplus.org/hc/en-us/articles/1500002338501-Snippet-filters-tutorial#snippets-ref
parameters:
- name: api
required: true
- name: search
required: false
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# AdGuard Content Blocker does not support scriptlets
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: abort-on-property-read
version_added: 1.0.4
aliases:
- abort-on-property-read.js
- ubo-abort-on-property-read.js
Expand All @@ -9,32 +11,26 @@ adg_any_not_cb:
- ubo-abort-on-property-read
- ubo-aopr
- abp-abort-on-property-read
description: Aborts a script when it attempts to read the specified property.
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#abort-on-property-read
parameters:
- name: property
required: true
description: The name of the property to abort on. The property must be attached to window.

ubo_any:
name: aopr
name: abort-on-property-read.js
aliases:
- aopr.js
- abort-on-property-read.js
- abort-on-property-read
description: Aborts a script when it attempts to read the specified property.
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#aoprjs-
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#abort-on-property-readjs-
parameters:
- name: property
required: true
description: The name of the property to abort on. The property must be attached to window.

abp_any:
abp_any:
name: abort-on-property-read
description: Aborts a script when it attempts to read the specified property.
docs: https://help.adblockplus.org/hc/en-us/articles/1500002338501#snippets-ref
version_added: "3.4.1"
version_added: 3.4.1
docs: https://help.adblockplus.org/hc/en-us/articles/1500002338501-Snippet-filters-tutorial#snippets-ref
parameters:
- name: property
required: true
description: The name of the property to abort on. The property must be attached to window.
- name: setConfigurable
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: abort-on-property-write
version_added: 1.0.4
aliases:
- abort-on-property-write.js
- ubo-abort-on-property-write.js
- aopw.js
- ubo-aopw.js
- ubo-abort-on-property-write
- ubo-aopw
- abp-abort-on-property-write
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#abort-on-property-write
parameters:
- name: property
required: true

ubo_any:
name: abort-on-property-write.js
aliases:
- aopw.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#abort-on-property-writejs-
parameters:
- name: property
required: true

abp_any:
name: abort-on-property-write
version_added: 3.4.3
docs: https://help.adblockplus.org/hc/en-us/articles/1500002338501-Snippet-filters-tutorial#snippets-ref
parameters:
- name: property
required: true
- name: setConfigurable
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: abort-on-stack-trace
version_added: 1.5.0
aliases:
- abort-on-stack-trace.js
- ubo-abort-on-stack-trace.js
- aost.js
- ubo-aost.js
- ubo-abort-on-stack-trace
- ubo-aost
- abp-abort-on-stack-trace
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#abort-on-stack-trace
parameters:
- name: property
required: true
- name: stack
required: true

ubo_any:
name: abort-on-stack-trace.js
version_added: 1.29.3rc9
aliases:
- aost.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#abort-on-stack-tracejs-
parameters:
- name: property
required: true
- name: stack
required: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: adjust-setInterval
version_added: 1.0.4
aliases:
- nano-setInterval-booster.js
- ubo-nano-setInterval-booster.js
- nano-sib.js
- ubo-nano-sib.js
- adjust-setInterval.js
- ubo-adjust-setInterval.js
- ubo-nano-setInterval-booster
- ubo-nano-sib
- ubo-adjust-setInterval
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#adjust-setInterval
parameters:
- name: matchCallback
required: false
- name: matchDelay
required: false
- name: boost
required: false

ubo_any:
name: adjust-setInterval.js
aliases:
- nano-setInterval-booster.js
- nano-sib.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#adjust-setIntervaljs-
parameters:
- name: matchCallback
required: false
- name: matchDelay
required: false
- name: boost
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: adjust-setTimeout
version_added: 1.0.4
aliases:
- adjust-setTimeout.js
- ubo-adjust-setTimeout.js
- nano-setTimeout-booster.js
- ubo-nano-setTimeout-booster.js
- nano-stb.js
- ubo-nano-stb.js
- ubo-adjust-setTimeout
- ubo-nano-setTimeout-booster
- ubo-nano-stb
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#adjust-setTimeout
parameters:
- name: matchCallback
required: false
- name: matchDelay
required: false
- name: boost
required: false

ubo_any:
name: adjust-setTimeout.js
aliases:
- nano-setTimeout-booster.js
- nano-stb.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#adjust-setTimeoutjs-
parameters:
- name: matchCallback
required: false
- name: matchDelay
required: false
- name: boost
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: amazon-apstag
version_added: 1.10.25
aliases:
- ubo-amazon_apstag.js
- amazon_apstag.js
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#amazon-apstag
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: call-nothrow
version_added: 1.10.1
aliases:
- call-nothrow.js
- ubo-call-nothrow.js
- ubo-call-nothrow
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#call-nothrow
parameters:
- name: functionName
required: true

ubo_any:
name: call-nothrow.js
version_added: 1.48.1b0
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#call-nothrowjs-
parameters:
- name: functionName
required: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: close-window
version_added: 1.5.0
aliases:
- window-close-if.js
- ubo-window-close-if.js
- ubo-window-close-if
- close-window.js
- ubo-close-window.js
- ubo-close-window
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#close-window
parameters:
- name: path
required: false

ubo_any:
name: close-window.js
version_added: 1.39.3b10
aliases:
- window-close-if.js
docs: https://github.com/gorhill/uBlock/wiki/Resources-Library#close-windowjs-
parameters:
- name: path
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: debug-current-inline-script
version_added: 1.0.4
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#debug-current-inline-script
parameters:
- name: property
required: true
- name: search
required: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: debug-on-property-read
version_added: 1.0.4
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#debug-on-property-read
parameters:
- name: property
required: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: debug-on-property-write
version_added: 1.0.4
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#debug-on-property-write
parameters:
- name: property
required: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# TODO: add scriptlet and param descriptions, documentation references, and versions
# Note: content blocking products do not support scriptlets
adg_any_not_cb:
name: didomi-loader
version_added: 1.10.25
docs: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#didomi-loader

0 comments on commit ebb9f90

Please sign in to comment.