Merge pull request #44 from AikidoSec/patch-comments

Remove some comments

Makefile

@@ -30,10 +30,6 @@ lambda-mongodb-nosql-injection:
 lambda-mongodb-safe:
 	cd sample-apps/lambda-mongodb && npx serverless invoke local --function login --path payloads/safe-request.json
 
-.PHONY: docs
-docs:
-	npx typedoc
-
 .PHONY: install
 install:
 	npm install --workspaces

benchmarks/sql-injection/benchmark.js

@@ -1,6 +1,5 @@
 /**
  * Runs benchmarks for the detection of SQL Injections
- * @module
  */
 const fs = require("fs");
 const path = require("path");
@@ -23,6 +22,7 @@ function main() {
     );
   }
 }
+
 main();
 
 function runBenchmark(sql, input) {
@@ -55,19 +55,31 @@ function getAvgBenchmark() {
  */
 function fetchSqlStatements() {
   const auth_bypass_txt = fs.readFileSync(
-    path.join(__dirname, "./../../library/testing/sql-injection-payloads/Auth_Bypass.txt"),
+    path.join(
+      __dirname,
+      "./../../library/testing/sql-injection-payloads/Auth_Bypass.txt"
+    ),
     "utf-8"
   );
   const postgres_txt = fs.readFileSync(
-    path.join(__dirname, "./../../library/testing/sql-injection-payloads/postgres.txt"),
+    path.join(
+      __dirname,
+      "./../../library/testing/sql-injection-payloads/postgres.txt"
+    ),
     "utf-8"
   );
   const mysql_txt = fs.readFileSync(
-    path.join(__dirname, "./../../library/testing/sql-injection-payloads/mysql.txt"),
+    path.join(
+      __dirname,
+      "./../../library/testing/sql-injection-payloads/mysql.txt"
+    ),
     "utf-8"
   );
   const mssql_and_db2_txt = fs.readFileSync(
-    path.join(__dirname, "./../../library/testing/sql-injection-payloads/mssql_and_db2.txt"),
+    path.join(
+      __dirname,
+      "./../../library/testing/sql-injection-payloads/mssql_and_db2.txt"
+    ),
     "utf-8"
   );
 

library/src/agent/AgentSingleton.ts

@@ -1,8 +1,3 @@
-/**
- * This module contains a variable instance, and methods to get and set the current agent
- * @module agent/AgentSingleton
- */
-
 import { Agent } from "./Agent";
 
 let instance: Agent | undefined = undefined;

library/src/agent/Logger.ts

@@ -1,9 +1,3 @@
-/**
- * Exports 2 classes related to logging
- * + Type definition Logger
- * @module agent/Logger
- */
-
 export interface Logger {
   log(message: string): void;
 }

library/src/agent/Source.ts

@@ -1,8 +1,3 @@
-/**
- * Exports type def Source but mainly the function {@link friendlyName}
- * @module agent/Source
- */
-
 export type Source = "query" | "body" | "headers" | "cookies";
 
 /**

library/src/agent/Wrapper.ts

@@ -1,8 +1,3 @@
-/**
- * Type definitions
- * @module agent/Wrapper
- */
-
 export interface Wrapper {
   wrap(): void;
 }

library/src/helpers/getOptions.ts

@@ -1,8 +1,3 @@
-/**
- * This module contains the default options and the function {@link getOptions}
- * @module helpers/getOptions
- */
-
 /**
  * It gets the options for an Agent
  * @param partialOptions Your own values which will overwrite the default options

library/src/helpers/getPackageVersion.ts

@@ -1,8 +1,3 @@
-/**
- * The getPackageVersion module exports only one function : {@link getPackageVersion}
- * @module helpers/getPackageVersion
- */
-
 /**
  * Get the installed version of a package
  * @param pkg A package name

library/src/helpers/isPlainObject.ts

@@ -1,6 +1,5 @@
 /**
  * Grabbed from https://github.com/jonschlinkert/is-plain-object
- * @module helpers/isPlainObject
  */
 
 function isObject(o: unknown) {

library/src/helpers/satisfiesVersion.ts

@@ -1,8 +1,3 @@
-/**
- * The satisfiesVersion module exports only one function with the same name : satisfiesVersion
- * @module helpers/satisfiesVersion
- */
-
 /**
  * This function checks if a certain version satisfies a version range.
  * @param range A range of versions written in semver

library/src/helpers/tryDecodeAsJWT.ts

@@ -1,8 +1,3 @@
-/**
- * The JWT module only exports one function : tryDecodeAsJWT
- * @module helpers/JWT
- */
-
 /**
  * This function tries to decode your input as if it is a JSON Web Token, if it fails to do so it returns {jwt: false}.
  * @param jwt A (possible) JWT

package.json

@@ -1,7 +1,6 @@
 {
   "devDependencies": {
-    "prettier": "^3.2.4",
-    "typedoc": "^0.25.8"
+    "prettier": "^3.2.4"
   },
   "workspaces": [
     "sample-apps/*",