fix: dev lint errors due to eslint@v8 in project

example/README.md

@@ -1,13 +1,46 @@
 # Example Package
 
 This folder is a barebones webpage that has TestCafe journey tests for
-validation. This package represents the ESLint configuration
-[.eslintrc.json](./.eslintrc.json) needed to import the
-`eslint-plugin-testcafe-community` plugin and evaluate a file.
+validation. An example configuration for importing the
+`eslint-plugin-testcafe-community` plugin is provided below.
 
-The journey test is expected to have at least one example of all invalid
-configurations to exemplify how the `testcafe-community` plugin will identify
-the poor programming patterns in TestCafe test suites.
+```js
+// .eslintrc.js
+module.exports = {
+    root: true,
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: ["eslint:recommended"],
+    overrides: [
+        {
+            // for Typescript projects
+            files: ["*.ts"],
+            parser: "@typescript-eslint/parser",
+            parserOptions: {
+                ecmaVersion: 12,
+                sourceType: "module",
+                project: "tsconfig.eslint.json"
+            },
+            extends: "plugin:@typescript-eslint/recommended",
+            plugins: ["@typescript-eslint"]
+        },
+        {
+            files: ["*.test.{ts,js}"],
+            extends: ["plugin:testcafe-community/recommended"],
+            plugins: ["testcafe-community"]
+        }
+    ],
+    rules: {}
+};
+```
+
+The journey test [`example.test.ts`](./example.test.ts) is expected to have at
+least one example of all invalid configurations according to the
+`testcafe-community` ruleset. This is designed to exemplify how the
+`testcafe-community` plugin will identify the poor programming patterns in
+TestCafe test suites.
 
 ## Integration
 

tests/example.serial-test.ts

@@ -195,8 +195,8 @@ describe("testcafe-community", () => {
                         fixableErrorCount: 0,
                         fixableWarningCount: 0,
                         usedDeprecatedRules: []
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
     });
@@ -232,8 +232,8 @@ describe("testcafe-community", () => {
                         fixableErrorCount: 0,
                         fixableWarningCount: 0,
                         usedDeprecatedRules: []
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -258,8 +258,8 @@ describe("testcafe-community", () => {
                                 endColumn: 3
                             }) as Linter.LintMessage
                         ]) as Linter.LintMessage[]
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -283,8 +283,8 @@ describe("testcafe-community", () => {
                                 endColumn: 12
                             }) as Linter.LintMessage
                         ]) as Linter.LintMessage[]
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -323,8 +323,8 @@ describe("testcafe-community", () => {
                                 endColumn: 48
                             }) as Linter.LintMessage
                         ]) as Linter.LintMessage[]
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -348,8 +348,8 @@ describe("testcafe-community", () => {
                                 endColumn: 10
                             }) as Linter.LintMessage
                         ]) as Linter.LintMessage[]
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -373,8 +373,8 @@ describe("testcafe-community", () => {
                                 endColumn: 10
                             }) as Linter.LintMessage
                         ]) as Linter.LintMessage[]
-                    })
-                ])
+                    }) as ESLint.LintResult
+                ]) as ESLint.LintResult[]
             );
         });
 
@@ -410,8 +410,8 @@ describe("testcafe-community", () => {
                             warningCount: 1,
                             fixableErrorCount: 0,
                             fixableWarningCount: 0
-                        })
-                    ])
+                        }) as ESLint.LintResult
+                    ]) as ESLint.LintResult[]
                 );
             });
         });