Merge pull request #9 from the-t-in-rtf/GH-8

GH-8: Migrate to `fluid-lint-all`.  Update all (safe) dependencies (resolves #8).

Author: the-t-in-rtf

.fluidlintallrc.json

@@ -0,0 +1,18 @@
+{
+    "sources": {
+        "md":    [ "./*.md", "./docs/*.md"],
+        "js":    ["./src/**/*.js", "./tests/**/*.js", "./*.js"],
+        "json":  ["src/**/*.json", "tests/**/*.json", "./*.json"],
+        "json5": [],
+        "other": ["./.*", "!./package-lock.json"]
+    },
+    "eslint": {
+        "md": {
+            "options": {
+                "rules": {
+                    "no-redeclare": false
+                }
+            }
+        }
+    }
+}

.github/workflows/main.yml

@@ -31,7 +31,7 @@ jobs:
         run: npm install
 
       - name: Lint Code
-        run: $(npm bin)/grunt lint
+        run: npm run lint
 
       - name: Node Tests
         run: xvfb-run --auto-servernum npm test

Gruntfile.js

@@ -4,8 +4,9 @@
     "description": "A series of Fluid components that help write tests using the WebDriver API.",
     "main": "index.js",
     "scripts": {
-        "pretest": "node node_modules/rimraf/bin.js coverage/*",
-        "test": "node node_modules/istanbul/lib/cli.js cover tests/all-tests.js"
+        "lint": "fluid-lint-all",
+        "pretest": "npx rimraf coverage/*",
+        "test": "istanbul cover tests/all-tests.js"
     },
     "repository": {
         "type": "git",
@@ -16,20 +17,18 @@
     "homepage": "https://github.com/fluid-project/fluid-webdriver#readme",
     "dependencies": {
         "accessibility-developer-tools": "2.12.0",
-        "axe-core": "3.5.5",
-        "brace-expansion": "1.1.11",
-        "infusion": "3.0.0-dev.20200326T173810Z.24ddb2718",
+        "axe-core": "4.1.1",
+        "brace-expansion": "2.0.0",
+        "infusion": "3.0.0-dev.20201113T153152Z.32176dcbe.FLUID-6145",
         "selenium-webdriver": "3.6.0"
     },
     "devDependencies": {
-        "eslint": "7.4.0",
-        "eslint-config-fluid": "1.4.0",
-        "fluid-express": "1.0.16",
-        "fluid-grunt-lint-all": "1.0.8",
-        "grunt": "1.2.1",
+        "eslint": "7.17.0",
+        "eslint-config-fluid": "2.0.0",
+        "fluid-express": "1.0.17",
+        "fluid-lint-all": "1.0.0",
         "istanbul": "0.4.5",
-        "kettle": "1.12.0",
-        "node-jqunit": "1.1.8",
-        "rimraf": "3.0.2"
+        "kettle": "2.0.0",
+        "node-jqunit": "1.1.8"
     }
 }

package.json

@@ -83,7 +83,7 @@ fluid.registerNamespace("fluid.test.webdriver.allBrowsers");
  *
  * Set the `SELENIUM_BROWSER` environment variable to implicitly force the webdriver instance to use the selected browser.
  *
- * @param {String} browser The browser to use.
+ * @param {String} browser - The browser to use.
  *
  */
 fluid.test.webdriver.allBrowsers.setBrowser = function (browser) {

src/tests/allBrowsers.js

@@ -15,11 +15,12 @@ fluid.registerNamespace("fluid.test.webdriver");
  * A function to that calls `elementFn` against DOM element `element` and compares the result to `expectedValue` using
  * `jqUnitFn`.
  *
- * @param {String} message A message describing this test.
- * @param {Object} element The DOM element to inspect.
- * @param {String} elementFn The function name we expected to run against the DOM element.
- * @param {Object} expectedValue The expected return value.
- * @param {String} jqUnitFn The jqUnit function to use for the test.
+ * @param {String} message - A message describing this test.
+ * @param {Object} element - The DOM element to inspect.
+ * @param {String} elementFn - The function name we expected to run against the DOM element.
+ * @param {Object} expectedValue - The expected return value.
+ * @param {String} jqUnitFn - The jqUnit function to use for the test.
+ *
  */
 fluid.test.webdriver.inspectElement = function (message, element, elementFn, expectedValue, jqUnitFn) {
     jqUnitFn = jqUnitFn || "assertEquals";
@@ -32,10 +33,10 @@ fluid.test.webdriver.inspectElement = function (message, element, elementFn, exp
  *
  * Get an element's `value` attribute and compare it to an expected value using a particular jqUnit function.
  *
- * @param {String} message A message describing this test.
- * @param {Object} element The DOM element to inspect.
- * @param {Object} expectedValue The expected value of the element.
- * @param {String} jqUnitFn The jqUnit function to use for the comparison, typically `assertEquals` or `assertDeepEq`.
+ * @param {String} message - A message describing this test.
+ * @param {Object} element - The DOM element to inspect.
+ * @param {Object} expectedValue - The expected value of the element.
+ * @param {String} jqUnitFn - The jqUnit function to use for the comparison, typically `assertEquals` or `assertDeepEq`.
  *
  */
 fluid.test.webdriver.testElementValue = function (message, element, expectedValue, jqUnitFn) {
@@ -49,9 +50,9 @@ fluid.test.webdriver.testElementValue = function (message, element, expectedValu
  *
  * A function to verify whether an element is selected.
  *
- * @param {String} message A message describing this test.
- * @param {Object} element The DOM element to inspect.
- * @param {Boolean} selected True if the element should be selected, false otherwise.
+ * @param {String} message - A message describing this test.
+ * @param {Object} element - The DOM element to inspect.
+ * @param {Boolean} selected - True if the element should be selected, false otherwise.
  *
  */
 fluid.test.webdriver.testElementSelected = function (message, element, selected) {
@@ -64,10 +65,10 @@ fluid.test.webdriver.testElementSelected = function (message, element, selected)
  * A function to compare an array of elements with an array of expected values.  Ideal for use with
  * `{fluid.webdriver}.findElements`, which returns an array of elements.
  *
- * @param {String} message A message describing this test.
- * @param {Array} elements An array of DOM elements.
- * @param {String} elementFn The element function to call for each DOM element.
- * @param {Array} expectedValues An array of expected return values.
+ * @param {String} message - A message describing this test.
+ * @param {Array} elements - An array of DOM elements.
+ * @param {String} elementFn - The element function to call for each DOM element.
+ * @param {Array} expectedValues - An array of expected return values.
  *
  */
 fluid.test.webdriver.inspectElements = function (message, elements, elementFn, expectedValues) {
@@ -86,8 +87,8 @@ fluid.test.webdriver.inspectElements = function (message, elements, elementFn, e
  *
  * Some things, like Capabilities, are Map objects that we would like to be able to inspect as plain old Javascript objects.
  *
- * @param {Map} map A map to be converted.
- * @return {Object} The map in JSON form.
+ * @param {Map} map - A map to be converted.
+ * @return {Object} - The map in JSON form.
  *
  */
 fluid.test.webdriver.mapToObject = function (map) {
@@ -105,6 +106,7 @@ fluid.test.webdriver.mapToObject = function (map) {
  *
  * @param {Array} failures - An array of failure messages returned by an accessibility scanner (see below).
  * @param {Boolean} shouldHaveFailures - Whether the results should contain failures (`false` by default).
+ *
  */
 fluid.test.webdriver.checkAccessibilityScanResults = function (failures, shouldHaveFailures) {
     if (shouldHaveFailures) {
@@ -135,6 +137,7 @@ fluid.test.webdriver.invokeGlobal = function (functionPath, fnArgs, environment)
 
 fluid.registerNamespace("fluid.test.webdriver.axe");
 
+/* eslint-disable jsdoc/check-param-names */
 /**
  *
  * A function to run aXe in a browser and then return the results.  Should be used with `executeAsyncScript`.
@@ -144,6 +147,7 @@ fluid.registerNamespace("fluid.test.webdriver.axe");
  *
  * @param {Function} callback - The WebDriver API itself supplies a callback that we use to return the results of the scan.
  */
+/* eslint-enable jsdoc/check-param-names */
 fluid.test.webdriver.axe.runAxe = function () {
     /* globals axe */
     var callback = arguments[arguments.length - 1];

src/tests/helper-functions.js

@@ -13,7 +13,6 @@ fluid.webdriver.loadTestingSupport();
 
 fluid.registerNamespace("fluid.tests.webdriver.actions.text");
 
-/* globals document */
 fluid.tests.webdriver.actions.text.getRadioButtonValue = function () {
     return document.sampleForm.color.value;
 };

tests/js/actions/browser-actions-click.js

@@ -11,4 +11,4 @@
             <input type="radio" name="color" value="blue" id="blue-button" checked="checked"/>
         </form>
     </body>
-</html>
+</html>

tests/js/actions/html/click.html

@@ -9,4 +9,4 @@
             <input tabindex="0" type="text" id="text-field-3"/>
         </form>
     </body>
-</html>
+</html>

tests/js/actions/html/tabs.html

@@ -7,4 +7,4 @@
             <input type="text" id="text-field"/>
         </form>
     </body>
-</html>
+</html>

tests/js/actions/html/text.html

@@ -6,4 +6,4 @@
 <body>
     <p role="main">This is content.</p>
 </body>
-</html>
+</html>

tests/js/axe/html/bad.html

@@ -9,4 +9,4 @@ <h1>Welcome to the content.</h1>
     <p>This is content.</p>
 </div>
 </body>
-</html>
+</html>

tests/js/axe/html/good.html

@@ -8,4 +8,4 @@ <h1>Welcome to the content.</h1>
     <p>This is content.</p>
 </div>
 </body>
-</html>
+</html>

tests/js/axe/html/injection.html

@@ -6,4 +6,4 @@
 <body>
     <p role="bogus">This is content.</p>
 </body>
-</html>
+</html>

tests/js/axs/html/bad.html

@@ -7,4 +7,4 @@
         <h1>Welcome to the good content.</h1>
         <p>This is content.</p>
     </body>
-</html>
+</html>

tests/js/axs/html/good.html

@@ -5,4 +5,4 @@
 <body>
 <p>This is content.</p>
 </body>
-</html>
+</html>

tests/js/axs/html/injection.html

@@ -3,4 +3,4 @@
         <title>browser navigation tests (page 1)</title>
     </head>
     <body id="first-body">This is the first page.</body>
-</html>
+</html>

tests/js/browser-navigation/html/first.html

@@ -12,4 +12,4 @@
             </div>
         </form>
     </body>
-</html>
+</html>

tests/js/browser-navigation/html/refresh.html

@@ -3,4 +3,4 @@
         <title>browser navigation tests (page 2)</title>
     </head>
     <body id="second-body">This is the second page.</body>
-</html>
+</html>

tests/js/browser-navigation/html/second.html

@@ -5,4 +5,4 @@
     <body>
         <p>This page will have script content injected into it, run the code, and then return the result to the node side.</p>
     </body>
-</html>
+</html>

tests/js/executeScript/html/executeScript.html

@@ -15,4 +15,4 @@
 
         <a href="#">Complete Link Text</a>
     </body>
-</html>
+</html>

tests/js/findElement/html/index.html

@@ -8,4 +8,4 @@
     <p>This is content.</p>
     <script src="../js/fluid-test-fixtures.js"></script>
 </body>
-</html>
+</html>

tests/js/fluid/html/index.html

@@ -1,5 +1,4 @@
 /* eslint no-undef: 0 */
-/* globals fluid */
 (function () {
     "use strict";
     fluid.registerNamespace("fluid.tests.webdriver.fluid");

tests/js/fluid/js/fluid-test-fixtures.js

@@ -5,4 +5,4 @@
     <body>
         <p>Hello, World.</p>
     </body>
-</html>
+</html>

tests/js/get/html/index.html

@@ -10,4 +10,4 @@
         A polygon shaped like a stylized "X".
     </svg>
 </body>
-</html>
+</html>