Run ESLint on scripts (#984)

- Add a package.json
- Change replacements to be valid JS which makes lint run fine
- Add automation test (hopefully)

.eslintignore

@@ -0,0 +1 @@
+submodules/

.eslintrc

@@ -0,0 +1,25 @@
+{
+    "env": {
+        "browser": true,
+        "es2017": true
+    },
+    "extends": [
+        "standard"
+    ],
+    "globals": {
+        "__firefox__": "readonly",
+        "SECURITY_TOKEN": "readonly",
+        "$FEATURE_SETTINGS$": "readonly",
+        "$GPC_ENABLED$": "readonly",
+        "$BLOCKING_ENABLED$": "readonly",
+        "$TRACKER_DATA$": "readonly",
+        "$IS_DEBUG$": "readonly",
+        "webkit": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 7
+    },
+    "rules": {
+        "indent": ["error", 4]
+    }
+}

.gitignore

@@ -6,6 +6,7 @@
 build/
 DerivedData/
 Carthage/Checkouts
+node_modules/
 
 ## Various settings
 *.pbxuser

Core/ContentBlockerRulesUserScript.swift

@@ -76,8 +76,8 @@ public class ContentBlockerRulesUserScript: NSObject, UserScript {
             + (privacyConfiguration.exceptionsList(forFeature: .contentBlocking).joined(separator: "\n"))
 
         return Self.loadJS("contentblockerrules", from: Bundle.core, withReplacements: [
-            "${tempUnprotectedDomains}": remoteUnprotectedDomains,
-            "${userUnprotectedDomains}": privacyConfiguration.userUnprotectedDomains.joined(separator: "\n")
+            "$TEMP_UNPROTECTED_DOMAINS$": remoteUnprotectedDomains,
+            "$USER_UNPROTECTED_DOMAINS$": privacyConfiguration.userUnprotectedDomains.joined(separator: "\n")
         ])
     }
 

Core/DoNotSellUserScript.swift

@@ -24,7 +24,7 @@ import BrowserServicesKit
 public class DoNotSellUserScript: NSObject, UserScript {
     public var source: String {
         return Self.loadJS("donotsell", from: Bundle.core, withReplacements: [
-            "${gpcEnabled}": PrivacyConfigurationManager.shared.privacyConfig
+            "$GPC_ENABLED$": PrivacyConfigurationManager.shared.privacyConfig
                 .isEnabled(featureKey: .gpc) ? "true" : "false"
         ])
     }

Core/FingerprintUserScript.swift

@@ -43,10 +43,10 @@ public class FingerprintUserScript: NSObject, UserScript {
             .exceptionsList(forFeature: .fingerprintingScreenSize).joined(separator: "\n")
 
         return Self.loadJS("fingerprint", from: Bundle.core, withReplacements: [
-            "${featureSettings}": featureSettings,
-            "${tempStorageExceptions}": tempStorageExceptions,
-            "${batteryExceptions}": batteryExceptions,
-            "${screenSizeExceptions}": screenSizeExceptions
+            "$FEATURE_SETTINGS$": featureSettings,
+            "$TEMP_STORAGE_EXCEPTIONS$": tempStorageExceptions,
+            "$BATTERY_EXCEPTIONS$": batteryExceptions,
+            "$SCREEN_SIZE_EXCEPTIONS$": screenSizeExceptions
         ])
     }
 

Core/LoginFormDetectionUserScript.swift

@@ -30,7 +30,7 @@ public class LoginFormDetectionUserScript: NSObject, UserScript {
 
     public lazy var source: String = {
         return Self.loadJS("login-form-detection", from: Bundle.core, withReplacements: [
-            "${isDebug}": isDebugBuild ? "true" : "false"
+            "$IS_DEBUG$": isDebugBuild ? "true" : "false"
         ])
     }()
 

Core/SurrogatesUserScript.swift

@@ -104,12 +104,12 @@ public class SurrogatesUserScript: NSObject, UserScript {
         }
 
         return Self.loadJS("contentblocker", from: Bundle.core, withReplacements: [
-            "${isDebug}": isDebugBuild ? "true" : "false",
-            "${tempUnprotectedDomains}": remoteUnprotectedDomains,
-            "${userUnprotectedDomains}": privacyConfiguration.userUnprotectedDomains.joined(separator: "\n"),
-            "${trackerData}": trackerData,
-            "${surrogates}": configurationSource.surrogates,
-            "${blockingEnabled}": privacyConfiguration.isEnabled(featureKey: .contentBlocking) ? "true" : "false"
+            "$IS_DEBUG$": isDebugBuild ? "true" : "false",
+            "$TEMP_UNPROTECTED_DOMAINS$": remoteUnprotectedDomains,
+            "$USER_UNPROTECTED_DOMAINS$": privacyConfiguration.userUnprotectedDomains.joined(separator: "\n"),
+            "$TRACKER_DATA$": trackerData,
+            "$SURROGATES$": configurationSource.surrogates,
+            "$BLOCKING_ENABLED$": privacyConfiguration.isEnabled(featureKey: .contentBlocking) ? "true" : "false"
         ])
     }