@puq/debug 0.0.1 → 0.0.2

package/README.md

@@ -6,7 +6,9 @@
 
 ## Summary
 
-debug
+The library privides 3 functions, `start`, `end`, and `debug`. These function only work when the `process.env.DEBUG_MODE` is `true`.
+
+`start` function is for indicating context of the debug such as `operationName` and the `end` function is for indicating the closing of the context.
 
 ## Install
 
@@ -14,6 +16,8 @@ debug
   pnpm add @puq/debug
 ```
 
+### Useage
+
 ## Funding
 
 Thank you for using `@puq/debug` It's an open-source project, and maintaining it takes time and effort. If you find this library useful, please consider supporting its ongoing development. Your contributions help ensure that the project stays up-to-date, secure, and well-maintained.

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './lib/debug.js';
+export * from './lib/end.js';
 export * from './lib/is-debug-mode.js';
+export * from './lib/start.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,5 +1,7 @@
 // @index(['./**/*.ts', '!./**/*.{spec,test}.ts'], f => `export * from '${f.path}.js'`)
 export * from './lib/debug.js';
+export * from './lib/end.js';
 export * from './lib/is-debug-mode.js';
+export * from './lib/start.js';
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// @index(['./**/*.ts', '!./**/*.{spec,test}.ts'], f => `export * from '${f.path}.js'`)\nexport * from './lib/debug.js';\nexport * from './lib/is-debug-mode.js';\n"],"names":[],"rangeMappings":";;","mappings":"AAAA,uFAAuF;AACvF,cAAc,iBAAiB;AAC/B,cAAc,yBAAyB"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// @index(['./**/*.ts', '!./**/*.{spec,test}.ts'], f => `export * from '${f.path}.js'`)\nexport * from './lib/debug.js';\nexport * from './lib/end.js';\nexport * from './lib/is-debug-mode.js';\nexport * from './lib/start.js';\n"],"names":[],"rangeMappings":";;;;","mappings":"AAAA,uFAAuF;AACvF,cAAc,iBAAiB;AAC/B,cAAc,eAAe;AAC7B,cAAc,yBAAyB;AACvC,cAAc,iBAAiB"}

package/dist/lib/debug.d.ts

@@ -1,2 +1,6 @@
-export declare function debug<T>(record: T): void;
+/**
+ * Print a debug message if DEBUG_MODE is active
+ * @returns
+ */
+export declare function debug(...message: any[]): void;
 //# sourceMappingURL=debug.d.ts.map

package/dist/lib/debug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/lib/debug.ts"],"names":[],"mappings":"AAEA,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC"}
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/lib/debug.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAW7C"}

package/dist/lib/debug.js

@@ -1,15 +1,14 @@
 import { isDebugMode } from './is-debug-mode.js';
 /**
- * Debug console
+ * Print a debug message if DEBUG_MODE is active
  * @returns
  */ export function debug(...message) {
     if (!isDebugMode()) return;
     if (message.every((e)=>{
         return typeof e != 'object';
     })) {
-        console.debug('[ Debug ]', ...message);
+        console.log(...message);
     } else {
-        console.debug('[ Debug ]');
         console.table(message);
     }
 }

package/dist/lib/debug.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/debug.ts"],"sourcesContent":["import { isDebugMode } from './is-debug-mode.js';\n\nexport function debug<T>(record: T): void;\n/**\n * Debug console\n * @returns\n */\nexport function debug(...message: any[]): void {\n  if (!isDebugMode()) return;\n\n  if (\n    message.every((e) => {\n      return typeof e != 'object';\n    })\n  ) {\n    console.debug('[ Debug ]', ...message);\n  } else {\n    console.debug('[ Debug ]');\n\n    console.table(message);\n  }\n}\n"],"names":["isDebugMode","debug","message","every","e","console","table"],"rangeMappings":";;;;;;;;;;;;;;","mappings":"AAAA,SAASA,WAAW,QAAQ,qBAAqB;AAGjD;;;CAGC,GACD,OAAO,SAASC,MAAM,GAAGC,OAAc;IACrC,IAAI,CAACF,eAAe;IAEpB,IACEE,QAAQC,KAAK,CAAC,CAACC;QACb,OAAO,OAAOA,KAAK;IACrB,IACA;QACAC,QAAQJ,KAAK,CAAC,gBAAgBC;IAChC,OAAO;QACLG,QAAQJ,KAAK,CAAC;QAEdI,QAAQC,KAAK,CAACJ;IAChB;AACF"}
+{"version":3,"sources":["../../src/lib/debug.ts"],"sourcesContent":["import { isDebugMode } from './is-debug-mode.js';\n\n/**\n * Print a debug message if DEBUG_MODE is active\n * @returns\n */\nexport function debug(...message: any[]): void {\n  if (!isDebugMode()) return;\n  if (\n    message.every((e) => {\n      return typeof e != 'object';\n    })\n  ) {\n    console.log(...message);\n  } else {\n    console.table(message);\n  }\n}\n"],"names":["isDebugMode","debug","message","every","e","console","log","table"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA,SAASA,WAAW,QAAQ,qBAAqB;AAEjD;;;CAGC,GACD,OAAO,SAASC,MAAM,GAAGC,OAAc;IACrC,IAAI,CAACF,eAAe;IACpB,IACEE,QAAQC,KAAK,CAAC,CAACC;QACb,OAAO,OAAOA,KAAK;IACrB,IACA;QACAC,QAAQC,GAAG,IAAIJ;IACjB,OAAO;QACLG,QAAQE,KAAK,CAACL;IAChB;AACF"}

package/dist/lib/end.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Print a closing indicator for the debugger if DEBUG_MODE is active
+ * @returns
+ */
+export declare function end(): void;
+//# sourceMappingURL=end.d.ts.map

package/dist/lib/end.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"end.d.ts","sourceRoot":"","sources":["../../src/lib/end.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,GAAG,SAKlB"}

package/dist/lib/end.js

@@ -0,0 +1,12 @@
+import { isDebugMode } from './is-debug-mode.js';
+/**
+ * Print a closing indicator for the debugger if DEBUG_MODE is active
+ * @returns
+ */ export function end() {
+    if (!isDebugMode()) return;
+    console.log(`----------------------------End`);
+    console.log('                                ');
+    console.log('                                ');
+}
+
+//# sourceMappingURL=end.js.map

package/dist/lib/end.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/end.ts"],"sourcesContent":["import { isDebugMode } from './is-debug-mode.js';\r\n\r\n/**\r\n * Print a closing indicator for the debugger if DEBUG_MODE is active\r\n * @returns\r\n */\r\nexport function end() {\r\n  if (!isDebugMode()) return;\r\n  console.log(`----------------------------End`);\r\n  console.log('                                ');\r\n  console.log('                                ');\r\n}\r\n"],"names":["isDebugMode","end","console","log"],"rangeMappings":";;;;;;;;;","mappings":"AAAA,SAASA,WAAW,QAAQ,qBAAqB;AAEjD;;;CAGC,GACD,OAAO,SAASC;IACd,IAAI,CAACD,eAAe;IACpBE,QAAQC,GAAG,CAAC,CAAC,+BAA+B,CAAC;IAC7CD,QAAQC,GAAG,CAAC;IACZD,QAAQC,GAAG,CAAC;AACd"}

package/dist/lib/is-debug-mode.d.ts

@@ -1,2 +1,6 @@
+export declare const DEBUG_MODE = "DEBUG_MODE";
 export declare function isDebugMode(): boolean;
+export declare function debugMode(): {
+    DEBUG_MODE: boolean;
+};
 //# sourceMappingURL=is-debug-mode.d.ts.map

package/dist/lib/is-debug-mode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-debug-mode.d.ts","sourceRoot":"","sources":["../../src/lib/is-debug-mode.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,IAAI,OAAO,CAErC"}
+{"version":3,"file":"is-debug-mode.d.ts","sourceRoot":"","sources":["../../src/lib/is-debug-mode.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,eAAe,CAAC;AAEvC,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAED,wBAAgB,SAAS;;EAIxB"}

package/dist/lib/is-debug-mode.js

@@ -1,9 +1,15 @@
+export const DEBUG_MODE = 'DEBUG_MODE';
 export function isDebugMode() {
     return [
         true,
         'true',
         1
-    ].some((e)=>process.env.DEBUG_MODE === e);
+    ].some((e)=>process.env[DEBUG_MODE] === e);
+}
+export function debugMode() {
+    return {
+        [DEBUG_MODE]: true
+    };
 }
 
 //# sourceMappingURL=is-debug-mode.js.map

package/dist/lib/is-debug-mode.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/is-debug-mode.ts"],"sourcesContent":["export function isDebugMode(): boolean {\r\n  return [true, 'true', 1].some((e) => process.env.DEBUG_MODE === e);\r\n}\r\n"],"names":["isDebugMode","some","e","process","env","DEBUG_MODE"],"rangeMappings":";;;;;;","mappings":"AAAA,OAAO,SAASA;IACd,OAAO;QAAC;QAAM;QAAQ;KAAE,CAACC,IAAI,CAAC,CAACC,IAAMC,QAAQC,GAAG,CAACC,UAAU,KAAKH;AAClE"}
+{"version":3,"sources":["../../src/lib/is-debug-mode.ts"],"sourcesContent":["export const DEBUG_MODE = 'DEBUG_MODE';\r\n\r\nexport function isDebugMode(): boolean {\r\n  return [true, 'true', 1].some((e) => process.env[DEBUG_MODE] === e);\r\n}\r\n\r\nexport function debugMode() {\r\n  return {\r\n    [DEBUG_MODE]: true,\r\n  };\r\n}\r\n"],"names":["DEBUG_MODE","isDebugMode","some","e","process","env","debugMode"],"rangeMappings":";;;;;;;;;;;;","mappings":"AAAA,OAAO,MAAMA,aAAa,aAAa;AAEvC,OAAO,SAASC;IACd,OAAO;QAAC;QAAM;QAAQ;KAAE,CAACC,IAAI,CAAC,CAACC,IAAMC,QAAQC,GAAG,CAACL,WAAW,KAAKG;AACnE;AAEA,OAAO,SAASG;IACd,OAAO;QACL,CAACN,WAAW,EAAE;IAChB;AACF"}

package/dist/lib/start.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * Print a opening indicator for the debugger if DEBUG_MODE is active
+ * @param context Debug context
+ */
+export declare function start(context?: string): void;
+//# sourceMappingURL=start.d.ts.map

package/dist/lib/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../src/lib/start.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,OAAO,SAAU,QAGtC"}

package/dist/lib/start.js

@@ -0,0 +1,11 @@
+import { isDebugMode } from './is-debug-mode.js';
+/**
+ *
+ * Print a opening indicator for the debugger if DEBUG_MODE is active
+ * @param context Debug context
+ */ export function start(context = 'Debug') {
+    if (!isDebugMode()) return;
+    console.log(`[ ${context} ] ----------------------------Start`);
+}
+
+//# sourceMappingURL=start.js.map

package/dist/lib/start.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/start.ts"],"sourcesContent":["import { isDebugMode } from './is-debug-mode.js';\r\n\r\n/**\r\n *\r\n * Print a opening indicator for the debugger if DEBUG_MODE is active\r\n * @param context Debug context\r\n */\r\nexport function start(context = 'Debug') {\r\n  if (!isDebugMode()) return;\r\n  console.log(`[ ${context} ] ----------------------------Start`);\r\n}\r\n"],"names":["isDebugMode","start","context","console","log"],"rangeMappings":";;;;;;;;","mappings":"AAAA,SAASA,WAAW,QAAQ,qBAAqB;AAEjD;;;;CAIC,GACD,OAAO,SAASC,MAAMC,UAAU,OAAO;IACrC,IAAI,CAACF,eAAe;IACpBG,QAAQC,GAAG,CAAC,CAAC,EAAE,EAAEF,QAAQ,oCAAoC,CAAC;AAChE"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@puq/debug",
   "license": "MIT",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "publishConfig": {
     "access": "public",
     "tag": "latest"
@@ -80,4 +80,4 @@
   "devDependencies": {
     "@swc/helpers": "~0.5.11"
   }
-}
+}