Add eslint

Long overdue.

Author: badeball

browserify.ts

@@ -23,7 +23,7 @@ export function transform(
   let buffer = Buffer.alloc(0);
 
   return new Transform({
-    transform(chunk: any, encoding: string, done: TransformCallback) {
+    transform(chunk, encoding, done) {
       buffer = Buffer.concat([buffer, chunk]);
       done();
     },

declarations.d.ts

@@ -1,3 +1 @@
 declare module "@cypress/browserify-preprocessor";
-
-declare module "pngjs";

esbuild.ts

@@ -12,6 +12,7 @@ export function createEsbuildPlugin(
   return {
     name: "feature",
     setup(build) {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
       const fs = require("fs") as typeof import("fs");
 
       build.onLoad({ filter: /\.feature$/ }, async (args) => {

features/step_definitions/cli_steps.ts

@@ -1,9 +1,8 @@
 import util from "util";
-import { Given, When, Then } from "@cucumber/cucumber";
+import { When, Then } from "@cucumber/cucumber";
 import assert from "assert";
 import childProcess from "child_process";
 import stripAnsi from "strip-ansi";
-import { isPost10, isPre10 } from "../support/helpers";
 
 function execAsync(
   command: string

features/step_definitions/file_steps.ts

@@ -1,7 +1,7 @@
 import { Given } from "@cucumber/cucumber";
 import stripIndent from "strip-indent";
 import path from "path";
-import { isPost10, isPre10, writeFile } from "../support/helpers";
+import { isPre10, writeFile } from "../support/helpers";
 
 Given("a file named {string} with:", async function (filePath, fileContent) {
   const absoluteFilePath = path.join(this.tmpDir, filePath);

features/step_definitions/json_steps.ts

@@ -11,11 +11,12 @@ function isObject(object: any): object is object {
   return typeof object === "object" && object != null;
 }
 
+// eslint-disable-next-line @typescript-eslint/ban-types
 function hasOwnProperty<X extends {}, Y extends PropertyKey>(
   obj: X,
   prop: Y
 ): obj is X & Record<Y, unknown> {
-  return obj.hasOwnProperty(prop);
+  return Object.prototype.hasOwnProperty.call(obj, prop);
 }
 
 function* traverseTree(object: any): Generator<object, void, any> {
@@ -133,10 +134,10 @@ Then(
 
     assert.strictEqual(embedding.mime_type, "image/png");
 
-    const png = await new Promise<any>((resolve, reject) => {
+    const png = await new Promise<PNG>((resolve, reject) => {
       new PNG().parse(
-        toByteArray(embedding.data).buffer,
-        function (error: any, data: any) {
+        Buffer.from(toByteArray(embedding.data)),
+        function (error, data) {
           if (error) {
             reject(error);
           } else {
@@ -146,7 +147,7 @@ Then(
       );
     });
 
-    let expectedDimensions;
+    let expectedDimensions: { width: number; height: number };
 
     /**
      * See https://github.com/cypress-io/cypress/pull/15686 and https://github.com/cypress-io/cypress/pull/17309.

features/support/configFileUpdater.ts

@@ -1,3 +1,5 @@
+/* eslint-disable */
+
 import { parse } from "@babel/parser";
 import type { File } from "@babel/types";
 import type { NodePath } from "ast-types/lib/node-path";

features/support/hooks.ts

@@ -1,4 +1,3 @@
-import { version as cypressVersion } from "cypress/package.json";
 import { After, Before, formatterHelpers } from "@cucumber/cucumber";
 import path from "path";
 import assert from "assert";
@@ -138,15 +137,3 @@ After(function () {
     );
   }
 });
-
-function addCucumberPreprocessorPlugin(on: any, config: any) {
-  throw new Error("Function not implemented.");
-}
-
-function createBundler(arg0: { plugins: any[] }): any {
-  throw new Error("Function not implemented.");
-}
-
-function createEsbuildPlugin(config: any) {
-  throw new Error("Function not implemented.");
-}

lib/add-cucumber-preprocessor-plugin.ts

@@ -48,6 +48,7 @@ import { createTimestamp } from "./messages-helpers";
  * Work-around for the fact that some Cypress versions pre v10 were missing this property in their types.
  */
 declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Cypress {
     interface PluginConfigOptions {
       testFiles: string[];
@@ -214,7 +215,7 @@ export async function afterRunHandler(config: Cypress.PluginConfigOptions) {
   }
 }
 
-export async function beforeSpecHandler(config: Cypress.PluginConfigOptions) {
+export async function beforeSpecHandler(_config: Cypress.PluginConfigOptions) {
   currentSpecMessages = [];
 }
 

lib/assertions.ts

@@ -8,7 +8,7 @@ export function fail(message: string) {
   );
 }
 
-export function assert(value: any, message: string): asserts value {
+export function assert(value: unknown, message: string): asserts value {
   if (value) {
     return;
   }
@@ -25,7 +25,7 @@ export function assertAndReturn<T>(
 }
 
 export function assertIsString(
-  value: any,
+  value: unknown,
   message: string
 ): asserts value is string {
   assert(isString(value), message);

lib/create-tests.ts

@@ -51,7 +51,9 @@ import { indent, stripIndent } from "./helpers/strings";
 import { generateSnippet } from "./snippets";
 
 declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace globalThis {
+    // eslint-disable-next-line no-var
     var __cypress_cucumber_preprocessor_dont_use_this: true | undefined;
   }
 }
@@ -459,13 +461,13 @@ function createPickle(
           return cy.wrap(start, { log: false });
         })
           .then((start) => {
-            const ensureChain = (value: any): Cypress.Chainable<any> =>
+            const ensureChain = (value: unknown): Cypress.Chainable<unknown> =>
               Cypress.isCy(value) ? value : cy.wrap(value, { log: false });
 
             try {
               return ensureChain(
                 registry.runStepDefininition(this, text, argument)
-              ).then((result: any) => {
+              ).then((result: unknown) => {
                 return {
                   start,
                   result,
@@ -680,7 +682,7 @@ export default function createTests(
 
     if (
       remainingSteps.length > 0 &&
-      (this.currentTest?.state as any) !== "pending"
+      (this.currentTest?.state as unknown) !== "pending"
     ) {
       const error = assertAndReturn(
         this.currentTest?.err?.message,

lib/data_table.ts

@@ -32,7 +32,7 @@ export default class DataTable {
     }
   }
 
-  hashes(): any[] {
+  hashes(): Record<string, string>[] {
     const copy = this.raw();
     const keys = copy[0];
     const valuesArray = copy.slice(1);
@@ -49,7 +49,7 @@ export default class DataTable {
     return copy;
   }
 
-  rowsHash() {
+  rowsHash(): Record<string, string> {
     return Object.fromEntries(
       this.raw().map<[string, string]>((values) => {
         const [first, second, ...rest] = values;
@@ -65,7 +65,7 @@ export default class DataTable {
     );
   }
 
-  transpose() {
+  transpose(): DataTable {
     const transposed = this.rawTable[0].map((x, i) =>
       this.rawTable.map((y) => y[i])
     );

lib/diagnostics/diagnose.ts

@@ -1,6 +1,5 @@
 import "source-map-support/register";
 import fs from "fs/promises";
-import os from "os";
 import path from "path";
 import util from "util";
 import {
@@ -14,7 +13,6 @@ import {
 } from "@cucumber/cucumber-expressions";
 import { generateMessages } from "@cucumber/gherkin";
 import { IdGenerator, SourceMediaType } from "@cucumber/messages";
-import hook from "node-hook";
 import * as esbuild from "esbuild";
 import { assert, assertAndReturn } from "../assertions";
 import { createAstIdMap } from "../ast-helpers";
@@ -79,10 +77,14 @@ export function compareStepDefinition(
 ) {
   return (
     expressionToString(a.expression) === expressionToString(b.expression) &&
-    comparePosition(a.position!, b.position!)
+    comparePosition(position(a), position(b))
   );
 }
 
+export function position(definition: IStepDefinition<unknown[]>): Position {
+  return assertAndReturn(definition.position, "Expected to find a position");
+}
+
 export async function diagnose(configuration: {
   cypress: ICypressConfiguration;
   preprocessor: IPreprocessorConfiguration;
@@ -155,7 +157,7 @@ export async function diagnose(configuration: {
 
         try {
           require(outputFileName);
-        } catch (e: any) {
+        } catch (e: unknown) {
           console.log(util.inspect(e));
 
           throw new Error(
@@ -169,8 +171,8 @@ export async function diagnose(configuration: {
       /**
        * Delete without regard for errors.
        */
-      await fs.rm(inputFileName).catch(() => {});
-      await fs.rm(outputFileName).catch(() => {});
+      await fs.rm(inputFileName).catch(() => true);
+      await fs.rm(outputFileName).catch(() => true);
     }
 
     const options = {
@@ -253,7 +255,8 @@ export async function diagnose(configuration: {
             result.unmatchedSteps.push({
               step: {
                 source: testFile,
-                line: astNode.location?.line!,
+                line: astNode.location.line,
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 text: step.text!,
               },
               argument,
@@ -279,7 +282,8 @@ export async function diagnose(configuration: {
 
             usage.steps.push({
               source: testFile,
-              line: astNode.location?.line!,
+              line: astNode.location?.line,
+              // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
               text: step.text!,
             });
           } else {
@@ -296,15 +300,17 @@ export async function diagnose(configuration: {
 
               usage.steps.push({
                 source: testFile,
-                line: astNode.location?.line!,
+                line: astNode.location.line,
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 text: step.text!,
               });
             }
 
             result.ambiguousSteps.push({
               step: {
                 source: testFile,
-                line: astNode.location?.line!,
+                line: astNode.location.line,
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 text: step.text!,
               },
               definitions: matchingStepDefinitions,

lib/diagnostics/index.ts

@@ -28,12 +28,6 @@ import {
 import { assertAndReturn } from "../assertions";
 import { generateSnippet } from "../snippets";
 
-const TEMPLATE = `
-Given("[expression]", function ([arguments]) {
-  return "pending";
-});
-`.trim();
-
 export function log(...lines: string[]) {
   console.log(lines.join("\n"));
 }
@@ -66,10 +60,14 @@ export function compareStepDefinition(
 ) {
   return (
     expressionToString(a.expression) === expressionToString(b.expression) &&
-    comparePosition(a.position!, b.position!)
+    comparePosition(position(a), position(b))
   );
 }
 
+export function position(definition: IStepDefinition<unknown[]>): Position {
+  return assertAndReturn(definition.position, "Expected to find a position");
+}
+
 export function groupToMap<T, K>(
   collection: T[],
   getKeyFn: (el: T) => K,
@@ -82,6 +80,7 @@ export function groupToMap<T, K>(
 
     for (const existingKey of map.keys()) {
       if (compareKeyFn(key, existingKey)) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         map.get(existingKey)!.push(el);
         continue el;
       }
@@ -122,6 +121,7 @@ export function createDefinitionsUsage(
   const groups = mapValues(
     groupToMap(
       result.definitionsUsage,
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       (definitionsUsage) => definitionsUsage.definition.position!.source,
       strictCompare
     ),
@@ -143,9 +143,9 @@ export function createDefinitionsUsage(
     .sort((a, b) => a[0].localeCompare(b[0]))
     .flatMap(([, matches]) => {
       return Array.from(matches.entries())
-        .sort((a, b) => a[0].position?.line! - b[0].position?.line!)
+        .sort((a, b) => position(a[0]).line - position(b[0]).line)
         .map<[string, string]>(([stepDefinition, steps]) => {
-          const { expression, position } = stepDefinition;
+          const { expression } = stepDefinition;
 
           const right = [
             inspect(
@@ -159,9 +159,9 @@ export function createDefinitionsUsage(
           ].join("\n");
 
           const left = [
-            ensureIsRelative(projectRoot, position!.source) +
+            ensureIsRelative(projectRoot, position(stepDefinition).source) +
               ":" +
-              position!.line,
+              position(stepDefinition).line,
             ...steps.map((step) => {
               return (
                 ensureIsRelative(projectRoot, step.source) + ":" + step.line
@@ -214,8 +214,8 @@ export function createAmbiguousStep(
             definition.expression instanceof RegularExpression
               ? definition.expression.regexp
               : definition.expression.source
-          )} (${relativeToProjectRoot(definition.position!.source)}:${
-            definition.position!.line
+          )} (${relativeToProjectRoot(position(definition).source)}:${
+            position(definition).line
           })`
       )
       .forEach(append);

lib/environment-helpers.ts

@@ -1,4 +1,4 @@
-export function getTags(env: Record<string, any>): string | null {
+export function getTags(env: Record<string, unknown>): string | null {
   const tags = env.TAGS ?? env.tags;
 
   return tags == null ? null : String(tags);