chore: switch to debug module

Author: LucianBuzzo

README.md

@@ -154,7 +154,7 @@ When defining an ability you need to provide the following properties:
 
 ### Debug
 
-To run Yates in debug mode, set the `YATES_DEBUG` environment variable to `true`.
+To run Yates in debug mode, use the environment variable `DEBUG=yates`.
 
 ## Known limitations
 

package-lock.json

@@ -38,6 +38,8 @@
     "uuid": "^9.0.0"
   },
   "dependencies": {
+    "@types/debug": "^4.1.12",
+    "debug": "^4.3.4",
     "lodash": "^4.17.21",
     "node-sql-parser": "^4.12.0",
     "type-fest": "^4.10.3"
@@ -46,4 +48,4 @@
     "@prisma/client": "^5.0.0",
     "prisma": "^5.0.0"
   }
-}
+}

package.json

@@ -1,5 +1,6 @@
 import * as crypto from "crypto";
 import { Prisma, PrismaClient } from "@prisma/client";
+import logger from "debug";
 import difference from "lodash/difference";
 import flatMap from "lodash/flatMap";
 import map from "lodash/map";
@@ -8,13 +9,7 @@ import { Expression, RuntimeDataModel, expressionToSQL } from "./expressions";
 
 const VALID_OPERATIONS = ["SELECT", "UPDATE", "INSERT", "DELETE"] as const;
 
-const DEBUG = process.env.YATES_DEBUG === "1";
-
-const debug = (...args: unknown[]) => {
-	if (DEBUG) {
-		console.log(...args);
-	}
-};
+const debug = logger("yates");
 
 type Operation = (typeof VALID_OPERATIONS)[number];
 export type Models = Prisma.ModelName;