Custom scriptlet support

Author: ShivanKaul

Cargo.lock

@@ -13,3 +13,5 @@ anyhow = "1"
 fs2 = "0.4"
 tempfile = "3"
 ctrlc = "3"
+rusty-leveldb = "4"
+base64 = "0.22"

Cargo.toml

@@ -101,6 +101,19 @@ brave-shields-cli filters bisect rules.txt
 
 The `bisect` command performs an interactive binary search to find which filter rule in a file is causing a site issue. It loads all rules, then iteratively exceptions out half the candidates with `@@` prefixes, asking at each step whether the issue persists. A working file (`bisect-filters.txt`) and state file (`bisect-state.json`) are written to the current directory. Original filters are restored when bisect completes. If interrupted or quit mid-session, the state is preserved and can be resumed with `--resume bisect-state.json`.
 
+#### scriptlets
+
+Manage custom scriptlets (user-defined JavaScript for adblock injection). These are stored in a LevelDB database at `Default/AdBlock Custom Resources/` and are shared across profiles.
+
+```bash
+brave-shields-cli scriptlets list
+brave-shields-cli scriptlets get user-my-script.js
+brave-shields-cli scriptlets add user-my-script.js script.js
+brave-shields-cli scriptlets remove user-my-script.js
+```
+
+Scriptlet names must start with `user-` and end with `.js`. Once added, reference them in custom filters with `example.com##+js(user-my-script.js)`.
+
 #### profiles
 
 List available browser profiles.

README.md

@@ -240,12 +240,12 @@ fn make_exception(rule: &str) -> String {
     if rule.starts_with("@@") || rule.starts_with("#@#") {
         return rule.to_string();
     }
-    // Cosmetic filter: contains ## (but not scriptlet ###+js)
+    // Cosmetic or scriptlet filter: contains ##
+    // Both cosmetic (##.ad) and scriptlet (##+js(...)) use #@# for exceptions.
+    // The @@ prefix is only for network rules.
     if let Some(pos) = rule.find("##") {
-        if !rule[pos..].starts_with("###+") {
-            let (domain, selector) = rule.split_at(pos);
-            return format!("{}#@#{}", domain, &selector[2..]);
-        }
+        let (domain, selector) = rule.split_at(pos);
+        return format!("{}#@#{}", domain, &selector[2..]);
     }
     format!("@@{}", rule)
 }
@@ -682,10 +682,20 @@ mod tests {
 
     #[test]
     fn test_make_exception_scriptlet() {
-        // Scriptlet injection: ###+js(...) should get @@ prefix, not #@#
+        // Scriptlet injection uses ##+js(...) syntax (two hashes, not three).
+        // Exception replaces ## with #@#.
+        assert_eq!(
+            make_exception("example.com##+js(abort-on-property-read, foo)"),
+            "example.com#@#+js(abort-on-property-read, foo)"
+        );
+    }
+
+    #[test]
+    fn test_make_exception_scriptlet_no_domain() {
+        // Global scriptlet: ##+js(...) with no domain
         assert_eq!(
-            make_exception("example.com###+js(abort-on-property-read, foo)"),
-            "@@example.com###+js(abort-on-property-read, foo)"
+            make_exception("##+js(abort-on-property-read, foo)"),
+            "#@#+js(abort-on-property-read, foo)"
         );
     }
 

src/commands/bisect.rs

@@ -1,5 +1,6 @@
 pub mod bisect;
 pub mod filters;
+pub mod scriptlets;
 pub mod get;
 pub mod list;
 pub mod profiles;