[REVIEW, DO NOT MERGE] WebScience Migration Review

.circleci/config.yml

@@ -0,0 +1,38 @@
+
+---
+version: 2.1
+
+jobs:
+  Linting:
+    docker:
+      - image: cimg/node:14.13.1
+    steps:
+      - checkout
+      - run:
+          name: Install the dependencies
+          command: npm install
+      - run:
+          name: Build
+          command: npm run build
+      - run:
+          name: Run linting
+          command: npm run lint
+
+  Firefox integration tests:
+    docker:
+      - image: cimg/node:14.13.1
+    steps:
+      - checkout
+      - run:
+          name: Install the dependencies
+          command: npm install && sudo add-apt-repository ppa:ubuntu-mozilla-daily/ppa && sudo apt update && sudo apt install firefox-trunk
+      - run:
+          name: Run Selenium tests
+          command: export PATH=.:$PATH && npm run test-integration
+
+workflows:
+  version: 2
+  ci:
+    jobs:
+      - Linting
+      - Firefox integration tests

.eslintignore

@@ -0,0 +1,3 @@
+dist/*
+WebScience/Utilities/Readability.js
+WebScience/Utilities/content-scripts/Readability.js

.eslintrc.js

@@ -0,0 +1,56 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+    webextensions: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:import/warnings",
+    "plugin:node/recommended",
+  ],
+  overrides: [
+    {
+      files: "tests/**",
+      env: {
+        mocha: true,
+      },
+      extends: [
+        "plugin:mocha/recommended",
+      ],
+    },
+  ],
+  globals: {
+    ChromeUtils: false,
+    ExtensionAPI: false,
+    __ENABLE_DEVELOPER_MODE__: false,
+  },
+  parserOptions: {
+    ecmaVersion: 2021,
+    sourceType: "module",
+  },
+  plugins: [
+    "import",
+    "node",
+    "mocha"
+  ],
+  root: true,
+  rules: {
+    "node/no-deprecated-api": "error",
+    "node/no-extraneous-require": "off",
+    "node/no-missing-import": "off",
+    "node/no-unpublished-import": "off",
+    "node/no-unpublished-require": "off",
+    "node/no-unsupported-features/es-syntax": "off",
+
+    "no-multi-spaces": "error",
+    "no-unused-vars": [ "error", { vars: "all", args: "none", ignoreRestSiblings: false } ],
+    "no-var": "warn",
+    "prefer-const": "warn",
+  },
+};

.gitignore

@@ -6,7 +6,8 @@
 .LSOverride
 
 ## Icon must end with two \r
-Icon
+Icon
+
 
 ## Thumbnails
 ._*
@@ -37,3 +38,10 @@ Temporary Items
 
 # JSDoc
 docs
+
+# Generated study files
+dist
+web-ext-artifacts/
+
+# npm
+node_modules/

.vscode/launch.json

@@ -2,23 +2,32 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "type": "firefox",
+            "name": "Build Study",
+            "type": "node",
             "request": "launch",
-            "reAttach": true,
-            "name": "Launch add-on",
-            "addonPath": "${workspaceFolder}",
-            "log": {
-                "fileName": "${workspaceFolder}/log.txt",
-                "fileLevel": {
-                    "default": "Debug"
-                }
-            }
+            "runtimeArgs": [
+                "run-script",
+                "build"
+            ],
+            "runtimeExecutable": "npm"
+        },
+
+        {
+            "name": "Build Study (Developer Mode)",
+            "type": "node",
+            "request": "launch",
+            "runtimeArgs": [
+                "run-script",
+                "dev"
+            ],
+            "runtimeExecutable": "npm"
         },
+
         // Note: automatic extension reloading is not reliable... after the first reload, the debugger appears
         // to remain connected, but the Visual Studio debug console disconnects and the Firefox debug console
         // shows errors
         {
-            "name": "Launch WebExtension (With Automatic Extension Reloading)",
+            "name": "Launch Study (Automatic Reloading)",
             "type": "firefox",
             // To use the privileged API, you'll need to run a developer version of Firefox.
             //   Set the environment variable FFDEVLOC to the folder containing a dev version,
@@ -50,7 +59,7 @@
         },
         // Note: it's possible to manually reload the extension inside Firefox from about:debugging
         {
-            "name": "Launch WebExtension (Without Automatic Extension Reloading)",
+            "name": "Launch Study",
             "type": "firefox",
             // To use the privileged API, you'll need to run a developer version of Firefox.
             //   Set the environment variable FFDEVLOC to the folder containing a dev version,