Configure eslint rules

.eslintrc.json

@@ -1,16 +1,25 @@
 {
 	"root": true,
 	"parser": "@typescript-eslint/parser",
-	"plugins": ["@typescript-eslint"],
+	"plugins": ["@typescript-eslint", "jest"],
 	"env": {
-		"node": true
+		"node": true,
+		"jest/globals": true
 	},
 	"extends": [
 		"eslint:recommended",
 		"plugin:@typescript-eslint/recommended",
 		"prettier"
 	],
 	"overrides": [
+		{
+			"files": ["*.js", "*.ts"],
+			"rules": {
+				"@typescript-eslint/no-var-requires": "off",
+				"@typescript-eslint/ban-ts-comment": "off",
+				"@typescript-eslint/no-unused-vars": "off"
+			}
+		},
 		{
 			"files": ["*.md"],
 			"parser": "eslint-plugin-markdownlint/parser",

examples/bug-detectors/command-injection/custom-hooks.js

@@ -16,8 +16,6 @@
  * Examples showcasing the custom hooks API
  */
 
-/* eslint-disable @typescript-eslint/no-var-requires,@typescript-eslint/no-unused-vars */
-
 const { registerReplaceHook } = require("@jazzer.js/hooking");
 const { reportFinding } = require("@jazzer.js/bug-detectors");
 const { guideTowardsEquality } = require("@jazzer.js/fuzzer");
@@ -29,7 +27,7 @@ registerReplaceHook(
 	"execSync",
 	"child_process",
 	false,
-	(thisPtr, params, hookId, origFn) => {
+	(thisPtr, params, hookId) => {
 		if (params === undefined || params.length === 0) {
 			return;
 		}

examples/bug-detectors/command-injection/fuzz.js

@@ -14,10 +14,9 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const { FuzzedDataProvider } = require("@jazzer.js/core");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const root = require("global-modules-path");
+
 module.exports.fuzz = function (data) {
 	const provider = new FuzzedDataProvider(data);
 	const str1 = provider.consumeString(provider.consumeIntegralInRange(1, 20));

examples/bug-detectors/path-traversal/fuzz.js

@@ -14,9 +14,7 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const JSZip = require("jszip");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const path = require("path");
 
 /**
@@ -26,20 +24,17 @@ const path = require("path");
 module.exports.fuzz = function (data) {
 	// Parse the buffer into a JSZip object. The buffer might have been obtained from an http-request.
 	// See https://stuk.github.io/jszip/documentation/howto/read_zip.html for some examples.
-	return (
-		JSZip.loadAsync(data)
-			.then((zip) => {
-				for (const file in zip.files) {
-					// We might want to extract the file from the zip archive and write it to disk.
-					// The loadAsync function should have sanitized the path already.
-					// Here we only construct the absolute path and trigger the path traversal bug.
-					// This issue was fixed in jszip 3.8.0.
-					path.join(__dirname, file);
-				}
-			})
-			// eslint-disable-next-line @typescript-eslint/no-unused-vars
-			.catch(() => {
-				/* ignore broken zip files */
-			})
-	);
+	return JSZip.loadAsync(data)
+		.then((zip) => {
+			for (const file in zip.files) {
+				// We might want to extract the file from the zip archive and write it to disk.
+				// The loadAsync function should have sanitized the path already.
+				// Here we only construct the absolute path and trigger the path traversal bug.
+				// This issue was fixed in jszip 3.8.0.
+				path.join(__dirname, file);
+			}
+		})
+		.catch(() => {
+			/* ignore broken zip files */
+		});
 };

examples/custom-hooks/custom-hooks.js

@@ -1,6 +1,3 @@
-// noinspection JSUnusedLocalSymbols
-/* eslint-disable @typescript-eslint/no-var-requires,@typescript-eslint/no-unused-vars */
-
 /*
  * Copyright 2022 Code Intelligence GmbH
  *
@@ -32,7 +29,7 @@ registerReplaceHook(
 	"JpegImage.jpegImage.constructor.prototype.copyToImageData.copyToImageData",
 	"jpeg-js",
 	false,
-	(thisPtr, params, hookId, origFn) => {
+	(thisPtr, params) => {
 		if (params[0].data[0] === 0) {
 			// we are only interested in image frames in which data[0] equals zero
 			throw Error(
@@ -101,7 +98,7 @@ registerBeforeHook(
 	"JpegImage.jpegImage.constructor.prototype.parse.parse.readDataBlock",
 	"jpeg-js",
 	false,
-	(thisPtr, params, hookId) => {
+	() => {
 		console.log(
 			`[jpeg-js] [before] Called hooked function before calling resetMaxMemoryUsage()`,
 		);
@@ -131,6 +128,7 @@ registerReplaceHook(
 	"JpegImage.jpegImage.constructor.prototype.parse.parse.NonExistingFunc",
 	"jpeg-js",
 	false,
-	// eslint-disable-next-line @typescript-eslint/no-empty-function
-	() => {},
+	() => {
+		/* empty */
+	},
 );

examples/custom-hooks/fuzz.js

@@ -2,7 +2,6 @@
 // https://gitlab.com/gitlab-org/security-products/analyzers/fuzzers/jsfuzz/-/blob/34a694a8c73bfe0895c4e24784ba5b6dfe964b94/examples/jpeg/fuzz.js
 // The original code is available under the Apache License 2.0.
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const jpeg = require("jpeg-js");
 
 /**

examples/jest_integration/integration.fuzz.js

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-undef: 0, no-constant-condition: 0, @typescript-eslint/no-var-requires:0 */
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const target = require("./target.js");
 
 describe("My describe", () => {
@@ -56,7 +53,7 @@ describe("My describe", () => {
 	// finding and shut down the whole process with exit code 70.
 	it.skip.fuzz("Sync timeout", () => {
 		// noinspection InfiniteLoopJS
-		while (true) {
+		for (;;) {
 			// Ignore
 		}
 	});
@@ -74,7 +71,6 @@ describe("My describe", () => {
 	// regression and fuzzing mode. libFuzzer shuts down the process after Jest
 	// received the error and displayed its result.
 	// Two parameters are required to execute the done callback branch.
-	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	it.skip.fuzz("Done callback timeout", (ignore, ignore2) => {
 		// don't call done
 	});

examples/jest_integration/integration.test.js

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-undef: 0 */
-
 describe("My describe", () => {
 	it("My normal Jest test", () => {
 		expect(1).toEqual(1);

examples/jest_integration/worker.fuzz.js

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-undef: 0 */
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const target = require("./target");
 
 const startupTeardownCalls = [];
@@ -59,7 +56,6 @@ describe("Hooks", () => {
 		let test = 0;
 		// Busy wait, do nothing
 		for (let i = 0; i < 1000; i++) {
-			// eslint-disable-next-line @typescript-eslint/no-unused-vars
 			test++;
 		}
 		addCallLog("My describe: afterEach");

examples/jest_integration/workerGoldenReference.test.js

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-undef: 0 */
-
 const startupTeardownCalls = [];
 
 function addCallLog(uniqueId) {
@@ -60,7 +58,6 @@ describe("My describe", () => {
 		let test = 0;
 		// Busy wait, do nothing
 		for (let i = 0; i < 1000; i++) {
-			// eslint-disable-next-line @typescript-eslint/no-unused-vars
 			test++;
 		}
 		addCallLog("My describe: afterEach");

examples/jest_typescript_integration/integration.test.ts

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-undef: 0 */
-
 import * as target from "./target";
 
 describe("My describe", () => {

examples/jpeg/fuzz.js

@@ -2,7 +2,6 @@
 // https://gitlab.com/gitlab-org/security-products/analyzers/fuzzers/jsfuzz/-/blob/34a694a8c73bfe0895c4e24784ba5b6dfe964b94/examples/jpeg/fuzz.js
 // The original code is available under the Apache License 2.0.
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const jpeg = require("jpeg-js");
 
 /**

examples/jpeg_es6/fuzz.js

@@ -2,7 +2,6 @@
 // https://gitlab.com/gitlab-org/security-products/analyzers/fuzzers/jsfuzz/-/blob/34a694a8c73bfe0895c4e24784ba5b6dfe964b94/examples/jpeg/fuzz.js
 // The original code is available under the Apache License 2.0.
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 import { decode } from "jpeg-js";
 
 /**

examples/spectral/spectral-example.js

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const parsers = require("@stoplight/spectral-parsers");
 
 /**

examples/xml/fuzz.js

@@ -2,7 +2,6 @@
 // https://gitlab.com/gitlab-org/security-products/analyzers/fuzzers/jsfuzz/-/blob/34a694a8c73bfe0895c4e24784ba5b6dfe964b94/examples/xml/fuzz.js
 // The original code is available under the Apache License 2.0.
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const xml2js = require("xml2js");
 
 /**

fuzztests/FuzzedDataProvider.fuzz.js

@@ -14,15 +14,13 @@
  * limitations under the License.
  */
 
-/* eslint-disable no-undef, @typescript-eslint/no-var-requires */
-
 const { FuzzedDataProvider, jazzer } = require("@jazzer.js/core");
 
 describe("FuzzedDataProvider", () => {
 	// In this fuzz test we try to guide the fuzzer to use as many functions on
 	// FuzzedDataProvider as possible, before invoking a terminating one
 	// like consumeRemainingXY. Strange combinations of functions could produce a
-	// one off error.
+	// one-off error.
 	it.fuzz(
 		"consumes the provided input",
 		(data) => {

fuzztests/core.fuzz.js

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint-disable no-undef, @typescript-eslint/no-var-requires */
-
 const { ensureFilepath } = require("@jazzer.js/core");
 
 const cwd = process.cwd();

fuzztests/fuzzer.fuzz.js

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint-disable no-undef, @typescript-eslint/no-var-requires */
-
 const { fuzzer } = require("@jazzer.js/fuzzer");
 const { FuzzedDataProvider } = require("@jazzer.js/core");
 

fuzztests/instrument.fuzz.js

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint-disable no-undef, @typescript-eslint/no-var-requires */
-
 const { Instrumentor } = require("@jazzer.js/instrumentor");
 const { FuzzedDataProvider } = require("@jazzer.js/core");
 

fuzztests/runFuzzTests.js

@@ -3,8 +3,6 @@
 // Helper script that searches for Jest fuzz tests in the current directory and
 // executes them in new processes using the found fuzz test names.
 
-/* eslint-disable @typescript-eslint/no-var-requires */
-
 const fs = require("fs/promises");
 const { spawn } = require("child_process");
 

packages/fuzzer/fuzzer.test.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-/* eslint no-empty-function: 0 */
 import { fuzzer } from "./fuzzer";
 
 describe("compare hooks", () => {

packages/hooking/hook.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+/* eslint @typescript-eslint/no-explicit-any: 0 */
+
 export interface TrackedHook {
 	target: string;
 	pkg: string;
@@ -143,7 +145,6 @@ export function logHooks(hooks: Hook[]) {
 
 export const hookTracker = new HookTracker();
 
-/*eslint @typescript-eslint/no-explicit-any: 0 */
 export enum HookType {
 	Before,
 	After,

packages/hooking/manager.test.ts

@@ -1,9 +1,22 @@
+/*
+ * Copyright 2023 Code Intelligence GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { hookManager } from "./manager";
 import { HookType } from "./hook";
 
-/* eslint @typescript-eslint/no-empty-function: 0 */
-/* eslint @typescript-eslint/ban-types: 0 */
-
 describe("Hooks manager", () => {
 	describe("Matching hooks", () => {
 		it("should be valid when having a single REPLACE hook", () => {
@@ -100,18 +113,18 @@ function registerHook(
 ) {
 	switch (hookType) {
 		case HookType.Before:
-			hookManager.registerHook(HookType.Before, target, pkg, isAsync, () => {});
+			hookManager.registerHook(HookType.Before, target, pkg, isAsync, () => {
+				/* empty */
+			});
 			break;
 		case HookType.Replace:
-			hookManager.registerHook(
-				HookType.Replace,
-				target,
-				pkg,
-				isAsync,
-				() => {},
-			);
+			hookManager.registerHook(HookType.Replace, target, pkg, isAsync, () => {
+				/* empty */
+			});
 			break;
 		case HookType.After:
-			hookManager.registerHook(HookType.After, target, pkg, isAsync, () => {});
+			hookManager.registerHook(HookType.After, target, pkg, isAsync, () => {
+				/* empty */
+			});
 	}
 }